Suppression API

<p class=“text-gray-400”>Version 1.1 / August 2024</p>

広告主はSuppression APIを使用して、既存のアプリユーザーがアプリキャンペーンによってターゲティングされないようにします。このAPIでは、ユーザーのサプレッションの有効化または無効化をサポートしています。 iOSではIDFA、AndroidではGAIDを使用してユーザーを識別できます。

リクエスト形式

このAPIを使用して、以下のベースURLのいずれかにHTTPリクエストを作成します。

このAPIを使用するには、リクエスト内にクエリパラメーター（api_key）としてAPI キーを含める必要があります。

https://api.applovin.com/suppressionApps?api_key=«management-key»
https://api.applovin.com/deleteSuppressionApps?api_key=«management-key»

このManagement Keyは、アカウントページのKeysタブで確認できます。Management Keyが表示されない場合は、こちらでサポートチケットを発行し、キーの生成をリクエストしてください。

ユーザーのリストをサプレッションリストに追加するには、HTTPPOSTリクエストを以下に送信してください。

https://api.applovin.com/suppressionApps?api_key=«management-key»&package_name=«package-name»

サプレッションリストからユーザーのリストを削除するには、HTTPPOSTリクエストを以下に送信してください。

https://api.applovin.com/deleteSuppressionApps?api_key=«management-key»&package_name=«package-name»

名前	タイプ	説明	必須
`package_name`	String	アプリのバンドルID（iOS）またはパッケージ名（Android）	はい

このAPIは、POSTリクエストで改行で区切られたIDのリストを受け取ります。

タイプ	説明	必須
List of Strings	AppleのIDFAまたはAndroidのGAIDの改行区切りリスト。IDはUUID形式である必要があります。	はい

レスポンスはJSONフォーマットです。

名前	タイプ	説明
`num_valid_ids`	Integer	このリクエストで正常に処理されたIDの数
`num_invalid_ids`	Integer	このリクエスト内の無効な広告IDの数

このAPIはHTTPステータスコードを返すことでエラーを示します。

HTTPレスポンスコード	説明
200	成功。
400	リクエストが正しくフォーマットされていません。データがないか、無効なデータが含まれていました。
403	認証に失敗しました。APIキーが有効なものかどうか確認してください。
500	サービスが利用できません。

ユーザーを追加するためのリクエストの例：

curl -X POST --data-binary @userIds.txt "https://api.applovin.com/suppressionApps?api_key=«management-key»&package_name=com.machinezone.gow"

ユーザーを削除するためのリクエストの例：

curl -X POST --data-binary @userIds.txt "https://api.applovin.com/deleteSuppressionApps?api_key=«management-key»&package_name=com.machinezone.gow"

ファイルuserIds.txtの内容は以下のとおりです。

c77bbe4e-6a28-11e4-bcda-14109fdf9591
f601faf5-4a83-44d6-98ef-b67c24919d39

{
  "num_valid_ids": 2,
  "num_invalid_ids": 0
}