APIで読み取れるもの
Gloriads APIのすべてのエンドポイント(実績と期間比較、商品、ストリーミングTV広告、キャンペーン、キーワードと広告、ルール、アクティビティ)を、パラメーター、例、数値の鮮度とともに説明します。
APIは、Gloriadsの画面と同じ数値を読み取ります。アカウントや広告を変更することはありません。
エンドポイント
| エンドポイント | 返す内容 |
|---|---|
GET /api/v1/account | サブスクリプション、Amazon Adsが接続されているかどうか、数値がどの日までそろっているか。最初に呼び出してください。 |
GET /api/v1/marketplaces | 接続済みのマーケットプレイスと、それぞれの通貨、運用中のキャンペーン・広告グループ・広告の数。 |
GET /api/v1/summary | 期間の合計。ダッシュボードのタイルと同じで、マーケットプレイス別・広告タイプ別の内訳も含みます。 |
GET /api/v1/timeline | 同じ数値を日ごと、または月ごとに。ダッシュボードのグラフと同じです。 |
GET /api/v1/reports/products | 期間中の広告対象商品ごとの数値。商品ページと同じです。 |
GET /api/v1/reports/streaming-tv | 1つのマーケットプレイスのストリーミングTV広告のキャンペーンと、その数値。 |
GET /api/v1/campaigns | 1つのマーケットプレイスのキャンペーンと、その予算、ターゲティング、ステータス。 |
GET /api/v1/ad-groups | 1つのマーケットプレイスの広告グループと、そのデフォルトの入札額。 |
GET /api/v1/targets | 1つのキャンペーンのキーワードやその他のターゲットと、そのマッチタイプ、入札額。 |
GET /api/v1/ads | 1つのキャンペーンの広告と、その広告対象商品。 |
GET /api/v1/rules | ルール:オンかオフか、対象範囲、スケジュール、前回の実行。 |
GET /api/v1/rules/{rule_id}/runs | 1つのルールの直近20回の実行。 |
GET /api/v1/activity | GloriadsがAmazonで行ったすべてのこと(新しい順)。 |
GET /api/v1/activity/{operation_id} | 1つの操作。 |
GET /api/v1/activity/{operation_id}/lines | 1つの操作が作成・変更・アーカイブしたものを、1行ずつ。 |
すべてのパラメーターとフィールドはAPIリファレンスに掲載されており、Try itボタンで試せます。
期間
/summary、/timeline、/reports/productsは、ある期間を対象にします。次のどちらか一方を送ってください。
| パラメーター | 例 | 意味 |
|---|---|---|
range | last_30_days | today、yesterday、last_7_days、last_14_days、last_30_days、last_60_days、last_90_days、this_month、last_month、this_year、last_year、all_time |
start_date + end_date | 2026-09-01と2026-09-30 | 2つの日付(両日を含む)。間隔は最大6年です |
- 何も送らない場合は、ダッシュボードと同じく
last_30_daysになります。 rangeが対象にするのは、ダッシュボードが合計するのと同じ終わった日だけです。last_30_daysは昨日までの30日間で、this_monthとthis_yearも昨日で終わります。Amazonはクリックから数日後に売上を計上するため、今日の数値は常に途中です。todayは今日です。毎月1日のthis_monthも今日になります(まだ終わった日がないため)。all_timeは、Gloriadsが保持しているもっとも古い日から今日までで、ダッシュボードの全期間と同じです。- 今日を含めるには、
start_dateとend_dateを送り、end_dateを今日の日付にします。 - 「今日」がどの日かは、
timezone(Europe/Paris、America/New_York…)で決まります。初期値はUTCです。 - どのレスポンスも、対象の日付を
periodで示します。
2つの期間を比較する
/summary、/timeline、/reports/productsにcompareを追加します。ダッシュボードの比較対象と同じです。
compare | 比較の対象 |
|---|---|
previous_period | 直前の同じ日数。今月のここまでの日数は先月の同じ日数と、先月はその前の月と比較します。 |
same_period_last_year | 1年前の同じ日付。 |
レスポンスにはcomparisonが加わります。比較期間の数値と、広告費、売上、ACOS、インプレッション数、クリック数、CPC、購入数のそれぞれの増減が含まれます。
"changes": {
"spend": { "kind": "change", "percent": 18.2, "direction": "up", "tone": "neutral" },
"acos": { "kind": "change", "percent": -6.5, "direction": "down", "tone": "good" }
}- どちらの期間も昨日で終わります。ダッシュボードと同じです。今日を含む日付からは今日が除かれ、そのことが
periodに示されます。 kind: "new"は、以前の数値が0だったことを意味します。kind: "none"は、比較できるものがないこと(売上のないACOS)を意味します。toneは、ダッシュボードの色と同じく、良い変化かどうかを示します。広告費は常にneutralです。all_timeより前の期間はなく、todayには終わった日がありません。その場合は、comparisonのunavailableに理由が示されます。- 比較期間の履歴をGloriadsが保持していない場合、その数値は
nullになり、history_coveredはfalseになります。
絞り込み
| パラメーター | 例 | 絞り込む対象 |
|---|---|---|
marketplaces | US,UK | これらの国だけ(GBも使えます) |
ad_products | SPONSORED_PRODUCTS | SPONSORED_PRODUCTS、SPONSORED_BRANDS、SPONSORED_DISPLAYのいずれか |
不明な値は、その値を示した400で拒否されます。ゼロの数値が返されることはありません。
期間の合計
curl "https://gloriads.com/api/v1/summary?range=last_month&marketplaces=US" \
-H "Authorization: Bearer YOUR_API_KEY"{
"period": { "start_date": "2026-09-01", "end_date": "2026-09-30", "range": "last_month", "timezone": "UTC" },
"currency": "USD",
"spend": 13140.53,
"sales": 46562.2,
"acos": 28.22,
"roas": 3.54,
"impressions": 3945723,
"clicks": 13973,
"ctr": 0.35,
"average_cpc": 0.94,
"purchases": 1479,
"conversion_rate": 10.58,
"by_marketplace": [ … ],
"by_ad_product": [ … ],
"meta": { "data_last_date": "2026-10-09", "history_covered": true, "truncated": false }
}acos、ctr、conversion_rateはパーセントです。28.22は28.22%を意味します。purchasesは、コンソールの購入数と同じく注文の件数で、個数ではありません。- 基準となる値がない比率(売上のないACOS)は
nullで、0にはなりません。
日ごと・月ごと
/timelineは同じ期間と絞り込みを受け付け、1日ごと、または1か月ごとのデータポイントをdataに返します。
granularity=auto(初期値)は、ダッシュボードのグラフと同じく、92日までは日ごと、それより長い期間は月ごとを選びます。- 92日より長い期間では、
granularity=dayは拒否されます。 - 数値が1つもない日は含まれません。
商品ごと
/reports/productsは、広告対象商品(ASIN)ごとに1行を返し、sort(初期値はspend)とorder(初期値はdesc)で並べ替えます。
product_id: nullの行には、Amazonがどの商品にも結び付けていないもの(主にスポンサーブランド広告)がまとめられます。titleは、Amazonの商品レポートが示す商品名です。期間中に最も多く広告費を使ったマーケットプレイスでの名前になります。product_id: nullの行ではnullです。Gloriadsがアカウントの商品名をまだAmazonから受け取っていない間もnullになります。- 行はページに分かれて返されます。制限とエラーをご覧ください。
ストリーミングTV広告
ほかのレポートには、ダッシュボードと同じく、ストリーミングTV広告(Prime Videoやストリーミングアプリで流れるテレビ広告)が含まれません。Amazonが、それらの元になるレポートにストリーミングTV広告を含めていないためです。/reports/streaming-tvは、別のAmazonのレポートから、1つのマーケットプレイスについて読み取ります。
curl "https://gloriads.com/api/v1/reports/streaming-tv?marketplace_id=3478512345678901&range=last_30_days" \
-H "Authorization: Bearer YOUR_API_KEY"- 期間は最大31日間で、過去95日以内に限られます。このレポートに対するAmazonの制限です。
- ある期間に対する最初の呼び出しでは、Amazonがレポートを作成している間、
"status": "pending"が返されることがあります。通常は数分です。meta.retry_after_secondsの秒数が過ぎてから、もう一度呼び出してください。作成されたレポートは3時間保持されます。 - 各キャンペーンには、広告費、インプレッション数、
cpm(1,000インプレッションあたりのコスト)、クリック数、売上、購入数、units_soldが含まれます。 - 金額は米ドルではなく、そのマーケットプレイスの通貨で示されます。
"status": "unavailable":AmazonがこのアカウントにストリーミングTV広告を提供していません。たとえばKDP著者のアカウントです。
キャンペーンと広告グループ
どちらもmarketplace_idが必要です。/marketplacesが返すidを指定します。
curl "https://gloriads.com/api/v1/campaigns?marketplace_id=3478512345678901&states=ENABLED" \
-H "Authorization: Bearer YOUR_API_KEY"- スポンサープロダクト広告、スポンサーブランド広告、ディスプレイ広告の、有効なキャンペーンと一時停止中のキャンペーンを一覧表示します。アーカイブ済みのキャンペーンは表示されません。
- 予算と入札額は、そのマーケットプレイスの通貨で示されます(
/marketplacesのcurrency_code)。 provenanceは、そのキャンペーンをGloriadsが作成したか、変更したか、一度も触れていないかを示します。/ad-groups?campaign_id=…で、1つのキャンペーンの広告グループだけに絞り込めます。- 1ページあたり最大1,000行です(初期値は100)。
キーワード・ターゲット・広告
/targetsと/adsは、1つのキャンペーンの中にあるものを一覧表示します。どちらもmarketplace_idとcampaign_idが必要です。ad_group_idを指定すると、そのうち1つの広告グループに絞り込めます。
curl "https://gloriads.com/api/v1/targets?marketplace_id=3478512345678901&campaign_id=28430987654321" \
-H "Authorization: Bearer YOUR_API_KEY"/targetsは、各キーワードとそのmatch_type(EXACT、PHRASE、BROAD)、商品ターゲット(ASIN)、カテゴリー、オートターゲティンググループ、除外キーワードと除外ターゲットを、それぞれのbidとステータスとともに一覧表示します。bid: nullは、広告グループのデフォルトの入札額で入札することを意味します。/adsは、各広告と、その広告対象商品(product_ids)を一覧表示します。- どちらもリクエストした時点でAmazonから読み取られ、数値は含まれません。
- スポンサープロダクト広告、スポンサーブランド広告、ディスプレイ広告が対象です。アーカイブ済みのものは表示されません。
- 1ページあたり最大1,000行です(初期値は100)。
ルールとアクティビティ
/rulesは、すべてのルールを最近編集した順に一覧表示します。/rules/{rule_id}/runsは、直近の各実行が何を確認し、何を変更したかを示します。テストは含まれません。/activityは、GloriadsがAmazonで実行したすべての操作を一覧表示します。キャンペーンの作成やコピー、商品の追加、ルールによる変更、元に戻す操作などです。ルールの1回の実行は、マーケットプレイスごとに1回ずつ、同じrule_run_idで表示されます。tool=ruleを指定すると、ルールによる操作だけが残ります。/activity/{operation_id}は、1つの操作を読み取ります。実行中の操作の進み具合を追うには、これを繰り返し呼び出してください。/activity/{operation_id}/linesは、その操作が行ったことを1行ずつ一覧表示します。対象(キャンペーン、広告グループ、広告、ターゲット)、作成・変更・アーカイブのどれか、各値の変更前と変更後、そして失敗した行についてはAmazonのエラーです。1ページあたり最大500行です。ルールの1回の実行には、5,000行が含まれることもあります。
数値の鮮度
- ダッシュボードと同じ数値です。同じデータを、同じコードで読み取っています。
- 実績の金額は米ドルです。各マーケットプレイスの数値はAmazonが換算します。
- Amazonはクリックの数日後に売上を計上します。そのため、期間の最後の数日の数値は、しばらく増え続けます。数値がどの日までそろっているかは、
meta.data_last_dateでわかります。 - キャンペーンは、マーケットプレイスごとに最大で30分に1回、Amazonから読み取られます。いつ読み取ったかは
meta.synced_atでわかります。あるマーケットプレイスに対する最初の呼び出しでは、一覧が空でmeta.syncing: trueが返されることがあります。1分後にもう一度呼び出してください。 - 商品の数値は1日に1回更新されます。Gloriadsが保持している履歴より前に始まる期間では、
meta.history_covered: falseが返されます。 - キーワード、ターゲット、広告は、呼び出しのたびにAmazonから直接読み取られます。いつ読み取ったかは
meta.read_atでわかります。 - ストリーミングTV広告の数値は、Amazonがレポートを作成してから3時間保持されます。いつ作成されたかは
meta.report_ready_atでわかります。