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 コマンドはページネーションフラグも受け付けます:

フラグデフォルト説明
--page1ページ番号
--page-size1001ページあたりのアイテム数(最大: 1000)

Ads Manager のページサイズは CLI の他のコマンドよりも大きくなっています。小さいページを繰り返すより、1回で大きなページを取得することをおすすめします。

アカウントを変更するすべてのコマンドは、以下のフラグを受け付けます:

フラグ説明
--yes, -y確認なしで適用します。出力がパイプされている場合や --json を使用する場合に必須です
--idempotency-keyこの書き込み操作に使用する固定キーです。同じキーと本文で24時間以内に再実行すると、変更を再適用する代わりに保存済みの結果を返します

Ads Manager コマンドに --app フラグはありません。スコープはトークンが属するカンパニーです。--app は一部の list コマンドにフィルターとしてのみ存在します。

リストフィルター

フィルターはクエリ自体を絞り込むもので、表示ページを絞るものではありません。フィルターなしの keywords list はアカウント内のすべてのキーワードをページングするため、必要なレベルに合わせてスコープを設定してください。

フィルター受け付けるコマンド
--campaign-groupcampaigns, ad-groups, keywords, negative-keywords, search-terms, ads, creatives, product-pages
--appcampaigns, ad-groups, keywords, negative-keywords, search-terms, creatives, product-pages
--campaignad-groups, keywords, negative-keywords, search-terms, ads
--ad-groupkeywords, negative-keywords, search-terms, ads
--statuscampaigns, ad-groups, adsENABLED または PAUSED)、keywordsACTIVE または PAUSED
--searchcampaigns, ad-groups, keywords, negative-keywords, search-terms, ads。名前に対する大文字小文字を区別しない部分一致

adapty asa apps listorgs listautomations listautomations 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--waitApple Ads が接続済みと報告するまで待機します。--no-wait はすぐに返します
--timeout300ブラウザのステップを待機する秒数

adapty asa orgs list

会社で利用可能なキャンペーングループ(Apple Ads組織)を一覧表示します。

adapty asa orgs list

各行には2つの識別子が含まれており、これらは互換性がありません:

フィールド用途
internal_idcampaigns create--org フラグ、およびリストフィルター--campaign-group フラグが受け取るUUID
org_idAppleのOrganization IDの数値。どちらのフラグも受け付けません

--orgcampaigns create にのみ存在します。どのlistコマンドもこれを受け付けません。

ページネーションフラグを使用できます。

adapty asa apps list

Apple Ads でプロモートされているアプリの一覧を表示します。

adapty asa apps list

各行には2つの識別子があり、これらは互換性がありません:

フィールド使用用途
internal_id--appリストフィルターとして使用するUUID
adam_idcampaigns 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いいえ目標獲得単価(CPA)
--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

adapty asa campaigns update

既存のキャンペーンを更新します。

adapty asa campaigns update <campaign-id> --daily-budget 80 --status PAUSED
引数説明
campaign-idキャンペーン ID(UUID)
フラグ説明
--name新しいキャンペーン名
--statusENABLED または PAUSED
--country国リストを置き換えます。複数指定する場合は繰り返し使用してください
--daily-budget新しい日予算
--budget新しい通算予算
--target-cpa新しい目標獲得単価
--bidding-strategyMANUAL_CPT または MAX_CONVERSIONS
--currencyこの呼び出しで使用する金額の通貨コード。デフォルト: USD

少なくとも1つのフラグが必要です。

広告グループ

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はいデフォルト入札額(例:1.20
--cpa-goalいいえ獲得単価目標
--pricing-modelいいえCPC または CPM。Apple はすべての広告グループに設定が必要。デフォルト:CPC
--start-timeいいえスケジュール開始日(YYYY-MM-DD)。デフォルトは今日
--end-timeいいえスケジュール終了日(YYYY-MM-DD
--automated-keywords / --no-automated-keywordsいいえApple によるキーワードの自動追加を許可する
--currencyいいえこの呼び出しで使用する通貨コード。デフォルト:USD
--statusいいえ初期ステータス:ENABLED または PAUSED

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新しい広告グループ名
--statusENABLED または PAUSED
--default-bid新しいデフォルト入札額
--cpa-goal新しい目標獲得単価(CPA)
--start-timeスケジュール開始日(YYYY-MM-DD
--end-timeスケジュール終了日(YYYY-MM-DD
--automated-keywords / --no-automated-keywordsApple によるキーワードの自動追加を許可する
--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新しい入札額
--statusACTIVE または PAUSED
--match-typeBROAD または 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)
--textYesキーワードテキスト。複数指定する場合は繰り返します
--all-ad-groupsNoキャンペーン自体ではなく、キャンペーンのすべての広告グループに適用します。--campaign が必要です
--match-typeNoBROAD または EXACT。デフォルト: EXACT
--statusNoACTIVE または 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新しい広告名
--statusENABLED または 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はいレポート対象: campaignad-groupkeyword、または ad
--date-fromはい期間の開始日(YYYY-MM-DD
--date-toはい期間の終了日(YYYY-MM-DD
--metricいいえ指標名。繰り返し指定可能。省略するとすべての指標が対象になります
--group-byいいえ行を countrydayweekmonthquarter、または 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 が追跡する指標名をダッシュボードの表記で指定します(例:spendtapsgross_roas)。全一覧と各指標の計算方法は 指標 を参照してください。存在しない名前を指定するとエラーになり、有効な名前の一覧がエラーメッセージに表示されます。

レポート期間の長さは、最も粗い --group-by の値によって上限が決まります。より長い期間のレポートを取得するには、リクエストを複数回に分けるのではなく、グループ化の粒度を粗くしてください:

最も粗い --group-by最大期間
day、またはグループ化なし90日
week180日
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はいレポート対象: campaignad-groupkeyword、または ad
--date-fromはい期間の開始日 (YYYY-MM-DD)
--date-toはい期間の終了日 (YYYY-MM-DD)
--period-unitいいえバケットサイズ: dayweekmonthquarter、または year。デフォルト: day
--metricいいえ指標名。繰り返し指定可能。省略するとすべての指標を取得
--by-daysいいえコホート指標の更新ウィンドウ(日数)。繰り返し指定可能。1回の呼び出しで最大16個

このコマンドは、エンティティレベル全体の合計値と期間ごとの系列データを返します。つまり、「全体でいくら支出または収益があったか」を1回の呼び出しで確認できます。並び替えフラグやページネーションはありません。

このコマンドでは、--metric にはコホートルートのみ(revenueroasarpu)を指定できます。gross_proceeds_net_ のバリアントは指定できません。

レポート期間の長さは --period-unit によって制限されます:

--period-unit最大期間
day90日間
week180日間
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 を追加すると完全な結果が得られ、各アプリのキーワードを国別に分解した情報も含まれます。

あるアプリセットに対する最初の呼び出しは、データの準備中に数十秒かかることがあります。同じアプリへの以降の呼び出しはより速く返ります。

エラー

ステータスコード意味
402ads_manager_subscription_requiredその会社に有効な Ads Manager サブスクリプションがない
404エンティティが存在しないか、別の会社に属している
409cli_idempotency_in_progress同じ冪等キーを使った書き込みがまだ実行中
422cli_idempotency_key_reuse同じ冪等キーが別のリクエストボディで使用された
429cli_analytics_busyアナリティクスプールがビジー状態。待機時間は Retry-After ヘッダーに含まれる
429cli_cooldown_active拒否されたリクエストが多すぎるため、トークンがクールダウン状態になっている

指標と検索語リストは、1社あたりの分析APIバジェットを共有します。1分あたり5回の呼び出し、かつ10秒間に最大2回までです。5分以内に20件のリクエストが拒否されると、5分→30分→3時間と段階的にクールダウンが始まります。一時停止中に再試行してもクールダウンは延長されませんが、失敗したリクエストを繰り返すのではなく、修正することが解決策です。

CLIは短い待機を自動で処理します。クールダウン以外の429レスポンスで、Retry-Afterが60秒以下の場合、コマンドはその時間だけ待機してから1回リトライし、標準エラーに待機時間を出力します。