はじめに

​
新しいワークスペースを作る

別のブランドや新しい検証対象を、同じアカウントで始めます。サインイン済みで、所属組織のワークスペースを作成できる権限が必要です。既存のワークスペースを選ぶ場合はディレクトリとの関連付けを使います。

​
1. ワークスペースを作成する

以下はJSONからIDを受け取るためにjqを使います。名前は実際の対象に置き換えます。同じ作成リクエストを再送するときは、同じ冪等キーを使います。

CREATE_WORKSPACE_KEY=$(uuidgen)
orc workspaces create \
  --name 'YOUR_WORKSPACE_NAME' \
  --idempotency-key "$CREATE_WORKSPACE_KEY" \
  --json > workspace.json
WORKSPACE_ID=$(jq -er '.data.id' workspace.json)

この手順では空のワークスペースを作ります。新規登録、別の招待、ブランドの手動作成を繰り返す必要はありません。ブランドや観測候補は次の初回設定で生成します。

​
提案用ワークスペースで計測前に止める

ネイティブCLI 0.6.2以降では、--setup-mode で作成後に進む段階を選べます。0.6.1以前で unknown option が出る場合は更新してください。

orc update
orc --version
orc workspaces create --help

ヘルプに --setup-mode が表示されることを確認します。作成せずに引数を確認する場合は、サインイン後に次を実行します。

orc workspaces create --name '検証用' --purpose pitch \
  --setup-mode empty --dry-run --json
値実行する内容
empty空のワークスペースを作成。候補生成・計測は開始しません。
suggestionsブランド・プロンプトなどの設定候補を生成して停止。計測は開始しません。
measure設定候補を生成し、初回計測まで進めます。
orc workspaces create --name '検証用' --purpose pitch --setup-mode empty \
  --idempotency-key "$(uuidgen)" --json

orc workspaces create --name '候補を確認する検証用' --purpose pitch \
  --brand '{"name":"Example","domain":"example.com"}' \
  --setup-mode suggestions --idempotency-key "$(uuidgen)" --json

空で作った場合は、後から orc observations create --workspace WORKSPACE_ID --website https://example.com --region JP --language ja --wait --json で候補を生成できます。候補を確認・編集した後の計測開始は、初回観測の手順に従います。

指定を省略すると既存の動作を維持します。purpose や brand を指定した作成は初回計測まで進み、名前だけの作成は空の状態で停止します。提案用の作成枠はどのモードでも消費し、7日間の期限は作成時点から始まります。既存のワークスペースや実行中の計測は変更しません。

​
2. 作成したIDを選択して読み戻す

orc workspace use "$WORKSPACE_ID"
orc workspaces get "$WORKSPACE_ID" --workspace "$WORKSPACE_ID" --json
orc workspaces setup get --workspace "$WORKSPACE_ID" --json

作成結果と同じIDで取得でき、初回設定の状態を読めることを確認します。以後の手順にもこのIDを渡します。workspace useはユーザーの既定値を変更します。複数の対象を同時に扱うエージェントは、各コマンドの--workspaceを使います。

​
3. 初回観測へ進む

初回観測を実行して結果を読むで、サイトURLから設定候補を生成し、確認した内容を確定します。確定時に初回観測が始まります。ワークスペース作成の成功だけでは観測完了になりません。

アカウントの招待資格と、ワークスペースの観測利用枠は別に確認されます。measurement_quota_exhaustedで止まる場合は、対象IDとエラーを担当者へ伝えます。新規登録やワークスペースの作り直しで回避しません。

初回観測 · workspacesリファレンス · セットアップの失敗箇所