オーディエンスAPIの概要

1. 概要

Tapjoy オーディエンスAPI はリターゲティングおよび拒否リストとして使用できるオーディエンスの情報を作成および取得するためのREST API です。また、デリターゲティング(App Suppression)デバイスのリストとして使用することもできます。

A. デリターゲティング(App Suppression)

デリターゲティング(App Suppression)とは、提供されたリストにあるデバイスには指定したApp IDがすでにインストールされていると認識することをさします。この情報は通常のネットワークやSDKから得られる情報以外のものがある場合に使用します。たとえば、広告主がアプリをすでにインストールしていることがわかっているデバイスのリストをアップロードし、Tapjoyがそのアプリについての広告オファーをユーザーに見せないようにします。

B. 拒否リスト

拒否リストは提供されたリストにあるデバイスには指定したオファーを表示しないようにします。これはそのデバイスにアプリがインストールされているか否かを問わないため、デリターゲティング(App Suppression)とは異なります。あるオファーの拒否リストに指定されたデバイスに、同じアプリの別のオファーが表示されることもあり得ます。

C. リターゲティング

リターゲティングを使用して、パブリッシャーは特定のデバイスのリストに広告を表示するようにできます。

2. リクエストの作成

APIリクエストを作成するには、まずOAuth APIを使ってアクセストークンを取得する必要があります。取得方法の詳細についてはこちらをご参照ください。

A. 必須パラメータと必要な値

account_id - 広告主のアカウントID

name - オーディエンスの名前

description - オーディエンスの説明

devices - デバイスIDのCSVファイル。このCSVにヘッダ行は含めないでください。デバイスIDはIDFAおよび GAIDで、ハイフンを含めても除いても構いません。バックエンド側で正規化されます。

offer_id - リターゲティングまたは拒否リストに関連付ける、Tapjoy の offer_id (または AdSet ID)。

app_id - デリターゲティングに使用したい Tapjoy のアプリのapp_id 。

list_type - リスト種別で、Audience API にこのリクエストの目的がリターゲティングなのか、拒否リストなのか、デリターゲティング(App Suppression)七日を指定します。

list_typeに指定可能な値: ['retarget', 'denylist', 'app_suppression']。

指定する値はこの3つのオプションのうち一つのみです。

注: これらのパラメータ(全部で7つ) はAPIのリクエストに必要ですが、必ずしも各パラメータの値をすべて設定しなければならないわけではありません。

追記: 各呼び出しは同じAPIエンドポイントを使用します。

エンドポイント

https://api.tapjoy.com/v4/audiences

B. リクエストの例

POST /v4/audiences 
Host: api.tapjoy.com 
Authorization: Bearer <token_string> 
Accept: application/json

リターゲティング

account_id: '51a1d60a-0af4-449d-ac12-72f43846c146' 
name: 'foo' 
description: 'This is our foo audience for retargeting' 
devices: device_list.csv 
offer_id: 'bdc9b48c-3e7b-4347-9c56-161fd227e9c8' 
app_id: ' ' (リターゲティングでは空白にする)
list_type: 'retarget'

拒否リスト

account_id: '5a4e87ac-119f-4181-91c7-fce4f8542cee' 
name: 'bar'
description: 'This is our foo audience for deny-list' 
devices: device_list_2.csv 
offer_id: 'a5e24cb9-de37-4755-bca8-66ad36c63f23'
app_id: ' ' (拒否リストでは空白にする)
list_type: 'denylist'

curl --header "Content-Type: text/csv" --header "Authorization: Bearer your-token-here" --request POST --data-binary "/path/to/test.csv" https://api.tapjoy.com/v4/audiences?account_id=974b39c7-7e69-4584-af5e-a159ad29a0e7&app_id=e774b012-c560-40b0-8be1-dcda55d694e4&description=foo&devices=test.csv&list_type=app_suppression&name=bar&offer_id=

デリターゲティング(App Suppression)

account_id: '497670f6-a152-4bdd-a717-dbe7f7635dc7' 
name: ' ' 
description: ' ' 
devices: device_list_3.csv 
offer_id: ' ' (デリターゲティングでは空白にする)
app_id: '6881899b-9c55-4d83-9afc-552f880289d4' 
list_type: 'app_suppression'

3. FAQ

リターゲティング、拒否リストまたはデリターゲティング(App Suppression)用のオーディエンスはどれくらいの頻度でアップロードしてよいのか?

特に制限はありません(たとえば、毎時間など)。

アップロード可能なデバイスのリストの行の上限は?

APIはデフォルトでは100万台のデバイスを上限としています。より多くのデータを送りたい場合はご相談ください。

二つのファイルをアップロードした場合(たとえば、list_one.csvとlist_two.csv)、リストは置き換えられるのか、それとも結合されるのか?

デリターゲティング(App Suppression) - CSVのすべてのデバイスは指定されたアプリをインストールしたとマークされます。結果として二つのリストを送ると結合したのと同じ効果になります。 拒否リスト - リストは置き換えられます。 リターゲティング - リストは置き換えられます。

リストを削除できますか?

デリターゲティング(App Suppression) - できません。一度デバイスに指定されたアプリがインストールされたとマークされた場合、Tapjoyにユーザーがアプリをアンインストールしたと伝えることはできません。デバイスをリストから削除したい場合には、拒否リストを使用してください。 拒否リスト - 空のリストをアップロードしてください。 リターゲティング - 空のリストをアップロードしてください。

このAPIを使用して自動的にデータを送れるMMPはありますか?

Appsflyer。

オーディエンスAPIの概要
1. 概要
2. リクエストの作成
3. FAQ