CLI を使い始める

​
research meta-ads

Meta 広告ライブラリの公開広告と広告主を調査します。検索で広告や広告主を見つけ、広告 ID またはページ ID で詳細を取得します。

​
使い方

terminal
orc research meta-ads advertisers ads list --page-id 123456789 --country JP --status ACTIVE --workspace YOUR_WORKSPACE_ID --format json

指定広告主の日本向け配信中広告を取得する

​
サブコマンド

​
ads get

広告を取得します。

terminal
orc research meta-ads ads get [options]

​
固有のオプション

​
--ad-id

ad_archive_id from an ad search or advertiser listing; not page_id.

型: string。必須。

terminal
orc research meta-ads ads get --ad-id <value>

​
advertisers ads list

広告主の広告を一覧取得します。

terminal
orc research meta-ads advertisers ads list [options]

​
固有のオプション

​
--page-id

Source numeric identifier, sent as a string to preserve precision.

型: string。任意。

terminal
orc research meta-ads advertisers ads list --page-id <value>
​
--advertiser-name

Advertiser name, alternative to page_id.; max 500 chars

型: string。任意。

terminal
orc research meta-ads advertisers ads list --advertiser-name <value>
​
--country

One two-letter country code or ALL. Default ALL.

型: string。任意。

terminal
orc research meta-ads advertisers ads list --country <value>
​
--status

Ad delivery status filter. Default ACTIVE.; enum: ALL|ACTIVE|INACTIVE

型: string。任意。

terminal
orc research meta-ads advertisers ads list --status <value>
​
--media-type

Source media category; MEME means text with an image. Omitted means provider default ALL.; enum: ALL|IMAGE|VIDEO|MEME|IMAGE_AND_MEME|NONE

型: string。任意。

terminal
orc research meta-ads advertisers ads list --media-type <value>
​
--sort-by

Source ordering: impressions or recent monthly relevance. Does not imply exact impression counts are available.; enum: total_impressions|relevancy_monthly_grouped

型: string。任意。

terminal
orc research meta-ads advertisers ads list --sort-by <value>
​
--start-date

Calendar date in YYYY-MM-DD. Date range refers to source advertising delivery/impression filters, not an exhaustive archive.

型: string。任意。

terminal
orc research meta-ads advertisers ads list --start-date <value>
​
--end-date

Calendar date in YYYY-MM-DD. Date range refers to source advertising delivery/impression filters, not an exhaustive archive.

型: string。任意。

terminal
orc research meta-ads advertisers ads list --end-date <value>
​
--language

Two-letter uppercase ad language filter, for example EN.

型: string。任意。

terminal
orc research meta-ads advertisers ads list --language <value>

​
ads search

広告を検索します。

terminal
orc research meta-ads ads search [options]

​
固有のオプション

​
--query

Search text. Search indexes do not guarantee exhaustive coverage.; max 500 chars

型: string。必須。

terminal
orc research meta-ads ads search --query <value>
​
--country

One two-letter country code or ALL. Default ALL.

型: string。任意。

terminal
orc research meta-ads ads search --country <value>
​
--status

Ad delivery status filter. Default ACTIVE.; enum: ALL|ACTIVE|INACTIVE

型: string。任意。

terminal
orc research meta-ads ads search --status <value>
​
--media-type

Source media category; MEME means text with an image. Omitted means provider default ALL.; enum: ALL|IMAGE|VIDEO|MEME|IMAGE_AND_MEME|NONE

型: string。任意。

terminal
orc research meta-ads ads search --media-type <value>
​
--sort-by

Source ordering: impressions or recent monthly relevance. Does not imply exact impression counts are available.; enum: total_impressions|relevancy_monthly_grouped

型: string。任意。

terminal
orc research meta-ads ads search --sort-by <value>
​
--start-date

Calendar date in YYYY-MM-DD. Date range refers to source advertising delivery/impression filters, not an exhaustive archive.

型: string。任意。

terminal
orc research meta-ads ads search --start-date <value>
​
--end-date

Calendar date in YYYY-MM-DD. Date range refers to source advertising delivery/impression filters, not an exhaustive archive.

型: string。任意。

terminal
orc research meta-ads ads search --end-date <value>
​
--search-type

Keyword matching mode.; enum: keyword_unordered|keyword_exact_phrase

型: string。任意。

terminal
orc research meta-ads ads search --search-type <value>
​
--ad-type

Public library category; defaults to all at the provider.; enum: all|political_and_issue_ads

型: string。任意。

terminal
orc research meta-ads ads search --ad-type <value>

​
advertisers search

広告主を検索します。

terminal
orc research meta-ads advertisers search [options]

​
固有のオプション

​
--query

Search text. Search indexes do not guarantee exhaustive coverage.; max 500 chars

型: string。必須。

terminal
orc research meta-ads advertisers search --query <value>

​
出力と継続

1回で1ページを取得します。継続可能な場合はトップレベルの pagination.next_cursor を --cursor に渡し、検索条件を維持します。data.next_cursor は使用しません。has_more: null は不明であり、完了ではありません。--page-all は使えません。

JSONでは data.data に取得内容、data.pagination に継続情報、data.source に取得元情報が入ります。--raw はCLIの外枠を外し、--field data はAPIのデータだけを選択します。欠損・nullを0として扱わないでください。

data.usage.provider_credits は取得元の単位で、Orchestorの請求単位とは異なります。取得範囲・プロバイダー固有の制約は各APIリファレンスに記載しています。

​
必要な権限

orc auth login でベータ承認済みアカウントにログインするか、read スコープの API キーを使用します。アクセスできる Workspace を --workspace で指定します。research 専用の Workspace 許可リストは不要です。

​
グローバルオプション

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

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