CLI を使い始める

​
connections

orc connections のSearch Console操作は、接続したGoogleアカウントでアクセス可能なプロパティを一覧し、選択したプロパティの検索パフォーマンス、URLのインデックス状態、送信済みサイトマップを取得します。検索語句・ページ・国・デバイスなどの条件でデータを絞り込めます。

プロパティの選択はOrchestorの接続に保存します。Google側の設定やサイトマップは変更しません。最初に接続IDを確認し、取得対象のプロパティを選択してください。

​
使い方

terminal
orc connections list --workspace YOUR_WORKSPACE_ID --provider google-search-console --format json

使用例

​
サブコマンド

​
search-console-sites-list

アクセスできるプロパティを一覧表示

terminal
orc connections search-console-sites-list <id> [options]

​
search-console-site-select

接続で使用するプロパティを選択

terminal
orc connections search-console-site-select <id> [options]

​
固有のオプション

​
--site-url

(required) Body field: site_url; max 2048 chars

型: string。任意。

terminal
orc connections search-console-site-select <id> --site-url <value>

​
search-console-analytics-query

検索パフォーマンスを取得

terminal
orc connections search-console-analytics-query <id> [options]

​
固有のオプション

​
--aggregation-type

Body field: aggregation_type; enum: auto|byPage|byProperty|byNewsShowcasePanel

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --aggregation-type <value>
​
--data-state

Body field: data_state; enum: final|all|hourly_all

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --data-state <value>
​
--dimension-filter-groups

Body field: dimension_filter_groups; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --dimension-filter-groups <value>
​
--dimensions

Body field: dimensions; csv of: date|query|page|country|device|searchAppearance|hour

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --dimensions <value>
​
--end-date

(required) Inclusive date in America/Los_Angeles (Pacific Time).

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --end-date <value>
​
--row-limit

Body field: row_limit

型: number。任意。

terminal
orc connections search-console-analytics-query <id> --row-limit <value>
​
--start-date

(required) Inclusive date in America/Los_Angeles (Pacific Time).

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --start-date <value>
​
--start-row

Body field: start_row

型: number。任意。

terminal
orc connections search-console-analytics-query <id> --start-row <value>
​
--type

Body field: type; enum: web|image|video|news|discover|googleNews

型: string。任意。

terminal
orc connections search-console-analytics-query <id> --type <value>

​
search-console-url-inspect

URL のインデックス状態を取得

terminal
orc connections search-console-url-inspect <id> [options]

​
固有のオプション

​
--inspection-url

(required) Body field: inspection_url; max 2048 chars

型: string。任意。

terminal
orc connections search-console-url-inspect <id> --inspection-url <value>
​
--language-code

BCP-47 language code, for example en-US.; max 35 chars

型: string。任意。

terminal
orc connections search-console-url-inspect <id> --language-code <value>

​
search-console-sitemaps-list

送信済みサイトマップを取得

terminal
orc connections search-console-sitemaps-list <id> [options]

​
使用例

​
使用例

terminal
orc connections search-console-sites-list YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --format json
orc connections search-console-site-select YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --site-url 'sc-domain:example.com' --format json

使用例

​
使用例

terminal
orc connections search-console-analytics-query YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --start-date 2026-09-01 --end-date 2026-09-30 --dimensions query,page --row-limit 1000 --format json

使用例

​
使用例

以下の JSON を analytics.json に保存します。

terminal
orc connections search-console-analytics-query YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --stdin --format json < analytics.json

使用例

analytics.json
{
  "start_date": "2026-09-01",
  "end_date": "2026-09-30",
  "dimensions": [
    "page"
  ],
  "dimension_filter_groups": [
    {
      "filters": [
        {
          "dimension": "page",
          "operator": "contains",
          "expression": "/blog/"
        }
      ]
    }
  ]
}

​
使用例

terminal
orc connections search-console-url-inspect YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --inspection-url 'https://example.com/page' --language-code ja-JP --format json

使用例

​
使用例

terminal
orc connections search-console-sitemaps-list YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --format json

使用例

​
必要な権限

対象プロパティを読める Google アカウントを接続し、webmasters.readonly スコープで認可します。Orchestor ではログインとアクセス可能な Workspace が必要です。

​
グローバルオプション

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

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