Audience Targeting API

Audience APIは、広告主のお客様がキャンペーンでターゲットにするユーザーのセットを作成できるツールです。AppleのIDFAまたはAndroidの広告IDを使って作成します。

Audience Targeting API一覧

List – 現在のオーディエンスを一覧化

Create –新たなオーディエンスを作成

Update –新たなユーザーグループを追加してオーディエンスリストを更新する。既存のユーザーリストを新たなオーディエンスに置き換えます

Append  –既存のオーディエンスに新たなユーザーを追加する

Delete  –指定のオーディエンスを削除する

認証:

全てのAudience Targeting APIについて、リクエストパラメータでAPI Keyを提出する必要があります。Audience APIの認証で使われるManagement Keyは広告主のお客様のアカウントページの'Keys'のタブにあります。Management Keyが表示されない場合は、お手数ですがサポートチーム（adsupport@applovin.com）までご連絡ください。

https://api.applovin.com/audiences/list?api_key=<API_KEY>

エラー

エラー表示にはHTTPステータスコードが使用されています。

作成

カスタムオーディエンスを提出するにはまず新しいオーディエンスを作成します。新規オーディエンス作成には以下のHTTPリクエストを送ってください。

https://api.applovin.com/audiences/create?api_key=<API_KEY>

Create APIは、URLエンコードのクエリパラメータとして次のフィールドを受理します。

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

リクエスト例

curl "https://api.applovin.com/audiences/create?name=My%20Audience%20Name&package_name=my.app.bundleId&platform=ios&api_key=<API_KEY>"

レスポンス例：

{"audience_id" : "fce0b41a0849706bd0fbbe181e61f419"}

リスト

全ての最新のオーディエンスのリストを入手するにはList APIにHTTPリクエストを送ってください。

https://api.applovin.com/audiences/list?api_key=<API_KEY>

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

リクエスト例：

curl "https://api.applovin.com/audiences/list?api_key=<API_KEY>"

レスポンス例：

{
	"code": 200,
	"audiences": [
		{
			"audience_id": "dab2d1297d35592597b0eee016e92baa",
			"name": "Custom Audience Test",
			"package_name": "Some package name",
			"platform": "ios",
			"description": "Test Custom Audience",
			"user_count": "10"
		}
	],
	"count": 1
}

アップデート

特定のオーディエンスのユーザーリストをアップロードするには、Update APIを使います。オーディエンスにすでに既存のユーザーリストがある場合、Update APIリクエストにあるユーザーリストと置き換えられます。

オーディエンスを新たなユーザーリストでアップデートするには、次のようなHTTP POSTを送ってください。

https://api.applovin.com/audiences/update?api_key=<API_KEY>&audience_id=<AUDIENCE_ID>&ttl_seconds=<TTL_SECONDS>

クエリパラメータ：

Post Body:  Update APIは行区切りのPOSTリクエストのIDリストを受理します。

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

リクエスト例：

curl -X POST --data-binary @userIds.txt "https://api.applovin.com/audiences/update?audience_id=<AUDIENCE_ID>&ttl_seconds=2592000&api_key=<API_KEY>"

userIds.txtは次のような形で記載されます。

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

レスポンス例：

{ "audience_id" :“dab2d1297d35592597b0eee016e92baa”, "num_valid_ids" : 2, "num_invalid_ids" : 0 }  

追加

既存のオーディエンスにユーザーを追加するには、Append APIを使います。オーディエンスにすでに既存のユーザーリストがある場合、ユーザーはそのリストに追加されます。

オーディエンスに新たなユーザーを追加するには、次のHTTP POSTを送ってください。

https://api.applovin.com/audiences/append?api_key=<API_KEY>&audience_id=<AUDIENCE_ID>&ttl_seconds=<TTL_SECONDS>

クエリパラメータ：

Post Body:  Update APIは行区切りのPOSTリクエストのIDリストを受理します。

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

リクエスト例：

curl -X POST --data-binary @userIds.txt "https://api.applovin.com/audiences/append?audience_id=<AUDIENCE_ID>&ttl_seconds=2592000&api_key=<API_KEY>"

userIds.txtの内容は次のような形になります。

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

レスポンス例：

{ "audience_id" : “dab2d1297d35592597b0eee016e92baa”, "num_valid_ids" : 2, "num_invalid_users" : 0 }

削除

オーディエンスを削除する場合は、次のHTTPリクエストを送ってください。

https://api.applovin.com/audiences/delete?api_key=<API_KEY>&audience_id=<AUDIENCE__ID>

curl "https://api.applovin.com/audiences/delete?audience_id=<AUDIENCE_ID>&api_key=<API_KEY>"

機能活用のヒント

- オーディエンス全体をアップデートすることなく、オーディエンスからユーザーを削除するには：オーディエンスから個々のユーザーを削除する方法はありませんが、基準を0秒まで下げて事実上削除されたような状態にすることはできます。この場合、ttl_seconds=0でAppend APIをコールしてください。

- APIのタイムアウト：リクエストには約100秒のタイムアウトがあります。お使いの接続環境やサービスの状況により、最大10万ユーザーのアップロード当たり必要になる時間です。再取得のバッチを実装しておくことをおすすめします。

- オーディエンスにキャンペーンをターゲティングする：オーディエンスが作成されてIDが紐づけば、Edit TargetページのCustom Audienceのセクションにキャンペーンの対象の選択肢として選べるようになります。キャンペーンのタイプやオーディエンスのタイプがリターゲティングの場合で同じパッケージ名やプラットフォームを共有していれば、オーディエンスをそのキャンペーンの対象とすることができます。また、キャンペーンのタイプやオーディエンスのタイプがユーザー獲得の場合で同じプラットフォームを共有していても、オーディエンスをそのキャンペーンの対象とすることができます。

• AppLovin Audiences.postman_collection.json6 KB