観測対象

​
brands

orc brands は、Workspaceの自社・競合ブランドと、そのプロフィールを管理するコマンドです。一覧と詳細を取得し、ブランド名、ドメイン、別名、提供サービス、オーディエンス、表示アイデンティティを登録・更新できます。生成されたブランド提案は、確認してから採用または却下します。

先にCLIの認証を設定し、--workspace で対象を指定してください。自社ブランドは --relation owned で取得します。返されたブランドIDを get と update に使い、Workspace IDと混同しないでください。ブランドのドメイン一覧は、所有権検証や取り込み用の orc domains リソースとは別に管理されます。

​
使い方

terminal
orc brands list --relation owned --workspace <workspace-id>

自社ブランドのIDとプロフィールを確認します。

​
プロフィールの項目

画面の項目入力フィールド
説明・業界notes・industry
ブランドアイデンティティtags
プロダクトとサービスofferings・products_and_services
オーディエンス配分audience
ブランド名・表示名name・display_name
ドメイン・別名domain・domains・aliases
表示色・アイコンcolor_token・color_hex・identity_kind・icon_token・emoji・image_file_id

products_and_services は名前を必須とする構造化した一覧で、同時に送った offerings より優先されます。offerings の名前だけを変更する場合は、同名の既存詳細を保持します。どちらも最大100件です。

audience は id、label、description、percentage、enabled を持つ最大20件の配列です。既存の対象者IDを保持して編集します。割合は各項目0〜100です。意味のある配分にするため有効項目を合計100%に整えてください。ただしAPIは合計を検証しません。

domains は正規化後の重複を許可せず、先頭値を domain にします。CSVで表せないカンマを含む値は標準入力のJSON配列で渡します。表示色は color_token が color_hex より優先されます。profile_suggestion_decisions は提案keyに accepted または rejected を対応させるmapです。

具体的な編集手順はブランド情報を整えるを参照してください。

​
サブコマンド

​
list

ブランドを一覧します。--relation は owned、direct_competitor、indirect_competitor、ignored で絞り込みます。省略時は自社と直接競合が対象です。ページを続ける場合は同じ条件で返されたcursorを使用します。

terminal
orc brands list [options]

​
固有のオプション

​
--relation

Filter by relation. When omitted, owned and direct_competitor are returned by default.; enum: owned|direct_competitor|indirect_competitor|ignored

型: string。任意。

terminal
orc brands list --relation <value>

​
create

name と domain を指定してブランドを作成します。relation の既定値は direct_competitor、status は active です。domains を指定した場合は先頭が主ドメインになります。この登録は検証・取り込み用Domainリソースを作成しません。

terminal
orc brands create [options]

​
固有のオプション

​
--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc brands create --idempotency-key <value>
​
--name

(required) Human-readable brand name.; max 255 chars

型: string。任意。

terminal
orc brands create --name <value>
​
--domain

(required) Primary normalized domain in the brand registry. This field does not create a verification or ingestion Domain resource. Used when domains is omitted; otherwise the first domains entry takes precedence.; max 255 chars

型: string。任意。

terminal
orc brands create --domain <value>
​
--relation

Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored

型: string。任意。

terminal
orc brands create --relation <value>
​
--tags

Labels attached to the brand. Strings are trimmed and empty strings are removed. Defaults to an empty array.; csv

型: string。任意。

terminal
orc brands create --tags <value>
​
--logo-url

Logo URL or file reference; null when none is stored.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --logo-url <value>
​
--display-name

Display name distinct from the stored brand name; null when unset.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --display-name <value>
​
--industry

Industry label stored on the brand; null when unset.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --industry <value>
​
--status

Lifecycle status. Defaults to active; disabled preserves history and stops future execution.; enum: active|disabled

型: string。任意。

terminal
orc brands create --status <value>
​
--domains

Full brand domain registry. Values are trimmed, lowercased and stripped of an HTTP(S) scheme, leading www. and trailing slash. The first value becomes domain. Duplicate normalized values are rejected. When omitted, the registry contains domain only.; csv

型: string。任意。

terminal
orc brands create --domains <value>
​
--aliases

Alternate brand names used for matching. Strings are trimmed and empty strings are removed. Defaults to an empty array.; csv

型: string。任意。

terminal
orc brands create --aliases <value>
​
--color-hex

Six-digit hexadecimal display color. color_token takes precedence when both are supplied.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --color-hex <value>
​
--color-token

Named display color. Writing this field also sets its corresponding color_hex. Defaults to default when neither color field is supplied.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: string。任意。

terminal
orc brands create --color-token <value>
​
--identity-kind

Presentation style for the brand identity. Defaults to initial unless an image file selects image mode.; enum: color|initial|icon|emoji|image

型: string。任意。

terminal
orc brands create --identity-kind <value>
​
--icon-token

Icon reference used for an icon identity; null when unset.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --icon-token <value>
​
--emoji

Emoji used for an emoji identity; null when unset.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --emoji <value>
​
--image-file-id

File reference used for an image identity. Writing this field also sets logo_url; null clears both and switches identity_kind to initial.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --image-file-id <value>
​
--notes

Free-form brand profile notes; null when unset.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --notes <value>
​
--regex-pattern

Stored regular expression for advanced brand matching; null when unset.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands create --regex-pattern <value>
​
--products-and-services

Full replacement product and service list, with a required name per entry. Also replaces offerings with those names and takes precedence over offerings in the same request. An empty array clears the list. Defaults to an empty array when neither product list nor offerings is supplied.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc brands create --products-and-services <value>
​
--offerings

Product and service names. Name-only edits retain stored details for matching names; products_and_services takes precedence when supplied. Defaults to an empty array.; csv

型: string。任意。

terminal
orc brands create --offerings <value>
​
--audience

Audience segment list, up to 20 entries. Each percentage must be 0 to 100; this endpoint does not validate their sum. Defaults to an empty array when omitted.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc brands create --audience <value>
​
--profile-suggestion-decisions

Map from generated profile suggestion keys to accepted or rejected decisions. Defaults to an empty object.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc brands create --profile-suggestion-decisions <value>

​
使用例

terminal
orc brands create --name "Acme" --domain acme.example --relation owned --workspace <workspace-id>

自社ブランドを作成する

​
suggestions list

保存されたブランド提案を一覧します。--status で pending、accepted、rejected に絞れます。この読み取りだけでは提案を生成しません。

terminal
orc brands suggestions list [options]

​
固有のオプション

​
--status

Filter by suggestion status. Omit to include all statuses.; enum: pending|accepted|rejected

型: string。任意。

terminal
orc brands suggestions list --status <value>

​
suggestions refresh

ブランド提案の非同期生成を開始します。--wait は生成の完了を待ち、--timeout と --poll-interval で待機を調整します。生成と提案の採用は別操作です。

terminal
orc brands suggestions refresh [options]

​
固有のオプション

​
--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc brands suggestions refresh --idempotency-key <value>

​
suggestions generations get

生成開始時に返されたIDで、非同期生成の状態を取得します。ブランドIDや提案IDを指定する操作ではありません。

terminal
orc brands suggestions generations get <id> [options]

​
suggestions accept

未解決の提案IDを指定して採用します。--edit-name で名前を調整し、--relation でブランドとの関係を指定できます。

terminal
orc brands suggestions accept <id> [options]

​
固有のオプション

​
--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc brands suggestions accept <id> --idempotency-key <value>
​
--edit-name

Name for the created resource. When omitted, uses the suggestion name.; max 255 chars

型: string。任意。

terminal
orc brands suggestions accept <id> --edit-name <value>
​
--relation

Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored

型: string。任意。

terminal
orc brands suggestions accept <id> --relation <value>

​
suggestions reject

提案IDを指定して却下します。採用するブランドを作成する操作ではありません。

terminal
orc brands suggestions reject <id> [options]

​
固有のオプション

​
--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc brands suggestions reject <id> --idempotency-key <value>

​
get

一覧から得たブランドIDで、プロフィールを含む詳細を取得します。対象は現在のWorkspace内のブランドです。

terminal
orc brands get <id> [options]

​
update

入力した項目だけを変更します。配列と提案判断のmapは全体を置き換えます。長い説明や構造化した products_and_services、audience はJSONを --stdin で渡してください。nullable項目は null で解除できます。disabled は履歴を保持して将来の実行を止め、再有効化しても停止期間を埋め戻しません。

terminal
orc brands update <id> [options]

​
固有のオプション

​
--name

Human-readable brand name. Omit to retain the current value.; max 255 chars

型: string。任意。

terminal
orc brands update <id> --name <value>
​
--domain

Primary normalized domain in the brand registry. This field does not create a verification or ingestion Domain resource. Omit to retain the current value. When domains is omitted, supplying domain replaces the registry with this single value.; max 255 chars

型: string。任意。

terminal
orc brands update <id> --domain <value>
​
--relation

Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored

型: string。任意。

terminal
orc brands update <id> --relation <value>
​
--tags

Labels attached to the brand. Strings are trimmed and empty strings are removed. Omit to retain the current value. Send [] to clear.; csv

型: string。任意。

terminal
orc brands update <id> --tags <value>
​
--logo-url

Logo URL or file reference; null when none is stored. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --logo-url <value>
​
--display-name

Display name distinct from the stored brand name; null when unset. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --display-name <value>
​
--industry

Industry label stored on the brand; null when unset. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --industry <value>
​
--status

Lifecycle transition. disabled preserves history and stops future execution; returning to active does not backfill the disabled interval.; enum: active|disabled

型: string。任意。

terminal
orc brands update <id> --status <value>
​
--domains

Full brand domain registry. Values are trimmed, lowercased and stripped of an HTTP(S) scheme, leading www. and trailing slash. The first value becomes domain. Duplicate normalized values are rejected. Omit to retain the current value.; csv

型: string。任意。

terminal
orc brands update <id> --domains <value>
​
--aliases

Alternate brand names used for matching. Strings are trimmed and empty strings are removed. Omit to retain the current value. Send [] to clear.; csv

型: string。任意。

terminal
orc brands update <id> --aliases <value>
​
--color-hex

Six-digit hexadecimal display color. color_token takes precedence when both are supplied. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --color-hex <value>
​
--notes

Free-form brand profile notes; null when unset. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --notes <value>
​
--regex-pattern

Stored regular expression for advanced brand matching; null when unset. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --regex-pattern <value>
​
--color-token

Named display color. Writing this field also sets its corresponding color_hex. Omit to retain the current value.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: string。任意。

terminal
orc brands update <id> --color-token <value>
​
--identity-kind

Presentation style for the brand identity. Omit to retain the current value.; enum: color|initial|icon|emoji|image

型: string。任意。

terminal
orc brands update <id> --identity-kind <value>
​
--icon-token

Icon reference used for an icon identity; null when unset. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --icon-token <value>
​
--emoji

Emoji used for an emoji identity; null when unset. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --emoji <value>
​
--image-file-id

File reference used for an image identity. Writing this field also sets logo_url; null clears both and switches identity_kind to initial. Omit to retain the current value.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc brands update <id> --image-file-id <value>
​
--products-and-services

Full replacement product and service list, with a required name per entry. Also replaces offerings with those names and takes precedence over offerings in the same request. An empty array clears the list. Omit to retain stored details unless offerings is supplied.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc brands update <id> --products-and-services <value>
​
--offerings

Product and service names. Name-only edits retain stored details for matching names; products_and_services takes precedence when supplied. Omit to retain the current value. Send [] to clear.; csv

型: string。任意。

terminal
orc brands update <id> --offerings <value>
​
--audience

Audience segment list, up to 20 entries. Each percentage must be 0 to 100; this endpoint does not validate their sum. Supplying the array replaces all stored segments; an empty array clears them. Omit to retain the current list.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc brands update <id> --audience <value>
​
--profile-suggestion-decisions

Map from generated profile suggestion keys to accepted or rejected decisions. Omit to retain the current value.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc brands update <id> --profile-suggestion-decisions <value>

​
使用例

省略項目は保持されます。配列に1項目だけを送ると、その配列は1項目へ置き換わります。

terminal
orc brands update <brand-id> --stdin --workspace <workspace-id> < brand-profile.patch.json

JSONでプロフィールを更新する

​
delete

指定したブランドを論理削除します。対象IDとWorkspaceを確認してから実行してください。

terminal
orc brands delete <id> [options]

​
使用例

​
プロフィール更新の入力

brand-profile.patch.json
{
  "notes": "Enterprise search software.",
  "offerings": [
    "Acme Search"
  ],
  "audience": [
    {
      "id": "developers",
      "label": "Developers",
      "description": "Software teams",
      "percentage": 100,
      "enabled": true
    }
  ]
}

プロフィール更新の入力

​
必要な権限

対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。

​
グローバルオプション

orc brands では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。