CLI を使い始める

research

orc research は、キーワード需要、公開記事、ソーシャル投稿、動画、Webページを調べるコマンド群です。調査対象ごとのコマンドで検索・詳細取得・継続取得を行い、共通の認証、Workspace指定、出力形式を使って取得元の情報を確認できます。

キーワード調査ではGoogle KeywordsやGoogle Trends、公開コンテンツの調査では各サービスの専用コマンドを選びます。このページでは取得機能を発見する入口を紹介し、個別の検索条件や結果の読み方は各プロバイダーのページで説明します。

認証済みのCLIと、アクセス可能なWorkspaceが必要です。--workspace で今回の対象を指定できます。

使い方

terminal
orc research google-keywords map --workspace <workspace-id>

取得機能を確認する。

terminal
orc research web map --url https://example.com --fallback none --workspace <workspace-id> --json

有料fallbackを使わずURLを探索する。

調査対象を選ぶ

サブコマンド

web map

サイトマップ・llms.txt・リンクから最大100,000件のURLを探索します。本文の一括取得ではありません。既定の firecrawl fallbackを止める場合は --fallback none を指定します。

terminal
orc research web map [options]

固有のオプション

--fallback

Body field: fallback; enum: none|firecrawl

型: string。任意。

terminal
orc research web map --fallback <value>
--max-age

Body field: maxAge

型: number。任意。

terminal
orc research web map --max-age <value>
--sitemap

Body field: sitemap; enum: include|only|skip

型: string。任意。

terminal
orc research web map --sitemap <value>
--url

(required) Body field: url; max 2048 chars

型: string。任意。

terminal
orc research web map --url <value>

note map

noteのトピックや取得機能の入口を確認します。返されたトピックのpathを topics get に指定できます。

terminal
orc research note map [options]

prtimes map

分類とリリース一覧の入口を取得します。分類別の一覧には、このレスポンスで確認したIDを使います。

terminal
orc research prtimes map [options]

google-keywords map

キーワード探索・検索数・検索意図・順位比較などの取得機能と入力の入口を確認します。最初の調査で使用する操作を選ぶときに使います。

terminal
orc research google-keywords map [options]

指定した地域・言語・期間で関心度の推移、地域分布、関連クエリ、トピックを取得します。グラフと地域比較は最大5語、関連クエリ・トピックを含める場合は1語を指定します。

terminal
orc research google-trends get [options]

固有のオプション

--item-types

Requested result types: graph for interest over time, map for geographic interest, topics_list for related topics, and queries_list for related searches. Topic and query lists require exactly one keyword.; csv of: google_trends_graph|google_trends_map|google_trends_topics_list|google_trends_queries_list

型: string。任意。

terminal
orc research google-trends get --item-types <value>
--keywords

(required) Search terms to compare. Specify exactly one term when requesting related topics or related queries in item_types. Leading and trailing whitespace is removed.; csv

型: string。任意。

terminal
orc research google-trends get --keywords <value>
--language-code

(required) Provider language code for the request. Support depends on the upstream dataset; Labs combinations are available from the locales endpoint.

型: string。任意。

terminal
orc research google-trends get --language-code <value>
--location-code

(required) Provider location identifier for geographic targeting. This is not a country ISO code. Supported locations depend on the upstream dataset.

型: number。任意。

terminal
orc research google-trends get --location-code <value>
--time-range

Relative time window for the comparison. Scores are normalized within the requested comparison and are not absolute search counts.; enum: past_hour|past_4_hours|past_day|past_7_days|past_30_days|past_90_days|past_12_months|past_5_years

型: string。任意。

terminal
orc research google-trends get --time-range <value>
--type

Google search surface: web, news, youtube, images, or froogle for Google Shopping.; enum: web|news|youtube|images|froogle

型: string。任意。

terminal
orc research google-trends get --type <value>

zenn map

Zennの取得機能とコンテンツの入口を確認します。

terminal
orc research zenn map [options]

qiita map

Qiitaの取得機能と記事・タグ・ユーザーの入口を確認します。

terminal
orc research qiita map [options]

itreview map

itreviewの取得機能と調査の入口を確認します。

terminal
orc research itreview map [options]

固有のオプション

--max-age

Maximum cached acquisition age in milliseconds. Default 24 hours; zero forces acquisition. Original source timestamps are preserved. Successful refreshes append history. Refresh is on request, not scheduled.; (use "null" or "reset" to clear)

型: number。任意。

terminal
orc research itreview map --max-age <value>

出力・継続・エラー

--json はAPIレスポンス全体をCLIの data に保持し、--raw はCLIの外枠を省略します。配列フラグはカンマ区切りです。--dry-run は送信せずにリクエストを表示します。

一回の一覧呼び出しは一ページで、Researchは --page-all による自動巡回に対応しません。継続形式は取得元によって異なるため、プロバイダーの説明を参照してください。HTTP成功でもバッチ内の一部が失敗する場合があるので、各行の結果を確認します。

終了コードは成功0、API・認証・通信の失敗1、引数エラー2です。認証・Workspace・入力の条件を修正してから再実行し、成功済みのバッチ行を無条件に再送しないでください。

必要な権限

APIキーではGETはreadスコープ、POSTのキーワード取得・Trendsはwriteスコープが必要です。YouTubeの transcripts get はPOSTですがreadスコープで実行します。アクセス可能なWorkspaceを指定してください。

グローバルオプション

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

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

関連項目