マーケティング分析担当向け

広告レポートAPI

リテールメディア広告の配信実績を取得します。表示回数・クリック・広告費・クーポン配布と利用・配信店舗数を、日別・広告面の種類別・店舗別・キャンペーン別に返し、キャンペーンごとの売上リフト(配信がなかった場合の見込みとの差の推計)も含みます。店舗数や利用件数が少ない区分の購入額は、個人の特定を防ぐため返しません。organizationId に広告主アカウントのIDを指定します。代理店のトークンは、連携中のクライアントのIDを指定するとそのクライアントとして操作できます(代理店が審査に提出したキャンペーンは、クライアントの確認待ちになります)。必要なスコープは advertiser.reports.read です。


端點清單

方法 路徑 說明 回應
GET /api/v1/advertiser/reports 配信レポートを取得
from・to(日本時間の日付、両端を含む、最大366日。省略時は直近30日)。campaignId で1つのキャンペーンに絞れます。
200 400 403 404

端點詳細資訊

from・to(日本時間の日付、両端を含む、最大366日。省略時は直近30日)。campaignId で1つのキャンペーンに絞れます。

完整路徑: GET /api/v1/advertiser/reports
回應碼: 200 400 403 404

請求範例

請求
GET /api/v1/advertiser/reports?organizationId={organizationId}&from=2026-09-01&to=2026-09-30
Authorization: Bearer {access_token}
回應
{
  "from": "2026-09-01",
  "to": "2026-09-30",
  "totals": {
    "impressions": 125000,
    "clicks": 3400,
    "ctrPercent": 2.72,
    "spend": 62500,
    "redemptions": 280,
    "couponSalesYen": 412000,
    "stores": 18
  },
  "campaigns": [
    {
      "campaignId": "5f0c…",
      "name": "秋の新商品",
      "spend": 62500,
      "lift": { "extraYen": 186000, "deliveringStores": 18, "controlStores": 40 }
    }
  ]
}
關於驗證

使用此 API 需要 Authorization: Bearer {access_token} 標頭。取得權杖的方式請參閱驗證指南。

查看驗證與存取 API