連携 & APIキー - Ad Control Help Center

概要

コンソールの [設定] > [連携] メニューでは、Adrop外部連携に必要な設定をすべて管理します。

APIキー: Open API呼び出し、リワード広告SSVコールバックの復号に使用
リワード広告SSV: 報酬完了時にサーバーへ送信されるコールバックURLの設定 — リワード広告SSVドキュメントを参照

連携メニューは、プロジェクトの**オーナー（owner）**権限を持つメンバーのみアクセスできます。

APIキーの発行

連携メニューへ移動

コンソールの [設定] > [連携] メニューに移動します。

キー情報の入力

APIキーセクションで**[APIキーを作成]**ボタンをクリックし、以下の情報を入力します。

項目	説明
キー名	用途を識別できる名前（例：「レポート連携」）。1～100文字で入力してください。
スコープ	1つ以上の選択が必須です。許可された権限の範囲のみ呼び出せます。キーの発行後は変更できません。

プロジェクトごとにアクティブなAPIキーは最大10個まで発行できます。上限に達した場合は、使用していないキーを取り消してから新しいキーを発行してください。

キーのコピーと保管

生成されたAPIキーをコピーし、安全に保管します。

APIキーは生成直後に1回だけ確認できます。ウィンドウを閉じると再表示できないため、必ずコピーして安全な場所に保管してください。

権限範囲（Scope）

権限	説明
`report:read`	キャンペーンレポートおよびバックフィル収益データの照会
`context-targeting:read`	コンテキストターゲティング、ターゲティングオプション、コンテキストIDの取得
`context-targeting:write`	コンテキストターゲティング、ターゲティングオプション、コンテキストIDの作成・更新・削除
`campaign:read`	予約済みキャンペーン情報の取得
`campaign:subscribe`	キャンペーン予約Webhookの登録・取得・削除

現在Open APIで利用できるのは、レポートAPI、コンテキストターゲティングAPI、キャンペーン予約Webhookです。コンテキストターゲティングAPIを使うにはcontext-targeting:readとcontext-targeting:writeの両方を、キャンペーン予約Webhookを使うにはcampaign:readとcampaign:subscribeの両方を付与してください。context-targeting:read、context-targeting:write、campaign:subscribeはキーの作成時に初期状態で選択されていないため、自分で選択してください。

Open API呼び出し

基本情報

項目	値
Base URL	`https://lake.adrop.io`
プロトコル	HTTPS
認証方式	API Key（`x-api-key`ヘッダー）

認証

すべてのAPIリクエストにx-api-keyヘッダーを含める必要があります。

curl -X POST https://lake.adrop.io/report \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{...}'

APIキーは外部に共有しないでください。キーが漏洩した場合は、直ちに取り消して新しいキーを発行してください。

APIキーの管理

キー一覧の確認

連携メニューのAPIキーセクションで、発行済みのAPIキー一覧を確認できます。

表示項目	説明
キー名	キー作成時に入力した名前。名前の下に表示されるキーIDをクリックするとコピー（キーIDはAPIキー自体ではありません）
APIキー	prefix（例：`adrop_7kF2`）のみ表示、以降はマスキング
スコープ	付与された権限の数（ツールチップで全体を確認）
作成日	キーが作成された日付

スコープの変更

発行済みのAPIキーのスコープは変更できません。必要なスコープで新しいキーを発行し、連携中のサービスを新しいキーに切り替えてから、既存のキーを取り消してください。

キーの取り消し

使用しなくなったキーは、右側メニューの [取り消し] で即座に取り消せます。

取り消されたAPIキーは即座に認証がブロックされます。そのキーを使用中のシステムでAPI呼び出しが失敗する可能性がありますので、取り消す前に連携中のサービスがないか確認してください。

リワード広告SSVに連携されたAPIキーは取り消せません。SSVで別のAPIキーに変更するか、SSV設定を削除してから再度お試しください。

リワード広告SSV

報酬完了時にサーバーへ送信されるSSVコールバックURLの登録とペイロードの復号

レポートAPI

キャンペーン成果およびバックフィル収益データをAPIで照会する方法

コンテキストターゲティングAPI

サーバーからコンテキストターゲティングのオプションとコンテキストIDを管理する方法

キャンペーン予約Webhook

予約済みキャンペーンの変更を受け取り、取得する方法

​概要

​APIキーの発行

​権限範囲（Scope）

​Open API呼び出し

​基本情報

​認証

​APIキーの管理

​キー一覧の確認

​スコープの変更

​キーの取り消し

​関連ドキュメント

リワード広告SSV

レポートAPI

コンテキストターゲティングAPI

キャンペーン予約Webhook

概要

APIキーの発行

権限範囲（Scope）

Open API呼び出し

基本情報

認証

APIキーの管理

キー一覧の確認

スコープの変更

キーの取り消し

関連ドキュメント