広告主・代理店向け
広告入稿API
配信ユニットに広告を入れます。サイネージ・デジタルレシート・アプリバナーはクリエイティブ(クリエイティブAPIでアップロード)、印刷レシート・アプリのお知らせは見出しのテキストで入稿します。デジタルレシートとアプリの広告にはクーポン(定額・定率、配布上限は必須)を付けられます。クリエイティブは入稿時に広告面の仕様(サイズ・向き・長さ)と照合されます。organizationId に広告主アカウントのIDを指定します。代理店のトークンは、連携中のクライアントのIDを指定するとそのクライアントとして操作できます(代理店が審査に提出したキャンペーンは、クライアントの確認待ちになります)。必要なスコープは advertiser.campaigns.write です。
api/v1/advertiser
在 API 參考文件中查看
端點清單
| 方法 | 路徑 | 說明 | 回應 |
|---|---|---|---|
| POST |
/api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/ads
|
広告を入稿
surfaceType は signage / receipt / printed / appbanner / appnotice。仕様に合わないクリエイティブは400で理由を返します。
|
204 400 403 404 409 |
| DELETE |
/api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/ads/{adId}
|
広告を外す
下書き・差し戻し中のみ。
|
204 403 404 409 |
端點詳細資訊
surfaceType は signage / receipt / printed / appbanner / appnotice。仕様に合わないクリエイティブは400で理由を返します。
完整路徑:
POST /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/ads
回應碼:
204
400
403
404
409
下書き・差し戻し中のみ。
完整路徑:
DELETE /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/ads/{adId}
回應碼:
204
403
404
409
請求範例
請求
POST /api/v1/advertiser/campaigns/{campaignId}/units/{unitId}/ads?organizationId={organizationId}
Authorization: Bearer {access_token}
{
"surfaceType": "receipt",
"creativeId": "c7a1…",
"destinationUrl": "https://example.com/lp",
"offer": {
"type": "FixedAmount",
"value": 100,
"validDays": 14,
"maxCoupons": 500
}
}
回應
204 No Content