Adapty Developer CLI の Ads Manager コマンド
この記事では、Adapty CLI における Ads Manager のすべてのコマンドを、引数・フラグ・使用可能な値とともに説明します。Ads Manager コマンドは adapty asa トピック配下にあります。
前提条件、安全な書き込み操作、タスクベースの使用例については、CLI から Ads Manager を管理する を参照してください。
これらのコマンドを使用するには、Apple Ads アカウントの連携と有効な Ads Manager サブスクリプションが必要です。両方の確認は adapty asa whoami を実行してください。その他の CLI コマンドについては、コマンドリファレンスを参照してください。
グローバルフラグ
これらのフラグはすべての Ads Manager コマンドで使用できます。
| フラグ | 説明 |
|---|---|
--json | フォーマットされたテキストの代わりに JSON で出力する |
--help | コマンドのヘルプを表示する |
すべての list コマンドはページネーションフラグも受け付けます：
| フラグ | デフォルト | 説明 |
|---|---|---|
--page | 1 | ページ番号 |
--page-size | 100 | 1ページあたりのアイテム数（最大: 1000） |
Ads Manager のページサイズは CLI の他のコマンドよりも大きくなっています。小さいページを繰り返すより、1回で大きなページを取得することをおすすめします。
アカウントを変更するすべてのコマンドは、以下のフラグを受け付けます：
| フラグ | 説明 |
|---|---|
--yes, -y | 確認なしで適用します。出力がパイプされている場合や --json を使用する場合に必須です |
--idempotency-key | この書き込み操作に使用する固定キーです。同じキーと本文で24時間以内に再実行すると、変更を再適用する代わりに保存済みの結果を返します |
Ads Manager コマンドに --app フラグはありません。スコープはトークンが属するカンパニーです。--app は一部の list コマンドにフィルターとしてのみ存在します。
リストフィルター
フィルターはクエリ自体を絞り込むもので、表示ページを絞るものではありません。フィルターなしの keywords list はアカウント内のすべてのキーワードをページングするため、必要なレベルに合わせてスコープを設定してください。
| フィルター | 受け付けるコマンド |
|---|---|
--campaign-group | campaigns, ad-groups, keywords, negative-keywords, search-terms, ads, creatives, product-pages |
--app | campaigns, ad-groups, keywords, negative-keywords, search-terms, creatives, product-pages |
--campaign | ad-groups, keywords, negative-keywords, search-terms, ads |
--ad-group | keywords, negative-keywords, search-terms, ads |
--status | campaigns, ad-groups, ads（ENABLED または PAUSED）、keywords（ACTIVE または PAUSED） |
--search | campaigns, ad-groups, keywords, negative-keywords, search-terms, ads。名前に対する大文字小文字を区別しない部分一致 |
adapty asa apps list、orgs list、automations list、automations runs はフィルターを取りません。ページネーションフラグのみ受け付けます。
--campaign-group、--app、--campaign、--ad-group は対応する list コマンドで表示される UUID を受け取り、それぞれ繰り返し指定できます。
adapty asa keywords list --ad-group <ad-group-id> --ad-group <other-ad-group-id>別の会社に属する ID を指定した場合、エラーにはならず、空のページが返されます。
アカウント
adapty asa whoami
所属会社、Ads Manager へのアクセス付与方法、および Apple Ads が接続されているかどうかを表示します。
adapty asa whoami他のすべてのコマンドを実行する前に、まずこのコマンドを実行してください。2 つの前提条件が満たされているかどうかを確認できます。
adapty asa connect
Apple Ads アカウントを Adapty に連携します。
adapty asa connectこのコマンドは Apple 認証リンクを表示し、Apple がアカウントの接続を報告するまで待機します。
| フラグ | デフォルト | 説明 |
|---|---|---|
--wait / --no-wait | --wait | Apple Ads が接続済みと報告するまで待機します。--no-wait はすぐに返します |
--timeout | 300 | ブラウザのステップを待機する秒数 |
adapty asa orgs list
会社で利用可能なキャンペーングループ（Apple Ads組織）を一覧表示します。
adapty asa orgs list各行には2つの識別子が含まれており、互いに互換性はありません。
| フィールド | 使用箇所 |
|---|---|
internal_id | campaigns create の --org と、リストフィルター の --campaign-group が受け取るUUID |
org_id | campaigns bulk-create の --org-id が受け取るAppleの数値組織ID。--org と --campaign-group はこの値を受け付けない |
--org は campaigns create にのみ存在します。list コマンドでは使用できません。
各行には payment_model も含まれます。値が LOC の場合、組織はラインオブクレジットで請求され、その組織内のすべてのキャンペーンに --invoice-* フラグが必要です。
ページネーションフラグを使用できます。
adapty asa apps list
Apple Ads でプロモートされているアプリの一覧を表示します。
adapty asa apps list各行には2つの識別子があり、これらは互換性がありません：
| フィールド | 使用用途 |
|---|---|
internal_id | --app のリストフィルターとして使用するUUID |
adam_id | campaigns create および product-pages sync の --adam-id で使用するAppleの数値App Store ID |
ページネーションフラグを受け付けます。
キャンペーン
adapty asa campaigns list
キャンペーンを一覧表示します。メタデータのみを返します。パフォーマンスの数値は asa metrics で取得してください。
adapty asa campaigns list --app <app-id> --status PAUSEDページネーションフラグ、および --campaign-group、--app、--search、--status のリストフィルターを使用できます。
adapty asa campaigns get
特定のキャンペーンの詳細を取得します。
adapty asa campaigns get <campaign-id>| 引数 | 説明 |
|---|---|
campaign-id | キャンペーン ID（UUID） |
adapty asa campaigns create
キャンペーンを作成します。
adapty asa campaigns create --org <campaign-group-id> --name "Winter push" --adam-id 123456 --country US --daily-budget 50| フラグ | 必須 | 説明 |
|---|---|---|
--org | 必須 | キャンペーングループID（UUID）。orgs list を参照 |
--name | 必須 | キャンペーン名 |
--adam-id | 必須 | App Store アプリID（adam_id） |
--country | 必須 | 国または地域コード。複数指定する場合は繰り返す：--country US --country CA |
--daily-budget | 必須 | 1日の予算（金額をそのまま指定）。例：50 または 12.50 |
--budget | 任意 | 通算予算 |
--target-cpa | 任意 | 目標獲得単価。--daily-budget より低い値にする必要あり |
--currency | 任意 | このリクエストで使用する通貨コード。デフォルト：USD |
--bidding-strategy | 任意 | MANUAL_CPT または MAX_CONVERSIONS。Appleのデフォルト：MANUAL_CPT |
--ad-channel-type | 任意 | SEARCH または DISPLAY。デフォルト：SEARCH |
--billing-event | 任意 | TAPS または IMPRESSIONS。デフォルト：TAPS |
--supply-source | 任意 | 配信ソース（複数指定可）。デフォルト：APPSTORE_SEARCH_RESULTS |
--status | 任意 | 初期ステータス：ENABLED または PAUSED |
--invoice-advertiser | 与信枠 | 請求オプション：広告主名 |
--invoice-order-number | 与信枠 | 請求オプション：注文番号 |
--invoice-contact-name | 与信枠 | 請求オプション：購入者の担当者名 |
--invoice-contact-email | 与信枠 | 請求オプション：購入者の連絡先メールアドレス |
--invoice-billing-email | 与信枠 | 請求オプション：請求担当者のメールアドレス |
payment_model が LOC の組織は与信枠による請求を行い、Apple は各キャンペーンに Invoicing Options を必須とします。5 つの --invoice-* フラグすべてを一度に渡してください — 一部だけ指定するとリクエスト送信前に拒否されます。与信枠の Invoicing Options を設定する を参照してください。
レスポンスには serving_status と serving_state_reasons が含まれます。キャンペーンを作成しても配信が開始されない場合があります。MAX_CONVERSIONS キャンペーンは自動広告グループを待機し、クレジットラインキャンペーンは請求オプションの設定を待機します。いずれの場合も、コマンドはその理由と解決するためのコマンドを表示します。
adapty asa campaigns update
既存のキャンペーンを更新します。
adapty asa campaigns update <campaign-id> --daily-budget 80 --status PAUSED| 引数 | 説明 |
|---|---|
campaign-id | キャンペーン ID（UUID） |
| フラグ | 説明 |
|---|---|
--name | 新しいキャンペーン名 |
--status | ENABLED または PAUSED |
--country | 国リストを置き換えます。複数指定する場合は繰り返し使用 |
--daily-budget | 新しい1日の予算 |
--budget | 新しい通算予算 |
--target-cpa | 新しいターゲットCPA（獲得単価） |
--bidding-strategy | MANUAL_CPT または MAX_CONVERSIONS |
--currency | このリクエストの金額に使用する通貨コード。デフォルト: USD |
--invoice-advertiser | 請求オプション: 広告主名 |
--invoice-order-number | 請求オプション: 注文番号 |
--invoice-contact-name | 請求オプション: 購入者の担当者名 |
--invoice-contact-email | 請求オプション: 購入者の連絡先メールアドレス |
--invoice-billing-email | 請求オプション: 請求担当者のメールアドレス |
少なくとも1つのフラグが必要です。
5つの --invoice-* フラグはセットとして機能し、保存済みの請求オプションをまとめて置き換えます。そのため、1つだけ変更する場合でも5つすべてを指定してください。一部だけ指定した場合は、リクエストが送信される前に拒否されます。
adapty asa campaigns bulk-create
キャンペーン構造全体（キャンペーン、広告グループ、キーワード、除外キーワード、広告をネスト）を一括操作で作成します。
adapty asa campaigns bulk-create --file structure.jsonJSONを手書きする代わりに、Apple Ads のバルクテンプレートを変換することもできます：
adapty asa campaigns bulk-create --from-file Campaign_And_Adgroup_Template.xlsx --org-id 1234567| フラグ | デフォルト | 説明 |
|---|---|---|
--file | — | キャンペーン構造を含む JSON ファイル、または標準入力から読み込む場合は - |
--from-file | — | サーバー上で変換する Apple Ads バルクテンプレート: Campaign_And_Adgroup_Template.xlsx または キーワード .csv |
--org-id | — | Apple の数値型組織 ID (org_id)。orgs list を参照。--from-file と併用する場合に必須 |
--preview | — | --from-file と併用: 変換後の構造を出力して終了。何も作成されない |
--wait / --no-wait | --wait | 操作が完了するまでポーリングする。--no-wait は操作 ID を出力して返る |
--poll-interval | 5 | 進捗ポーリングの間隔（秒） |
--timeout | 900 | 操作の完了を待つ最大秒数 |
--file と --from-file のどちらか一方のみが必須です。
この構造では、最上位レベルでキャンペーングループが命名され、他のすべてがその下にネストされます。
{
"campaign_group_id": 555777,
"campaigns": [
{
"payload": {
"name": "US Search",
"adam_id": 123456,
"countries_or_regions": ["US"],
"daily_budget_amount": { "amount": "100", "currency": "USD" },
"status": "ENABLED",
"ad_channel_type": "SEARCH",
"billing_event": "TAPS",
"supply_sources": ["APPSTORE_SEARCH_RESULTS"]
},
"ad_groups": [
{
"payload": { "name": "Brand", "start_time": "2026-08-01T00:00:00Z", "status": "ENABLED" },
"keywords": [{ "text": "meditation app", "match_type": "BROAD" }]
}
]
}
]
}campaign_group_idにはAppleの数値型organization IDを指定します。UUIDを渡す場合はcampaign_group_internal_idを使用してください。payloadを持つノードが作成されます。既存のエンティティをidで参照するノードはアンカーと呼ばれ、既存のキャンペーンに広告グループを追加する際に使用します。同一オペレーションでエンティティを変更するにはupdate_payloadを追加します。キャンペーンはad_groupsをネストし、各広告グループはkeywords、negative_keywords、およびadsをネストします。キャンペーンレベルのネガティブキーワードは、キャンペーンに直接negative_keywordsを指定します。
構造全体は何も作成される前に検証され、無効なノードがある場合はすべてリストアップされます。--from-file を使用した場合、変換の問題はシート、行、列とともに報告されます。変換の警告は送信を止めませんが、変換エラーは中断します。送信前に、構造に含まれるキャンペーン、広告グループ、キーワード、除外キーワード、広告の数が報告され、確認が求められます。
コマンドはその後、操作をポーリングし、次の3つの最終ステータスのいずれかになるまで進捗を表示し続けます。
| ステータス | 意味 |
|---|---|
success | すべてのオブジェクトが作成されました |
partial | 一部のオブジェクトが作成されませんでした。各エラーはAppleのエラーとともに表示されます |
failed | 操作が失敗し、コマンドはゼロ以外の終了コードで終了します |
--timeout 秒が経過しても操作が完了しない場合、コマンドは戻り値を返し、後で実行する bulk-status の呼び出しを表示します。
adapty asa campaigns bulk-status
1つのバルク操作の進捗（ステータス、オブジェクト数、オブジェクトごとのログ）を表示します。
adapty asa campaigns bulk-status <operation-id>| 引数 | 説明 |
|---|---|
operation-id | campaigns bulk-create が出力する操作 ID（UUID） |
status フィールドの値は pending、running、success、partial、failed のいずれかです。counts ブロックには、合計数のうち適用済み、失敗、保留中のオブジェクト数が示されます。
ページネーションフラグを使用できます。
広告グループ
adapty asa ad-groups list
広告グループを一覧表示します。メタデータのみを返します。パフォーマンス指標を確認するには asa metrics を使用してください。
adapty asa ad-groups list --campaign <campaign-id>ページネーションフラグ、および --campaign-group、--app、--campaign、--search、--status のリストフィルターを使用できます。
adapty asa ad-groups get
特定の広告グループの詳細を取得します。
adapty asa ad-groups get <ad-group-id>| 引数 | 説明 |
|---|---|
ad-group-id | 広告グループ ID（UUID） |
adapty asa ad-groups create
キャンペーンにアドグループを作成します。
adapty asa ad-groups create --campaign <campaign-id> --name "Brand terms" --default-bid 1.20| フラグ | 必須 | 説明 |
|---|---|---|
--campaign | はい | キャンペーン ID（UUID） |
--name | はい | 広告グループ名 |
--default-bid | --automated を使わない場合は必須 | デフォルト入札額（例: 1.20） |
--cpa-goal | いいえ | 目標 CPA（コンバージョン単価） |
--pricing-model | いいえ | CPC または CPM。Apple はすべての広告グループに必須。デフォルト: CPC |
--start-time | いいえ | スケジュール開始日（YYYY-MM-DD）。デフォルトは当日 |
--end-time | いいえ | スケジュール終了日（YYYY-MM-DD） |
--automated-keywords / --no-automated-keywords | いいえ | Apple によるキーワードの自動追加を許可する |
--automated | いいえ | MAX_CONVERSIONS キャンペーンに必要な自動広告グループを作成する |
--currency | いいえ | このリクエストで使用する金額の通貨コード。デフォルト: USD |
--status | いいえ | 初期ステータス: ENABLED または PAUSED |
--automated はアドグループを自動化キーワードにオプトインするため、--automated-keywords と組み合わせることはできません。Apple が自動化されたアドグループ自体をスケジュールし、有効な状態を維持するため、--start-time および --status PAUSED は拒否されます。代わりにキャンペーンを一時停止してください。Max Conversions キャンペーンを作成するを参照してください。
adapty asa ad-groups update
既存の広告グループを更新します。
adapty asa ad-groups update <ad-group-id> --default-bid 1.50 --status PAUSED| 引数 | 説明 |
|---|---|
ad-group-id | 広告グループID（UUID） |
| フラグ | 説明 |
|---|---|
--name | 新しい広告グループ名 |
--status | ENABLED または PAUSED |
--default-bid | 新しいデフォルト入札額 |
--cpa-goal | 新しい目標獲得単価（CPA） |
--start-time | スケジュール開始日（YYYY-MM-DD） |
--end-time | スケジュール終了日（YYYY-MM-DD） |
--automated-keywords / --no-automated-keywords | Apple によるキーワードの自動追加を許可する |
--currency | このリクエストで使用する金額の通貨コード。デフォルト: USD |
少なくとも1つのフラグが必要です。親キャンペーンはサーバー側で解決されるため、指定する必要はありません。
キーワード
キーワードコマンドは、1回の呼び出しにつき最大100件のバッチとして適用されます。ダッシュボードでの操作については、キーワードの管理を参照してください。
adapty asa keywords list
ターゲティングキーワードを一覧表示します。パフォーマンス数値は asa metrics で取得してください。
adapty asa keywords list --ad-group <ad-group-id> --status ACTIVEページネーションフラグ および --campaign-group、--app、--campaign、--ad-group、--search、--status の リストフィルター を使用できます。--ad-group でフィルタリングすることを推奨します。フィルターなしではこのトピックで最も広い範囲の読み取りが行われます。
adapty asa keywords add
ターゲティングキーワードを広告グループに追加します。
adapty asa keywords add --ad-group <ad-group-id> --text "running shoes" --text "trail shoes" --bid 1.20ファイルから1行ずつキーワードを読み込む場合:
adapty asa keywords add --ad-group <ad-group-id> --from-file keywords.txt| フラグ | 必須 | 説明 |
|---|---|---|
--ad-group | はい | 広告グループID（UUID）。キャンペーンはここから解決されます |
--text | はい（--from-file を使用しない場合） | キーワードテキスト。複数指定する場合は繰り返します |
--from-file | いいえ | 1行につき1キーワードを記載したファイル。--text の値と組み合わせ可能 |
--bid | いいえ | キーワードごとの入札額（金額のみ） |
--match-type | いいえ | BROAD または EXACT。デフォルト: BROAD |
--currency | いいえ | このリクエストで使用する通貨コード。デフォルト: USD |
--status | いいえ | ACTIVE または PAUSED。デフォルト: ACTIVE |
1つの無効なIDがあると、Appleが呼び出される前にバッチ全体が失敗します。Appleは個々のキーワードを拒否することがあり、拒否のたびにその理由が報告されます。
adapty asa keywords update
1つまたは複数のキーワードの入札額、ステータス、テキスト、またはマッチタイプを変更します。
adapty asa keywords update <keyword-id> <keyword-id> --bid 2.00 --status PAUSED| 引数 | 説明 |
|---|---|
keyword-id | キーワード ID（UUID）。複数指定する場合は追加の引数として渡します |
| フラグ | 説明 |
|---|---|
--bid | 新しい入札額 |
--status | ACTIVE または PAUSED |
--match-type | BROAD または EXACT |
--text | 新しいキーワードのテキスト。単一のキーワードに対してのみ有効 |
--currency | このコールで使用する金額の通貨コード。デフォルト: USD |
1つのIDに対して1つの変更が適用されます。
ネガティブキーワード
adapty asa negative-keywords list
ネガティブキーワードを一覧表示します。ad_group_id が空の行はキャンペーンレベルです。
adapty asa negative-keywords list --campaign <campaign-id>| フラグ | 説明 |
|---|---|
--campaign-level-only | キャンペーンレベルの行のみを保持します |
ページネーションフラグ、および --campaign-group、--app、--campaign、--ad-group、--search のリストフィルターを使用できます。
adapty asa negative-keywords add
広告グループまたはキャンペーンにネガティブキーワードを追加します。
adapty asa negative-keywords add --ad-group <ad-group-id> --text freeキャンペーンのすべての広告グループに適用する場合:
adapty asa negative-keywords add --campaign <campaign-id> --all-ad-groups --text free| フラグ | 必須 | 説明 |
|---|---|---|
--ad-group | --ad-group または --campaign のいずれか | 広告グループID（UUID）。キャンペーンはここから解決されます |
--campaign | --ad-group または --campaign のいずれか | キャンペーンID（UUID） |
--text | Yes | キーワードテキスト。複数指定する場合は繰り返します |
--all-ad-groups | No | キャンペーン自体ではなく、キャンペーンのすべての広告グループに適用します。--campaign が必要です |
--match-type | No | BROAD または EXACT。デフォルト: EXACT |
--status | No | ACTIVE または PAUSED。デフォルト: ACTIVE |
--ad-group と --campaign は同時に使用できません。どちらか一方のみを指定してください。
検索用語
adapty asa search-terms list
広告を表示させた検索キーワードの一覧を表示します。新しいキーワードや除外キーワードを見つけるのに役立ちます。
adapty asa search-terms list --ad-group <ad-group-id> --date-from 2026-07-01 --date-to 2026-07-31| フラグ | デフォルト | 説明 |
|---|---|---|
--date-from | 今日 | レポート期間の開始日（YYYY-MM-DD） |
--date-to | 今日 | レポート期間の終了日（YYYY-MM-DD） |
ページネーションフラグ、および --campaign-group、--app、--campaign、--ad-group、--search のリストフィルターを使用できます。
このコマンドはasa metricsとアナリティクスプールを共有します。エラーを参照してください。
広告
adapty asa ads list
広告を一覧表示します。serving_state_reasons フィールドは、広告が配信されていない理由を説明します。
adapty asa ads list --ad-group <ad-group-id>ページネーションフラグ、および --campaign-group、--campaign、--ad-group、--search、--status のリストフィルターを使用できます。広告は広告グループに属するため、このリストには --app フィルターはありません。
adapty asa ads get
特定の広告の詳細を取得します。
adapty asa ads get <ad-id>| 引数 | 説明 |
|---|---|
ad-id | 広告ID（UUID） |
adapty asa ads create
広告グループに広告を作成します。
adapty asa ads create --ad-group <ad-group-id> --creative-id 4321 --name "Summer ad"| フラグ | 必須 | 説明 |
|---|---|---|
--ad-group | はい | 広告グループID（UUID）。キャンペーンはここから解決されます |
--creative-id | はい | Apple クリエイティブID。creatives list を参照 |
--name | はい | 広告名 |
--status | いいえ | 初期ステータス：ENABLED または PAUSED |
adapty asa ads update
既存の広告を更新します。
adapty asa ads update <ad-id> --status PAUSED| 引数 | 説明 |
|---|---|
ad-id | 広告 ID（UUID） |
| フラグ | 説明 |
|---|---|
--name | 新しい広告名 |
--status | ENABLED または PAUSED |
少なくとも 1 つのフラグが必要です。クリエイティブと親広告グループは作成時に固定されます。
クリエイティブ
adapty asa creatives list
新しい広告に利用できるクリエイティブを一覧表示します。
adapty asa creatives list --app <app-id>ここで返される creative_id は、ads create の --creative-id の値です。
ページネーションフラグ、および --campaign-group と --app のリストフィルターを指定できます。
プロダクトページ
adapty asa product-pages list
アプリで利用可能なカスタムプロダクトページの一覧を表示します。
adapty asa product-pages list --app <app-id>ページネーションフラグ、--campaign-group、--app のリストフィルターを使用できます。
adapty asa product-pages sync
App Store Connect からカスタムプロダクトページを更新します。
adapty asa product-pages sync --adam-id 123456| フラグ | 説明 |
|---|---|
--adam-id | 更新対象を1つのアプリに限定します。省略するとすべてのアプリが対象になります |
更新はすぐに実行されるのではなくキューに追加され、コマンドは Sync queued. で完了を確認します。同じ更新がすでに実行中の場合は、代わりに Already running; nothing new was queued. と表示されます。
オートメーション
CLIは渡されたルールのJSONを保存するだけで、ルールを構築するわけではありません。各ルールタイプの詳細についてはオートメーションを、ルールファイルの作成方法についてはオートメーションルールの実行を参照してください。
adapty asa automations list
自動化ルールを一覧表示します。status フィールドは、アクティブの場合は 1、停止中の場合は 0 になります。
adapty asa automations listページネーションフラグを使用できます。
adapty asa automations get
特定のオートメーションルールを条件やアクションを含めて取得します。
adapty asa automations get <automation-id>| 引数 | 説明 |
|---|---|
automation-id | オートメーションルールID（UUID） |
adapty asa automations create
JSONルールファイルからオートメーションルールを作成します。
adapty asa automations create --file rule.json| フラグ | 説明 |
|---|---|
--file | ルール本体を含むJSONファイル、または - で標準入力から読み込む |
--run-now | ルール保存直後に最初の実行をキューに追加する |
--file は必須です。
adapty asa automations update
オートメーションルールを変更します。停止、名前変更、またはルールの一部を置き換えることができます。
adapty asa automations update <automation-id> --stop| 引数 | 説明 |
|---|---|
automation-id | オートメーションルールのID（UUID） |
| フラグ | 説明 |
|---|---|
--start | ルールを有効化する |
--stop | ルールを停止し、次回の実行をクリアする |
--name | 新しいルール名 |
--file | 変更する箇所を記述したJSONファイル、または標準入力から読み込む場合は - |
--start と --stop は同時に指定できません。ここで渡すファイルには internal_id を含めないでください。
adapty asa automations run
スケジュール外でオートメーションルールを1回実行します。
adapty asa automations run <automation-id> --dry-run| 引数 | 説明 |
|---|---|
automation-id | オートメーションルールID（UUID） |
| フラグ | 説明 |
|---|---|
--dry-run | ルールを評価してその結果をログに記録します。Apple Ads への変更は行いません |
実行はキューに追加され、コマンドは実行IDを出力します。結果は automations runs で確認できます。
adapty asa automations runs
オートメーションルールの過去の実行履歴（ドライランを含む）を一覧表示します。
adapty asa automations runs <automation-id>| 引数 | 説明 |
|---|---|
automation-id | オートメーションルール ID（UUID） |
ページネーションフラグを使用できます。
指標
adapty asa metrics
アカウントの任意のレベルの指標を日付範囲で照会します。
adapty asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31| フラグ | 必須 | 説明 |
|---|---|---|
--entity | はい | レポート対象: campaign、ad-group、keyword、または ad |
--date-from | はい | 期間の開始日（YYYY-MM-DD） |
--date-to | はい | 期間の終了日（YYYY-MM-DD） |
--metric | いいえ | 指標名。繰り返し指定可能。省略するとすべての指標が対象になります |
--group-by | いいえ | 行を country、day、week、month、quarter、または year でグループ化します。繰り返し指定可能 |
--by-days | いいえ | コホート指標の更新ウィンドウ（日数）。繰り返し指定可能。1回の呼び出しにつき最大16件。省略するとダッシュボードのデフォルト値が使用されます |
--order-by | いいえ | 並び替えに使用する指標またはフィールド |
--order-by-day | いいえ | 指定した更新ウィンドウのコホート指標でランク付けします。--by-days の値のいずれかを指定してください |
--order | いいえ | asc または desc。デフォルト: desc |
ページネーションフラグを使用できます。このコマンドはリストフィルターには対応していません。エンティティレベルと期間で絞り込み、スコープ付きの list コマンドから取得した ID と行を照合してください。
各行は1つのエンティティを表し、サーバー側で集計されて --order-by の順に並べられます。上位N件を取得するには、結果をページングして集計する必要はなく、--order-by と --page-size N を指定するだけで1回の呼び出しで完結します：
adapty asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --order-by spend --page-size 5--metric は Ads Manager が追跡する指標名をダッシュボードの表記で指定します（例：spend、taps、gross_roas）。全一覧と各指標の計算方法は 指標 を参照してください。存在しない名前を指定するとエラーになり、有効な名前の一覧がエラーメッセージに表示されます。
レポート期間の長さは、最も粗い --group-by の値によって上限が決まります。より長い期間のレポートを取得するには、リクエストを複数回に分けるのではなく、グループ化の粒度を粗くしてください：
最も粗い --group-by | 最大期間 |
|---|---|
day、またはグループ化なし | 90日 |
week | 180日 |
month 以上の粒度 | 365日 |
ltv 指標はありません。ライフタイムバリューはコホート指標であり、リニューアルウィンドウで読み取られます。day-7 や day-90 の値を取得するには --by-days を使用します。
adapty asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric roas --by-days 7 --by-days 90--order-by-day は、指定したウィンドウのいずれかで行をランク付けします。これにより、1回の呼び出しで day-90 ROAS 上位のキャンペーンを取得できます。
adapty asa metrics overview
期間の合計をクエリし、時間単位でバケット化します。
adapty asa metrics overview --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --period-unit week| フラグ | 必須 | 説明 |
|---|---|---|
--entity | はい | レポート対象: campaign、ad-group、keyword、または ad |
--date-from | はい | 期間の開始日 (YYYY-MM-DD) |
--date-to | はい | 期間の終了日 (YYYY-MM-DD) |
--period-unit | いいえ | バケットサイズ: day、week、month、quarter、または year。デフォルト: day |
--metric | いいえ | 指標名。繰り返し指定可能。省略するとすべての指標を取得 |
--by-days | いいえ | コホート指標の更新ウィンドウ（日数）。繰り返し指定可能。1回の呼び出しで最大16個 |
このコマンドは、エンティティレベル全体の合計値と期間ごとの系列データを返します。つまり、「全体でいくら支出または収益があったか」を1回の呼び出しで確認できます。並び替えフラグやページネーションはありません。
このコマンドでは、--metric にはコホートルートのみ（revenue、roas、arpu）を指定できます。gross_、proceeds_、net_ のバリアントは指定できません。
レポート期間の長さは --period-unit によって制限されます：
--period-unit | 最大期間 |
|---|---|
day | 90日間 |
week | 180日間 |
month 以上の粒度 | 365日間 |
競合他社
adapty asa competitors summary
App Store アプリのセットがビッドしている Apple Ads キーワードをまとめます。ダッシュボードの Market Intelligence と同じ競合データを返します。
adapty asa competitors summary --app-ids 1668337467,6503873027| フラグ | 必須 | 説明 |
|---|---|---|
--app-ids | はい | Apple App Store ID（adam_id）、カンマ区切り。1〜5 件の値 |
レポート期間と国のセットはサーバー側で固定されています（直近の完全な月、全国対象）。このコマンドには期間・国・ページネーションのフラグはありません。
このコマンドは3つのブロックを出力します：分析のトータル、パフォーマンス上位のアプリ、最も競合が激しいキーワード。--json を追加すると完全な結果が得られ、各アプリのキーワードを国別に分解した情報も含まれます。
あるアプリセットに対する最初の呼び出しは、データの準備中に数十秒かかることがあります。同じアプリへの以降の呼び出しはより速く返ります。
エラー
| ステータス | コード | 意味 |
|---|---|---|
402 | ads_manager_subscription_required | その会社に有効な Ads Manager サブスクリプションがない |
404 | — | エンティティが存在しないか、別の会社に属している |
409 | cli_idempotency_in_progress | 同じ冪等キーを使った書き込みがまだ実行中 |
422 | cli_idempotency_key_reuse | 同じ冪等キーが別のリクエストボディで使用された |
429 | cli_analytics_busy | アナリティクスプールがビジー状態。待機時間は Retry-After ヘッダーに含まれる |
429 | cli_cooldown_active | 拒否されたリクエストが多すぎるため、トークンがクールダウン状態になっている |
指標と検索語リストは、1社あたりの分析APIバジェットを共有します。1分あたり5回の呼び出し、かつ10秒間に最大2回までです。5分以内に20件のリクエストが拒否されると、5分→30分→3時間と段階的にクールダウンが始まります。一時停止中に再試行してもクールダウンは延長されませんが、失敗したリクエストを繰り返すのではなく、修正することが解決策です。
CLIは短い待機を自動で処理します。クールダウン以外の429レスポンスで、Retry-Afterが60秒以下の場合、コマンドはその時間だけ待機してから1回リトライし、標準エラーに待機時間を出力します。