キャンペーン操作APIとは
DLPOでは、キャンペーンの稼働状態や期間をAPI経由で柔軟に変更することができます。
ご利用中の環境や運用フローに応じて、キャンペーンのステータスや期間を効率的に管理できます。
制限事項
- 本APIの利用には、API Keyの発行が必要です。API Keyの発行をご希望の方は、担当営業までお問い合わせください。
- APIの実行は、IP制限が可能です。DLPO管理画面の「システム設定>管理画面セキュリティ設定」よりAPI許可IPアドレスを登録すると、登録されたIPアドレスのみに制限されます。
※API Keyを発行したアカウントに対して、DLPO管理画面からAPI許可IPアドレスの設定が可能です。
事前準備
1.API Keyの準備
事前に発行されたAPI Keyをご用意ください。
2.リクエスト形式の確認
APIを利用する際は、以下のリクエストヘッダーおよびデータ形式を設定してください。
・ヘッダー
authorization: Bearer <API Key>
content-type: application/json
・リクエストボディ
JSON形式で指定してください
キャンペーン稼働/停止API
キャンペーンの稼働状態(ON/OFF)を変更するAPIです。
■APIエンドポイント
POST https://app.adlpo.com/api/campaign/change_status
■リクエスト例(Windows)
curl "https://app.adlpo.com/api/campaign/change_status" ^
-H "authorization: Bearer <API Key>" ^
-H "content-type: application/json" ^
--data-raw "{ \"id\": 1, \"status\": true }"
■パラメータ
| パラメータ名 | 内容 |
|---|---|
| id | 対象キャンペーンのID |
| status | 稼働状態(true:稼働ON、false:稼働OFF) |
キャンペーン期間変更API
キャンペーンの開始・終了日時を変更するAPIです。
■APIエンドポイント
POST https://app.adlpo.com/api/campaign/edit
■リクエスト例(Windows)
curl "https://app.adlpo.com/api/campaign/edit" ^
-H "authorization: Bearer <API Key>" ^
-H "content-type: application/json" ^
--data-raw "{\"id\": 1,\"start_date\":\"2025-07-07 00:00\",\"end_date\":\"2025-07-07 23:59\"}"
■パラメータ
| パラメータ名 | 内容 |
|---|---|
| id | 対象キャンペーンのID |
| start_date | 開始日時(形式:YYYY-MM-DD HH:MI) |
| end_date | 終了日時(形式:YYYY-MM-DD HH:MI) ※未指定の場合は、「無期限」になります |