広告主向け
広告・販促API
広告クリエイティブの登録・検索・管理を行います。キャンペーンに紐づく広告の配信状態やステータスをAPI経由で操作できます。
api/v1/advertiser/ads
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/advertiser/ads/{id}
|
広告詳細を取得
特定の広告クリエイティブまたは配置の詳細を取得します。
|
200 404 |
| GET |
/api/v1/advertiser/ads/search
|
広告を検索
キャンペーン、ステータス、キーワードで広告を検索します。
|
200 |
| POST |
/api/v1/advertiser/ads/
|
広告を作成・更新(Upsert)
IDが指定されない場合は新規作成、既存の場合は更新します。
|
200 |
| DELETE |
/api/v1/advertiser/ads/{id}
|
広告を削除
指定IDの広告を削除します。
|
204 404 |
エンドポイント詳細
特定の広告クリエイティブまたは配置の詳細を取得します。
完全パス:
GET /api/v1/advertiser/ads/{id}
レスポンスコード:
200
404
キャンペーン、ステータス、キーワードで広告を検索します。
完全パス:
GET /api/v1/advertiser/ads/search
レスポンスコード:
200
IDが指定されない場合は新規作成、既存の場合は更新します。
完全パス:
POST /api/v1/advertiser/ads/
レスポンスコード:
200
指定IDの広告を削除します。
完全パス:
DELETE /api/v1/advertiser/ads/{id}
レスポンスコード:
204
404
リクエスト例
リクエスト
GET /api/v1/advertiser/ads/search?campaignId=camp-001&status=active
Authorization: Bearer {access_token}
レスポンス
{
"results": [
{
"id": "ad-001",
"name": "春のセールバナー",
"campaignId": "camp-001",
"status": "active",
"impressions": 12500,
"clicks": 340
}
]
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。