Version 1.0 / March 2017

このAPIは、キャンペーンでターゲットにするまたは除外するアプリの一覧を作成できる広告主のお客様向けの機能です。

アプリターゲティングAPI一覧

List – 現在のアプリリスト、または特定のリストの特定のアプリを表示する
Create  – 新しいアプリリストを作成する
Append  – 既存のリストに新たなアプリを加える
Delete  – 特定のアプリリストを削除する

Delete Apps  –特定のリストの特定のアプリを削除する

認証

このAPIでは、リクエストのクエリパラメータとして付与されるAPI Keyが必要になります。広告主のお客様向けのアカウントページで、'Keys'のタブからManagement Keyを選んでください。Management Keyが表示されない場合は、お手数ですがサポートチーム（adsupport@applovin.com）までご連絡ください。

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

エラー

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

HTTPレスポンスコード	説明
200	成功
400	リクエストが正常に受理されませんでした。データが見つからないか、データが無効になっています。
403	認証失敗。API Keyが正しいかご確認ください。
404	指定のApp List IDが見つかりません。
406	同じ名称で使用中のリストがすでに存在します。
500	サービスがご利用いただけません。

 

作成

アプリリストを提出するにはまず新しいリストを作成します。新規リスト作成には以下のHTTPリクエストを送信してください。

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

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

名称	タイプ	説明	必須事項
name	String	リストの名称	Yes英数字で構成。_-+、またはURLエンコードのスペース
description	String	リストの説明	No

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

名称	タイプ	説明
app_list_id	String	オーディエンスのID

リクエスト例：

curl "https://api.applovin.com/applists/create?name=High%20Perfoming%20Apps&api_key=<API_KEY>"

レスポンス例：

{"app_list_id" : "fce0b41a0849706bd0fbbe181e61f419"}

リスト

現在のアプリリストの全てのリストを入手するにはList APIにHTTPリクエストを送ってください。  

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

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

名称	タイプ	説明
code	int	200（成功）
app_lists	List of Objects	アプリリストに関する情報を含む対象リスト
app_list_id	String	リストのID
name	String	リストの名前
description	String	リストの説明
app_count	Long	リストに含まれるアプリの数
count	Long	返されたリストの数

リクエスト例：

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

レスポンス例：

{
"code": 200,
"app_lists": [
{
"app_list_id": "dab2d1297d35592597b0eee016e92baa",
"name": "High Performing Apps",
"description": "Apps that exceed our ROAS goals",
"app_count": 3
}
],
"count": 1
}

リスト（アプリリストIDで指定）

特定のアプリリストにある全てのアプリの一覧を入手するには、List APIにapp_list_idのパラメータと共にHTTPリクエストを送ってください。

https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=<APP_LIST_ID> 

クエリパラメータ：

名称	タイプ	説明	必須事項
app_list_id	String	Create APIまたはList APIから返されたアプリリストのID	yes

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

名称	タイプ	説明
code	int	200（成功）
apps	List of Objects	リストに含まれるアプリ一覧
application	String	外部アプリID
count	Long	リストに含まれるアプリの数

リクエスト例：

curl "https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=fce0b41a0849706bd0fbbe181e61f419"

レスポンス例：

{
"code": 200,
"apps": [
{
"application":"a0849706bda0849706bd"
},
{
"application":"4326af2346b2l46e2346"
}
], 
"count": 2 }

追加

既存リストにアプリを追加するにはHTTP POSTを次のように送ってください。

https://api.applovin.com/applists/append?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>

クエリパラメータ

名称	タイプ	説明	必須事項
app_list_id	String	Create APIまたはList APIから返されたアプリリストのID	yes

Post Body:  Append APIはPOSTリクエストによる行区切りのIDのリストを受理します

名称	タイプ	説明	必須事項
List of apps	List of Strings	行区切りの外部アプリIDのリスト	yes

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

名称	タイプ	説明
app_list_id	String	アプリリストのID
processed_apps	Integer	リクエストのうち、有効なアプリの数
failed_apps	Integer	リクエストのうち、無効なアプリの数

リクエスト例：

curl -X POST --data-binary @apps.txt "https://api.applovin.com/applists/append?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"

apps.txtは以下のような形で記載されます。

a0849706bda0849706bd

4326af2346b2l46e2346

レスポンス例：

{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }

削除:

既存リストからアプリを削除する場合は次のようにHTTPリクエストを送ってください。

https://api.applovin.com/applists/delete?api_key=<API_KEY>&app_list_id=<APP_LIST_ID> 

クエリパラメータ：

名称	タイプ	説明	必須事項
app_list_id	String	Create APIまたはList APIから返されたアプリリストのID	yes

Delete APIのレスポンス本文はありません。成功した場合は、HTTPレスポンスコードの200が返ってきます。

リクエスト例

curl "https://api.applovin.com/applists/delete?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"

アプリ削除（リストからアプリを削除）

既存リストからアプリを削除する場合は次のようにHTTP POSTを送ってください。

https://api.applovin.com/applists/deleteApps?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>

クエリパラメータ

名称	タイプ	説明	必須事項
app_list_id	String	Create APIまたはList APIから返されたアプリリストのID	yes

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

名称	タイプ	説明	必須事項
List of apps	List of Strings	行区切りの外部アプリIDのリスト	yes

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

名称	タイプ	説明
app_list_id	String	アプリリストのID
processed_apps	Integer	当該リクエストでリストから削除されたアプリの数
failed_apps	Integer	リクエストのうち、無効なアプリの数

リクエスト例：

curl -X POST --data-binary @apps.txt "https://api.applovin.com/applists/deleteApps?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"

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

a0849706bda0849706bd

4326af2346b2l46e2346

レスポンス例：

{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }

アプリリストでキャンペーンをターゲティングする

アプリリストが作成されると、全てのキャンペーンに関してターゲットを編集するオプションが選べるようになります。