広告主・代理店向け

キャンペーン管理API

リテールメディアのキャンペーンを作成し、配信ユニットに配信条件(広告面の種類・地域・業種・店舗・曜日と時間帯・購入内容)と入札単価(1,000回表示あたり)を設定して、審査に提出します。審査中・承認済みのキャンペーンは変更できません。organizationId に広告主アカウントのIDを指定します。代理店のトークンは、連携中のクライアントのIDを指定するとそのクライアントとして操作できます(代理店が審査に提出したキャンペーンは、クライアントの確認待ちになります)。必要なスコープは advertiser.campaigns.read(取得)と advertiser.campaigns.write(作成・変更・提出)です。


エンドポイント一覧

メソッド パス 説明 レスポンス
GET /api/v1/advertiser/campaigns キャンペーンを一覧取得
アカウントのリテールメディアキャンペーンを新しい順に返します。
200 403
GET /api/v1/advertiser/campaigns/{campaignId} キャンペーン詳細を取得
配信ユニット・配信条件・広告・到達見込みと、提出前に満たすべき項目(readiness)を返します。
200 403 404
POST /api/v1/advertiser/campaigns キャンペーンを作成
下書きとして作成します。adCategory(広告カテゴリ)は必須で、店舗はカテゴリで広告を断れます。予算は税別・円で、予算を超えて請求されることはありません。
201 400 403
PUT /api/v1/advertiser/campaigns/{campaignId} キャンペーンを変更
下書き・差し戻し中のみ変更できます。審査中・承認済みは409。
204 400 403 404 409
POST /api/v1/advertiser/campaigns/{campaignId}/units 配信ユニットを追加
作成したユニットのIDを返します。
201 400 403 404 409
PUT /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/targeting 配信条件と入札単価を設定
bidCpm は1,000回表示あたりの円(税別)。広告面の最低単価を下回る面では配信されません。
204 400 403 404 409
GET /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/reach 到達見込みを取得
条件に合う広告面・店舗の数と1日あたりの表示見込み。入札単価が最低単価に届かない面の数も返します。
200 403 404
POST /api/v1/advertiser/campaigns/{campaignId}/submit 審査に提出
提出できない場合は422で、満たしていない項目(checks)を返します。代理店として提出すると status は AwaitingClient になります。
200 403 404 422

エンドポイント詳細

アカウントのリテールメディアキャンペーンを新しい順に返します。

完全パス: GET /api/v1/advertiser/campaigns
レスポンスコード: 200 403

配信ユニット・配信条件・広告・到達見込みと、提出前に満たすべき項目(readiness)を返します。

完全パス: GET /api/v1/advertiser/campaigns/{campaignId}
レスポンスコード: 200 403 404

下書きとして作成します。adCategory(広告カテゴリ)は必須で、店舗はカテゴリで広告を断れます。予算は税別・円で、予算を超えて請求されることはありません。

完全パス: POST /api/v1/advertiser/campaigns
レスポンスコード: 201 400 403

下書き・差し戻し中のみ変更できます。審査中・承認済みは409。

完全パス: PUT /api/v1/advertiser/campaigns/{campaignId}
レスポンスコード: 204 400 403 404 409

作成したユニットのIDを返します。

完全パス: POST /api/v1/advertiser/campaigns/{campaignId}/units
レスポンスコード: 201 400 403 404 409

bidCpm は1,000回表示あたりの円(税別)。広告面の最低単価を下回る面では配信されません。

完全パス: PUT /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/targeting
レスポンスコード: 204 400 403 404 409

条件に合う広告面・店舗の数と1日あたりの表示見込み。入札単価が最低単価に届かない面の数も返します。

完全パス: GET /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/reach
レスポンスコード: 200 403 404

提出できない場合は422で、満たしていない項目(checks)を返します。代理店として提出すると status は AwaitingClient になります。

完全パス: POST /api/v1/advertiser/campaigns/{campaignId}/submit
レスポンスコード: 200 403 404 422

リクエスト例

リクエスト
POST /api/v1/advertiser/campaigns?organizationId={organizationId}
Authorization: Bearer {access_token}

{
  "name": "秋の新商品",
  "adCategory": "beverage",
  "budget": 300000,
  "dailyBudget": 20000,
  "startDate": "2026-10-01",
  "endDate": "2026-10-31"
}
レスポンス
{
  "id": "5f0c…",
  "name": "秋の新商品",
  "status": "Draft",
  "adCategory": "beverage",
  "budget": 300000,
  "dailyBudget": 20000,
  "startDate": "2026-10-01T00:00:00Z",
  "endDate": "2026-10-31T00:00:00Z"
}
認証について

このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。トークンの取得方法は認証ガイドをご確認ください。

認証・アクセスAPIを見る