버전 1.0 / 2017년 3월
이 API를 이용하여 광고주들은 앱 세트를 만들어 캠페인의 대상이 되게 하거나 캠페인 대상에서 제외시킬 수 있습니다. 이 API는 앞으로 사라지게 될 구 Whitelist/blacklist API의 역할을 대신합니다.
이용 가능한 App targeting API
- List: 현재의 앱 리스트나 특정 목록에서 정의된 앱을 표시함
- Create: 새로운 앱 리스트를 생성
- Append: 기존 리스트에 새로운 앱을 추가
- Delete: 앱 리스트 삭제
- Delete Apps: 특정 목록에서 앱 삭제
인증(Authentication)
이 API는 요청 시 쿼리 매개변수로 받을 API key가 있어야 합니다. Management Key는 광고주 계정(Account) 페이지의 ‘keys’ 탭에서 찾을 수 있습니다. Management Key가 보이지 않으면 AppLovin 지원센터(adsupport@applovin.com)로 메일을 보내 key를 생성하기 바랍니다.
https://api.applovin.com/applists/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/
applists
/create?api_key=<API_KEY>
Create API는 URL로 인코딩 된 쿼리 매개변수로 전달하는 다음의 필드를 받습니다.
이름 |
유형 |
설명 |
필수 여부 |
name |
String |
리스트 이름 |
필수. 영숫자(alphanumeric), _-+, 또는 URL 형식으로 인코딩 된 공백이어야 함 |
description |
String |
리스트 설명 |
선택 |
응답은 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)
현재의 전체 앱 리스트 목록을 얻으려면 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
}
(App list ID가 정의된) 리스트 (List (with an app list id defined))
특정 앱 리스트 안에 있는 모든 앱 목록을 얻으려면 app_list_id 매개변수로 List API에 HTTP 요청을 보내십시오.
https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
쿼리 매개변수
이름 |
유형 |
설명 |
필수 여부 |
app_list_id |
String |
Create 또는 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":"
a0849706bd
a0849706bd
"
},
{
"application":"4326af2346b2l46e2346"
}
],
"count": 2 }
추가(Append)
기존 리스트에 앱을 추가하려면 아래로 HTTP POST를 전송하십시오.
https://api.applovin.com/applists/append?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
쿼리 매개변수
이름 |
유형 |
설명 |
필수 여부 |
app_list_id |
String |
Create 또는 List API에서 반환된 앱 목록의 ID |
필수 |
Post Body: Update API는 POST 요청을 통해 새 줄로 구분된 ID 리스트를 받아옵니다.
이름 |
유형 |
설명 |
필수 여부 |
List of apps |
List of Strings |
새 줄로 구분된 외부 앱 ID 목록 |
필수 |
응답은 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파일의 내용은 아래와 같습니다.
a0849706bd
a0849706bd
4326af2346b2l46e2346
응답 예시
{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }
삭제(Delete)
앱 리스트를 삭제하기 위해서는 아래로 HTTP 요청을 보내십시오.
https://api.applovin.com/applists/delete?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
쿼리 매개변수
이름 |
유형 |
설명 |
필수 여부 |
app_list_id |
String |
Create 또는 List API에서 반환된 앱 리스트 ID |
필수 |
Delete API에 대한 응답 바디(response body)는 없습니다. 성공하면 HTTP 응답 코드 200이 반환됩니다.
요청 예시
curl "https://api.applovin.com/applists/delete?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"
앱 삭제(리스트에서 앱 제거) (Delete Apps (Remove apps from a list))
기존 리스트에서 앱을 삭제하려면 아래로 HTTP POST를 전송하십시오.
https://api.applovin.com/applists/deleteApps?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
쿼리 매개변수
이름 |
유형 |
설명 |
필수 여부 |
app_list_id |
String |
Create또는 List API 에서 반환된 앱 리스트 ID |
필수 |
Post Body: Append API는POST 요청에서 새 줄로 구분된 ID 목록을 허용합니다.
Name |
유형 |
설명 |
필수 여부 |
List of apps |
List of Strings |
새 줄로 구분된 외부 앱 ID 목록 |
필수 |
응답은 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파일의 내용은 아래와 같습니다.
a0849706bd
a0849706bd
4326af2346b2l46e2346
응답 예시
{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }
앱 리스트에 캠페인 타게팅
앱 리스트가 생성되고 앱이 연동되고 나면, 리스트는 모든 캠페인의 Edit Targets 페이지의 Application 섹션에 옵션으로 보이게 됩니다.