버전 1.0 / 2016년 1월
이 API를 이용하여 광고주들은 디바이스 모델 집합을 만들어 캠페인의 대상이 되게 하거나 캠페인 대상에서 제외시킬 수 있습니다.
이용 가능한 디바이스 타게팅 API
List: 현재의 디바이스 리스트나 특정 목록에서 정의된 디바이스
Create: 새로운 디바이스 리스트를 생성
Append: 기존 리스트에 새 디바이스를 추가
Delete: 디바이스 리스트 삭제
Delete Device: 특정 목록에서 디바이스 삭제
인증(Authentication)
이 API는 요청 시 쿼리 매개변수로 받을 API key가 있어야 합니다.Management Key는 광고주 계정(Account) 페이지의 ‘keys’ 탭에서 찾을 수 있습니다. Management Key가 보이지 않으면 AppLovin 지원센터(adsupport@applovin.com)으로 메일을 보내 key를 생성하기 바랍니다.
https://api.applovin.com/devices/list?api_key=<API_KEY>오류(Errors)
Http 상태 코드는 오류를 표시하기 위해 사용됩니다.
|
HTTP응답 코드 |
설명 |
|
200 |
성공 |
|
400 |
요청이 형식에 맞지 않거나, 데이터가 누락되었거나, 유효하지 않은 데이터가 있음. |
|
403 |
인증 실패. API key가 유효한지 확인 바람. |
|
404 |
명시된 App List ID가 존재하지 않음. |
|
406 |
생성에 있어 동일한 이름을 가진 액티브 리스트가 이미 존재함. |
|
500 |
서비스 불가 |
생성(Create)
디바이스 리스트를 제출하려면 먼저 빈 리스트를 생성하십시오. 새로운 리스트를 생성하기 위해서는 아래로 HTTP 요청을 해야 합니다.
https://api.applovin.com/devices/create?api_key=<API_KEY>Create API는 URL로 인코딩 된 쿼리 매개변수로 전달하는 다음의 필드를 받습니다.
|
이름 |
유형 |
설명 |
필수여부 |
|
name |
String |
리스트 이름 |
필수. 영숫자(alphanumeric), _-+, 또는 URL 형식으로 인코딩 된 공백이어야 함. |
|
description |
String |
리스트 설명 |
선택 |
응답은 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)
현재의 모든 디바이스 리스트에 대한 목록을 얻으려면 List API에 HTTP 요청을 보내십시오.
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를 가진) 리스트 (List (with device list ID)
특정 디바이스 리스트 안에 있는 모든 디바이스 목록을 얻으려면 device_list_id 매개변수로 List API에 HTTP 요청을 보내십시오.
https://api.applovin.com/devices/update?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID> 쿼리 매개변수
|
이름 |
유형 |
설명 |
필수여부 |
|
device_list_id |
String |
create API 에서 반환된 디바이스 목록의 ID |
필수 |
응답은 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
}추가(Append)
기존 리스트에 디바이스를 추가하려면 아래로 HTTP POST를 전송하십시오.
https://api.applovin.com/devices/append?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>주의: 기기명은 특정 형식을 따라야 합니다. 이 링크를 통해 해당 형식을 확인할 수 있습니다.
쿼리 매개변수
|
이름 |
유형 |
설명 |
필수여부 |
|
device_list_id |
String |
Create 또는 List API에서 반환된 디바이스 목록의 ID |
필수 |
Post Body: Update API는 POST 요청을 통해 새 줄로 구분된 ID 리스트를 받아옵니다.
|
이름 |
유형 |
설명 |
필수여부 |
|
List of devices |
List of Strings |
새 줄로 구분된 디바이스 목록 |
필수 |
응답은 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 }삭제(Delete)
디바이스 리스트를 삭제하기 위해서는 아래로 HTTP 요청을 보내십시오.
https://api.applovin.com/devices/delete?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID> 쿼리 매개변수
|
이름 |
유형 |
설명 |
필수여부 |
|
device_list_id |
String |
Create또는 List API 에서 반환된 디바이스 리스트 ID |
필수 |
Delete API에 대한 응답 바디(response body)는 없습니다. 성공하면 HTTP 응답 코드 200이 반환됩니다.
요청 예시
curl "https://api.applovin.com/devices/delete?device_list_id=<DEVICE_LIST_ID>&api_key=<API_KEY>"디바이스 삭제(리스트에서 디바이스 제거) (Delete Devices(Remove devices from a list)
기존 리스트에서 디바이스를 삭제하려면 아래로 HTTP POST를 전송하십시오.
https://api.applovin.com/devices/deleteDevices?api_key=<API_KEY>&device_list_id=<DEVICE_LIST_ID>쿼리 매개변수
|
이름 |
유형 |
설명 |
필수여부 |
|
device_list_id |
String |
Create 또는 List API 에서 반환된 디바이스 리스트 ID |
필수 |
Post Body: Update API는 POST 요청을 통해 새 줄로 구분된 ID 리스트를 받아옵니다.
|
이름 |
유형 |
설명 |
필수여부 |
|
List of devices |
List of Strings |
새 줄로 구분된 디바이스 목록 |
필수 |
응답은 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 }디바이스 리스트에 캠페인 타게팅(Targeting Campaigns to a Device List)
디바이스 리스트가 생성되고 디바이스가 리스트에 연동되고 나면, 리스트는 모든 광고의 Edit Targets 페이지의 Custom Devices 섹션에 옵션으로 보이게 됩니다.
