버전3.0 / 2015년 3월
이 API를 이용하여 광고주들은 이용자 그룹을 만들어 캠페인의 대상으로 삼을 수 있습니다. 오디언스(이용자 그룹)는 애플의 IDFA나 안드로이드의 Advertising ID를 이용하여 생성할 수 있습니다.
이용 가능한 Audience targeting API
List: 현재 오디언스 리스트
Create: 신규 오디언스 생성
Update: 새로운 이용자 그룹으로 리스트를 업데이트. 기존의 오디언스가 새 리스트로 대체됨.
Append: 기존의 오디언스에 신규 이용자를 추가
Delete: 오디언스 삭제
인증(Authentication)
이 API는 요청 시 쿼리 매개변수로 받을 API key가 있어야만 합니다. Audience API 인증을 위해 사용되는Management Key는 광고주 account page의 ‘keys’ 탭에서 찾을 수 있습니다. Management Key가 보이지 않으면 AppLovin 지원센터(adsupport@applovin.com)으로 메일을 보내 key를 생성하기 바랍니다.
https://api.applovin.com/audiences/list?api_key=<API_KEY>
오류(Error)
Http 상태 코드는 오류를 표시하기 위해 사용됩니다.
HTTP 응답 코드
|
설명
|
200 |
성공 |
400 |
요청이 형식에 맞지 않거나, 데이터가 누락되었거나, 유효하지 않은 데이터가 있음. |
403 |
인증 실패. API key가 유효한지 확인 바람. |
404 |
명시된 App List ID가 존재하지 않음. |
406 |
생성에 있어 동일한 매개변수를 가진 액티브 오디언스가 이미 존재함. |
500 |
서비스 불가 |
생성(Create)
커스텀 오디언스(Custom Audience)를 제출하려면 먼저 빈 오디언스를 생성하십시오. 새로운 오디언스를 생성하기 위해서는 아래의 주소로 HTTP 요청을 해야 합니다.
https://api.applovin.com/audiences/create?api_key=<API_KEY>
The create API accepts the following fields passed as URL encoded query parameters
이름 |
유형 |
설명 |
필수여부 |
name |
String |
오디언스 이름 |
필수. 영숫자(alphanumeric), _-+, 또는 URL 형식으로 인코딩 된 공백이어야 함 |
package_name |
String |
소스 앱(source app)의 패키지 이름 또는 번들 ID |
audience_type=retargeting인 경우 필수 |
platform |
Enum (android, ios) |
소스 앱의 플랫폼. 반드시 “안드로이드”나 “ios”일 것. |
필수 |
description |
String |
오디언스에 대한 설명 |
선택 |
audience_type
|
Enum (ua, retargeting) |
오디언스 유형. “retargeting”이 기본값임. |
audience_type=ua인 경우 필수 |
응답은 JSON 형식으로 합니다:
이름
|
유형
|
설명
|
audience_id |
String |
Audience의 ID |
요청 예시
curl "https://api.applovin.com/audiences/create?name=My%20Audience%20Name&package_name=my.app.bundleId&platform=ios&api_key=<API_KEY>"
응답 예시
{"audience_id" : "fce0b41a0849706bd0fbbe181e61f419"}
리스트(List)
어떤 이용자에 대한 현재의 모든 오디언스 목록을 얻으려면 List API에 HTTP 요청을 보내십시오.
https://api.applovin.com/audiences/list?api_key=<API_KEY>
응답은 JSON 형식으로 합니다:
이름
|
유형
|
설명
|
code |
int |
성공 시 200 |
audiences |
List of Objects |
성공 시 200 |
audience_id |
String |
오디언스 ID |
name |
String |
오디언스 이름 |
package_name |
String |
iTunes ID 또는 소스 앱의 패키지 이름 |
platform |
Enum (android, ios) |
소스 앱의 플랫폼. 반드시 “안드로이드”나 “ios”일 것. |
description |
String |
오디언스에 대한 설명. |
user_count |
Long |
오디언스를 구성하는 이용자 수 |
count |
Long |
이용자가 속해 있는 오디언스 수 |
요청 예시
curl "https://api.applovin.com/audiences/list?api_key=<API_KEY>"
응답 예시
{
"code": 200,
"audiences": [
{
"audience_id": "dab2d1297d35592597b0eee016e92baa",
"name": "Custom Audience Test",
"package_name": "Some package name",
"platform": "ios",
"description": "Test Custom Audience",
"user_count": "10"
}
],
"count": 1
}
업데이트(Update)
오디언스에 이용자 리스트를 업로드 하기 위해서는 Update API를 이용하십시오. 오디언스에 이미 이용자 리스트가 있다면, 이 리스트는 Update API 요청 시 신규 이용자 리스트로 대체됩니다.
새로운 이용자 리스트로 오디언스를 업데이트 하려면 아래의 주소로 HTTP POST를 전송하십시오.
https://api.applovin.com/audiences/update?api_key=<API_KEY>&audience_id=<AUDIENCE_ID>&ttl_seconds=<TTL_SECONDS>
쿼리 매개변수
이름
|
유형
|
설명
|
필수여부
|
audience_id |
Long |
Create API에서 반환된 오디언스 ID |
필수
|
ttl_seconds |
Long |
이용자의 생존시간(TTL, 만료될 때까지의 시간). 기본값은 365일. |
선택
|
Post Body: Update API는 POST 요청을 통해 새 줄로 구분된 ID 리스트를 받아옵니다.
이름
|
유형
|
설명
|
필수여부
|
List of advertising ids |
List of Strings |
새 줄로 구분된 애플의 IDFA나 안드로이드의 Advertising ID 리스트. ID는 UUID 형식이어야 함. |
필수
|
응답은 JSON 형식으로 합니다:
이름 |
유형 |
설명 |
audience_id |
Long |
오디언스 ID |
num_valid_ids |
Integer |
신규 오디언스 리스트에서 유효한 Advertising ID의 수 |
num_invalid_ids |
Integer |
이 요청에서 유효하지 않은 Advertising ID의 수 |
요청 예시
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/audiences/update?audience_id=<AUDIENCE_ID>&ttl_seconds=2592000&api_key=<API_KEY>"
여기에서 userIds.txt파일의 내용은 아래와 같습니다.
c77bbe4e-6a28-11e4-bcda-14109fdf9591
f601faf5-4a83-44d6-98ef-b67c24919d39
응답 예시
{ "audience_id" :“dab2d1297d35592597b0eee016e92baa”, "num_valid_ids" : 2, "num_invalid_ids" : 0 }
추가(Append)
기존의 오디언스에 이용자를 추가하려면 Append API를 사용하십시오. 오디언스가 이미 이용자 리스트를 가지고 있다면 해당 리스트에 이용자가 추가됩니다.
기존 오디언스에 신규 이용자 리스트를 추가하려면 아래로 HTTP POST를 전송하십시오.
https://api.applovin.com/audiences/append?api_key=<API_KEY>&audience_id=<AUDIENCE_ID>&ttl_seconds=<TTL_SECONDS>
쿼리 매개변수
이름
|
유형
|
설명
|
필수여부
|
audience_id |
Long |
Create API에서 반환된 오디언스 ID |
필수
|
ttl_seconds |
Long |
이용자의 생존시간(TTL, 만료될 때까지의 시간). 기본값은 365일. |
선택
|
Post Body: Update API는 POST 요청을 통해 새 줄로 구분된 ID 리스트를 받아옵니다.
이름
|
유형
|
설명
|
필수여부
|
List of advertising ids |
List of Strings |
새 줄로 구분된 애플의 IDFA나 안드로이드의 Advertising ID 리스트. ID는 UUID 형식이어야 함. |
필수
|
응답은 JSON 형식으로 합니다:
이름
|
유형
|
설명
|
audience_id |
Long |
오디언스 ID |
num_valid_ids |
Integer |
신규 오디언스 리스트에서 유효한 Advertising ID의 수 |
num_invalid_ids |
Integer |
이 요청에서 유효하지 않은 Advertising ID의 수 |
요청 예시
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/audiences/append?audience_id=<AUDIENCE_ID>&ttl_seconds=2592000&api_key=<API_KEY>"
여기에서 userIds.txt파일의 내용은 아래와 같습니다.
c77bbe4e-6a28-11e4-bcda-14109fdf9591
f601faf5-4a83-44d6-98ef-b67c24919d39
응답 예시
{ "audience_id" : “dab2d1297d35592597b0eee016e92baa”, "num_valid_ids" : 2, "num_invalid_users" : 0 }
삭제(Delete)
오디언스를 삭제하기 위해서는 아래로 HTTP 요청을 보내십시오.
https://api.applovin.com/audiences/delete?api_key=<API_KEY>&audience_id=<AUDIENCE__ID>
여기에서 AUDIENCE_ID는 Create API에서 반환된 ID입니다.
Delete API에 대한 응답 바디(response body)는 없습니다. 성공하면 HTTP 응답 코드 200이 반환됩니다.
요청 예시
curl "https://api.applovin.com/audiences/delete?audience_id=<AUDIENCE_ID>&api_key=<API_KEY>"
팁
-오디언스 전체를 업데이트 하지 않고 오디언스에서 이용자 삭제하기: 오디언스에서 개별 이용자들을 삭제하는 방법은 없지만, 생존시간 조건을 0초로 제한하면 사실상 삭제하는 것과 같아집니다. 이를 위해 ttl_seconds=0으로 Append 요청을 하시기 바랍니다.
-API 타임아웃: 요청은 약100초가 경과하면 타임아웃 됩니다. 이는 여러분의 접속 속도와 저희 쪽의 조건에 따라, 속도가 100k 미만인 이용자들을 청크(chunk)로 배치(batch)처리하기 위해 업로드 해야 하는 일입니다. 이 API와 상호작용하는 스크립트에 Batch retry logic을 만들어 넣는 것을 권장합니다.
-오디언스에 캠페인 타게팅 하기: 오디언스가 생성되고 ID가 연동되고 나면, 오디언스는 모든 광고 가능한 캠페인의 Edit Targets 페이지의 Custom Audience 섹션에 옵션으로 보이게 됩니다. 오디언스가 어떤 캠페인에 타게팅이 가능하려면 같은 패키지 이름과 플랫폼을 공유하고 광고 유형과 오디언스 유형이 retargeting이거나, 같은 플랫폼을 공유하고 광고 유형과 오디언스 유형이user acquisition이어야 합니다.