adjust-icon

ブロックリスト API

AdjustブロックリストAPIは、不正あるいは期限切れのリンクによるトラフィックを阻止するために使用されます。カスタムリンクとパートナーリンクをブロックリストに登録することができます。API連携パートナー（SAN）のパートナーリンクはブロックリストに登録できません。API連携パートナーリンクからのトラフィックをブロックするには、API連携パートナーを削除する必要があります。API連携パートナーのリストは、API連携ネットワークの設定をご覧ください。

認証

ブロックリストAPIは認証にベアラートークンを使用します。ブロックリストAPIにリクエストを行う全てのリクエストには、Adjust APIトークンをAuthorizationヘッダーに含める必要があります。

自社でシングルサインオン（SSO）を有効にしている場合は、 Adjustの担当者またはsupport@adjust.comにお問い合わせください。APIトークンの取得方法についてサポートいたします。

SSO以外のアカウントの場合、APIガイドはユーザーの プロフィール に表示されます。トークンを確認するには、以下の手順に従ってください。

  1. アカウント（ユーザー）アイコンを選択します。
  2. アカウント設定（Account Settings） を選択します。
  3. マイプロフィール（My Profile） を選択します。
  4. APIトークン が ユーザー情報（User details） に表示されます。コピーボタンを選択して、トークンをクリップボードにコピーします。

Adjust APIトークンをリセットする

Adjust APIトークンはいつでもリセットできます。トークンをリセットすると、古いトークンは無効になります。Adjust APIトークンをリセットした場合、使用中の古いトークンを新しいトークンに置き換える必要があります。無効になったトークンを使用したリクエストは、Adjustによって拒否されます。

Adjust APIトークンをリセットする方法：

  1. アカウント（ユーザー）アイコンを選択します。
  2. アカウント設定（Account Settings） を選択します。
  3. マイプロフィール（My Profile） を選択します。
  4. APIトークン が ユーザー情報（User details） に表示されます。
  5. APIトークンをリセットする（Reset API token） を選択します。
  6. 表示されたモーダルにアカウントのパスワードを入力し、 リセット（Reset） を選択してAPIトークンをリセットします。画面の右上に確認メッセージが表示されます。
  7. APIトークン の横にあるコピーボタンを選択して、トークンをクリップボードにコピーします。
エンドポイント
POST https://api.adjust.com/dashboard/api/trackers/{link}/blacklist

リンクをブロックリストに登録することで、エンゲージメントとコールバックの記録を停止することができます。ブロックリストに登録されたリンクは、ユーザーが別のリンクにリアトリビュートされるまで既存のアトリビューションを保持します。

リンクをブロックリストに登録する前に記録されたクリックとインプレッションは、引き続きアトリビューションの対象となります。例えば、アトリビューション期間を7日間に設定し、2日目にリンクをブロックリストに登録した場合、Adjustは1日目のエンゲージメントをアトリビューションとして考慮します。

パラメーター

以下のパラメーターがクエリパスに含まれければなりません：

link （String）

英数字のAdjustリンクトークン

レスポンスの形式

{
   "label": "string",
   "token": "string",
   "name": "string",
   "url": "string",
   "path": "string",
   "has_subtrackers": true,
   "archived": true,
   "visible": true,
   "attribution_partner": true,
   "creative_token": "string",
   "adgroup_token": "string",
   "campaign_token": "string",
   "network_token": "string",
   "click_url": "string",
   "impression_url": "string",
   "allow_partner_linking": true,
   "settings": {
      "partner_id": "string",
      "partner_display_name": "string",
      "tracking_parameters": "string",
      "cost_data_parameters": "string",
      "cost_data": true,
      "partner_cost_data_parameters": "string",
      "campaign_structure": "string",
      "additional_parameters": "string",
      "attribution_settings": "string",
      "blacklisted": true
   },
   "urls": {
      "descendants": "string",
      "ancestors": "string",
      "update": "string",
      "show": "string",
      "archive": "string",
      "unarchive": "string"
   }
}

例

cURL
$ curl \
--header "Authorization: Token token={api_token}" \
-L -X POST "https://api.adjust.com/dashboard/api/trackers/abc123/blacklist"
成功レスポンス
{
   "label": "Twitter installs",
   "token": "abc123",
   "name": "Twitter installs",
   "url": "https://app.adjust.com/abc123",
   "path": "",
   "has_subtrackers": true,
   "archived": false,
   "visible": true,
   "attribution_partner": false,
   "creative_token": null,
   "adgroup_token": null,
   "campaign_token": null,
   "network_token": "abc123",
   "click_url": "https://app.adjust.com/abc123",
   "impression_url": "https://view.adjust.com/impression/abc123",
   "allow_partner_linking": true,
   "settings": {
      "partner_id": null,
      "partner_display_name": null,
      "tracking_parameters": null,
      "cost_data_parameters": null,
      "cost_data": false,
      "partner_cost_data_parameters": null,
      "campaign_structure": null,
      "additional_parameters": null,
      "attribution_settings": null,
      "blacklisted": true
   },
   "urls": {
      "descendants": "/api/trackers/abc123/descendants.json",
      "ancestors": "/api/trackers/abc123/ancestors.json",
      "update": "/api/trackers/abc123.json",
      "show": "/api/trackers/abc123.json",
      "archive": "/api/trackers/abc123/archive.json",
      "unarchive": "/api/trackers/abc123/unarchive.json"
   }
}
エンドポイント
POST https://api.adjust.com/dashboard/api/trackers/{link}/unblacklist

リンクは、いつでもブロックリストから解除して、再有効化することができます。リンクをブロックリストから解除すると、Adjustはエンゲージメントの計測とコールバック送信を再開します。

リンクの有効時に受信されたエンゲージメントのみが、アトリビューションファネルで考慮されます。

パラメーター

以下のパラメーターがクエリパスに含まれければなりません：

link （String）

英数字のAdjustリンクトークン

レスポンスの形式

{
   "label": "string",
   "token": "string",
   "name": "string",
   "url": "string",
   "path": "string",
   "has_subtrackers": true,
   "archived": true,
   "visible": true,
   "attribution_partner": true,
   "creative_token": "string",
   "adgroup_token": "string",
   "campaign_token": "string",
   "network_token": "string",
   "click_url": "string",
   "impression_url": "string",
   "allow_partner_linking": true,
   "settings": {
      "partner_id": "string",
      "partner_display_name": "string",
      "tracking_parameters": "string",
      "cost_data_parameters": "string",
      "cost_data": true,
      "partner_cost_data_parameters": "string",
      "campaign_structure": "string",
      "additional_parameters": "string",
      "attribution_settings": "string",
      "blacklisted": true
   },
   "urls": {
      "descendants": "string",
      "ancestors": "string",
      "update": "string",
      "show": "string",
      "archive": "string",
      "unarchive": "string"
   }
}

例

cURL
$ curl \
--header "Authorization: Token token={api_token}" \
-L -X POST "https://api.adjust.com/dashboard/api/trackers/abc123/unblacklist"
成功レスポンス
{
   "label": "Twitter installs",
   "token": "abc123",
   "name": "Twitter installs",
   "url": "https://app.adjust.com/abc123",
   "path": "",
   "has_subtrackers": true,
   "archived": false,
   "visible": true,
   "attribution_partner": false,
   "creative_token": null,
   "adgroup_token": null,
   "campaign_token": null,
   "network_token": "abc123",
   "click_url": "https://app.adjust.com/abc123",
   "impression_url": "https://view.adjust.com/impression/abc123",
   "allow_partner_linking": true,
   "settings": {
      "partner_id": null,
      "partner_display_name": null,
      "tracking_parameters": null,
      "cost_data_parameters": null,
      "cost_data": false,
      "partner_cost_data_parameters": null,
      "campaign_structure": null,
      "additional_parameters": null,
      "attribution_settings": null,
      "blacklisted": false
   },
   "urls": {
      "descendants": "/api/trackers/abc123/descendants.json",
      "ancestors": "/api/trackers/abc123/ancestors.json",
      "update": "/api/trackers/abc123.json",
      "show": "/api/trackers/abc123.json",
      "archive": "/api/trackers/abc123/archive.json",
      "unarchive": "/api/trackers/abc123/unarchive.json"
   }
}

Campaign Labで、ブロックリストに登録されているトラッカーを確認できます。次の手順に従ってください。

  1. Campaign Labに移動します。
  2. パートナーを選択すると、関連するリンクのリストが表示されます。 ブロックリストに登録されたリンクは Blocklisted と表示されます。

Campaign Labでは、ブロックリストに登録されたリンクを非表示にできます。手順については、Campaign Labの非表示リンクをご覧ください。