Version 1.0 / January 2016
Device Model Targeting APIは、キャンペーンの対象または対象外とする端末モデルのセットを作成する広告主のお客様向けの機能です。
device targeting API一覧
List –現在の端末リストまたは指定のリストの特定の端末を一覧化
Create –新規の端末リストを作成する
Append –既存リストに新たな端末を追加する
Delete –指定の端末リストを削除する
Delete Device –特定のリストから指定の端末を削除する
認証
このAPIでは、リクエストのクエリパラメータとしてAPI Keyを提出する必要があります。Audience APIとDevice Model APIの認証で使われるManagement Keyは広告主のお客様のアカウントページの'Keys'のタブにあります。Management Keyが表示されない場合は、お手数ですがサポートチーム(adsupport@applovin.com)までご連絡ください。
https://api.applovin.com/devices/list?api_key=<API_KEY>
エラー
エラー表示にはHTTPステータスコードが使用されています。
HTTPレスポンスコード
|
説明
|
200 |
成功 |
400 |
リクエストが正常に受理されませんでした。データが見つからないか、データが無効になっています。 |
403 |
認証失敗。API Keyが正しいかご確認ください。 |
404 |
指定の端末リストIDが見つかりません。 |
406 |
同じ名称で使用中のリストがすでに存在します。 |
500 |
サービスがご利用いただけません。 |
作成
アプリリストを提出するにはまず新しいリストを作成します。新規リスト作成には以下のHTTPリクエストを送信してください。
https://api.applovin.com/devices/create?api_key=<API_KEY>
create APIは、URLエンコードのクエリパラメータとして次のフィールドを受理します。
名称 |
タイプ |
説明 |
必須事項 |
name |
String |
リストの名称 |
Yes英数字で構成。_-+、またはURLエンコードのスペース |
description |
String |
リストの説明 |
no |
レスポンスのフォーマットはJSONです。
名称 |
タイプ |
説明 |
device_list_id |
String |
端末リストのID |
リクエスト例:
curl "https://api.applovin.com/devices/create?name=My%20Devices&api_key=<API_KEY>"
レスポンス例:
{"device_list_id" : "fce0b41a0849706bd0fbbe181e61f419"}
リスト
全ての最新の端末リストの一覧を入手するには、次のList APIリクエストを送ってください。
https://api.applovin.com/devices/list?api_key=<API_KEY>
レスポンスのフォーマットはJSONです。
名称 |
タイプ |
説明 |
code |
int |
200(成功) |
device_lists |
List of Objects |
端末リストに関する情報を含む対象リスト |
device_list_id |
String |
リストのID |
name |
String |
リストの名前 |
description |
String |
リストの説明 |
device_count |
Long |
リストに含まれる端末の数 |
count |
Long |
返されたリストの数 |
リクエスト例:
curl "https://api.applovin.com/devices/list?api_key=<API_KEY>"
レスポンス例:
{
"code": 200,
"device_lists": [
{
"device_list_id": "dab2d1297d35592597b0eee016e92baa",
"name": "List Test",
"description": "Test Custom Device List",
"device_count": 3
}
],
"count": 1
}
リスト(端末リストIDで指定)
指定の端末リストにある端末の一覧を入手するには、次のHTTPリクエストをdevice_list_id parameterを含めてList APIに送ってください。
https://api.applovin.com/devices/update?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
クエリパラメータ
名称 |
タイプ |
説明 |
必須事項 |
device_list_id |
String |
Create APIから返された端末リストのID |
yes |
レスポンスのフォーマットはJSONです。
名称 |
タイプ |
説明 |
code |
int |
200(成功) |
devices |
List of Objects |
リスト内の端末の一覧 |
device |
String |
端末名 |
count |
Long |
リストに含まれる端末の数 |
リクエスト例:
curl "https://api.applovin.com/devices/list?api_key=<API_KEY>&device_list_id=fce0b41a0849706bd0fbbe181e61f419"
レスポンス例:
{
"code": 200,
"devices": [
{
"device":"SM-G900F"
},
{
"device":"SM-G900FD"
}
],
"count": 2
}
追加
既存リストに端末を追加するには、次のHTTP POSTを送ってください
https://api.applovin.com/devices/append?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
注:端末名は特定のフォーマットにする必要があります。フォーマットの一覧はこちらをご覧ください。
クエリパラメータ
名称 |
タイプ |
説明 |
必須事項 |
device_list_id |
String |
Create APIまたはList APIから返された端末リストのID |
yes |
Post Body: Append APIはPOSTリクエストによる行区切りのIDのリストを受理します
名称 |
タイプ |
説明 |
必須事項 |
List of devices |
List of Strings |
行区切りの端末リスト |
yes |
レスポンスのフォーマットはJSONです。
名称 |
タイプ |
説明 |
device_list_id |
String |
端末リストのID |
processed_devices |
Integer |
リクエストのうち、有効な端末の数 |
failed_devices |
Integer |
リクエストのうち、無効な端末の数 |
リクエスト例:
curl -X POST --data-binary @devices.txt "https://api.applovin.com/devices/append?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"
devices.txtは次のような形式で記載されます。
SM-J100H
HUAWEI Y520-U03
レスポンス例:
{ "device_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_devices" : 2, "failed_devices" : 0 }
削除
端末リストを削除するには、次のようなHTTPリクエストを送ってください。
https://api.applovin.com/devices/delete?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
クエリパラメータ
名称 |
タイプ |
説明 |
必須事項 |
device_list_id |
String |
Create APIまたはList APIから返された端末リストのID |
yes |
Delete APIのレスポンス本文はありません。成功した場合は、HTTPレスポンスコードの200が返ってきます。
リクエスト例:
curl "https://api.applovin.com/devices/delete?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"
端末を削除する(リストから端末を削除)
既存リストから端末を削除するには、次のようなHTTP POSTを送ってください。
https://api.applovin.com/devices/deleteDevices?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>
クエリパラメータ
名称 |
タイプ |
説明 |
必須事項 |
device_list_id |
String |
Create APIまたはList APIから返された端末リストのID |
yes |
Post Body:Append APIは行区切りのIDのリストを受理します
名称 |
タイプ |
説明 |
必須事項 |
List of devices |
List of Strings |
行区切りの端末リスト |
yes |
レスポンスのフォーマットはJSONです。
名称 |
タイプ |
説明 |
device_list_id |
String |
端末リストのID |
processed_devices |
Integer |
リクエストのうち、有効な端末の数 |
failed_devices |
Integer |
リクエストのうち、無効な端末の数 |
リクエスト例:
curl -X POST --data-binary @devices.txt "https://api.applovin.com/devices/deleteDevices?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"
devices.txtは次のような形で記載されます。
SM-J100H
HUAWEI Y520-U03
レスポンス例:
{ "device_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_devices" : 2, "failed_devices" : 0 }
端末リストにキャンペーンをターゲティングする
端末リストが作成されると、全てのキャンペーンに関してターゲットを編集するオプションが選べるようになります。