Version 1.0 / March 2015
Suppression APIは、既存のアプリのユーザーをそのアプリのキャンペーンの対象外することができる広告主のお客様向けの機能です。AppleのIDFAまたはAndroidの広告主IDを使います。
認証
Suppression APIでは、リクエストのクエリパラメータとしてAPI Keyを提出する必要があります。Suppression APIの認証で使われるManagement Keyは広告主のお客様のアカウントページの'Keys'のタブにあります。Management Keyが表示されない場合は、お手数ですがサポートチーム(adsupport@applovin.com)までご連絡ください。
https://api.applovin.com/suppressionApps?api_key=<API_KEY>
エラー
エラー表示にはHTTPステータスコードが使用されています。
HTTPレスポンスコード
|
説明
|
200 |
成功 |
400 |
リクエストが正常に受理されませんでした。データが見つからないか、データが無効になっています。 |
403 |
認証失敗。API Keyが正しいかご確認ください。 |
500 |
サービスがご利用いただけません。 |
アップロードリクエスト
対象外とするユーザーのリストをアップロードするには、次のHTTP POSTを送ってください。
https://api.applovin.com/
suppressionApps
?api_key=<API_KEY>&package_name=<PACKAGE_NAME>
クエリパラメータ:
名称
|
タイプ
|
説明
|
必須事項
|
package_name |
String |
アプリのバンドルIDまたはパッケージ名 |
yes
|
Post Body: Update APIはPOSTリクエストにより行区切りのIDのリストを受理します
タイプ
|
説明
|
必須事項
|
List of Strings |
AppleのIDFAまたはAndroidの広告主IDの行区切りの新たなリスト。IDのフォーマットはUUIDでなければならない |
yes
|
レスポンスのフォーマットはJSONです。
名称
|
タイプ
|
説明
|
num_valid_ids |
Integer |
リクエストが成功したIDの数 |
num_invalid_ids |
Integer |
リクエストのうち、無効な広告IDの数 |
リクエスト例:
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/
suppressionApps
?api_key=<API_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 }