MACT 개요
전환 이벤트
API 참조 문서
전환 이벤트
POST conversion_event
twitter_attribution 노드는 항상 포함되며, X 기여가 없는 경우 값이 null입니다(아래 예시 응답 참조). TAP 기여가 적용되는 경우 tpn_attribution 노드가 존재하며, 해당 값으로 채워집니다. 자세한 내용은 TAP 개요를 참조하세요.
각 전환 이벤트에 연결된 메타데이터를 설정하기 위한 여러 선택적 매개변수를 사용할 수 있습니다. 이 메타데이터는 기여도 계산에 아무런 영향을 미치지 않습니다.
리소스 URL
https://ads-api.x.com/12/conversion_event
매개변수
| Name | Description |
|---|---|
| app_id required | 해당 앱 스토어에서의 고유 식별자입니다. Type: int, string Example: 333903271, com.vine.android |
| conversion_time required | 변환 이벤트가 발생한 시간으로, 밀리초가 포함된 ISO-8601 타임스탬프 형식입니다. Type: string Example: 2014-05-22T02:38:28.103Z |
| conversion_type required | 변환 이벤트의 유형입니다. Type: enum Possible values: PURCHASE, SIGN_UP, INSTALL, RE_ENGAGE, UPDATE, TUTORIAL_COMPLETE, RESERVATION, ADD_TO_CART, ADD_TO_WISHLIST, LOGIN, CHECKOUT_INITIATED, SEARCH, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, CONTENT_VIEW, SHARE, INVITE, ADDED_PAYMENT_INFO, SPENT_CREDITS, RATED |
| hashed_device_id required | HMAC_SHA-256으로 해시된 IDFA 또는 AdID입니다. Type: string Example: ABCD1234XYZ |
| os_type required | 앱의 OS 유형입니다. Type: enum Possible values: IOS, ANDROID |
| click_window optional | 이 이벤트에 대한 클릭 윈도(일 기준)입니다. Type: int 참고: click_window 값은 view_through_window 이상이어야 합니다.Default: 14 Possible values: 1, 7, 14, 30 |
| device_ip_address optional | 변환 이벤트가 발생했을 때 디바이스의 IPv4 또는 IPv6 주소입니다. Type: string Example: 192.133.78.1 |
| level optional | 이 이벤트와 연관된 레벨입니다. Type: int Example: 2 |
| non_twitter_engagement_time optional | 변환 이전에 발생한, X 외부 참여의 마지막 시간입니다. Type: string Example: 2014-05-22T02:38:28.103Z |
| non_twitter_engagement_type optional | 변환 이벤트 이전에 발생한, X 외부 참여의 유형입니다. Type: enum Possible values: CLICK, VIEW |
| number_items optional | 이 이벤트와 연관된 항목 수입니다. Type: int Example: 2 |
| price_currency optional | 이 이벤트와 연관된 통화를 나타내는 ISO 4217 코드여야 합니다. Type: String Examples: EUR,USD,JPY |
| price_micro optional | 이 이벤트와 연관된 가격(마이크로 단위)입니다. Type: int Example: 123450000 |
| user_payment_info optional | 이 이벤트와 연관된 앱에 사용자의 결제 정보가 저장되어 있는지 여부를 나타내는 불리언 값입니다. Type: bool Possible values: true or false |
| view_through_window optional | 이 이벤트의 뷰 스루 윈도(일 기준)입니다. 참고: click_window 값은 view_through_window 이상이어야 합니다.Type: int Default: 1 Possible values: 0, 1, 7, 14, 30 |
예시 요청
https://ads-api.x.com/12/conversion_event?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=1
응답 예시
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parameters
| Name | Description |
|---|---|
| account_id required | 대상 계정을 식별하는 값입니다. 이 값은 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연관되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| app_event_tag_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 원하는 App 이벤트 태그만 응답에 포함되도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: jhp |
| count optional | 각 요청마다 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지의 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순으로 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 요청 결과에 삭제된 항목도 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | 응답에 total_count 속성을 포함합니다.Note: 이 매개변수와 cursor는 동시에 사용할 수 없습니다.Note: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
요청 예시
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp
예시 응답
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id
매개변수
| Name | Description |
|---|---|
| account_id required | 레버리지 계정(leveraged account)을 식별하는 식별자입니다. 리소스의 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| app_event_tag_id required | 요청에서 사용 중인 app 이벤트 태그에 대한 참조입니다. Type: string Example: jhp |
| with_deleted optional | 삭제된 결과를 요청에 포함합니다. Type: boolean Default: false Possible values: true, false |
예제 요청
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
예시 응답
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parameters
| Name | Description |
|---|---|
| account_id required | 사용할 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 파라미터입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| app_store_identifier required | 앱 스토어 식별자입니다. Type: string Example: com.twitter.android |
| conversion_type required | 전환 이벤트의 type입니다. Type: enum Possible values: ACHIEVEMENT_UNLOCKED, ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, INSTALL, INVITE, LEVEL_ACHIEVED, LOGIN, PURCHASE, RATED, RESERVATION, RE_ENGAGE, SEARCH, SHARE, SIGN_UP, SPENT_CREDITS, TUTORIAL_COMPLETE, UPDATE |
| os_type required | 앱의 OS type입니다. Type: enum Possible values: IOS, ANDROID |
| provider_app_event_id required | 공급자 사이트의 전환 태그 ID입니다. Type: string Example: provider_tag_j5394 |
| provider_app_event_name required | 공급자 사이트의 전환 태그 이름입니다. Type: string Example: provider_name_a4382 |
| deep_link_scheme optional | 이 태그와 연결된 앱의 딥 링크 URI를 지정합니다. Type: string Example: twitter:// |
| post_engagement_attribution_window optional | 이러한 이벤트에 대한 참여 이후 전환 기여 기간입니다. Type: int Default: 30 Possible values: 1, 7, 14, 30 |
| post_view_attribution_window optional | 이러한 이벤트에 대한 노출 이후 전환 기여 기간입니다. Type: int Default: 1 Possible values: 0, 1, 7, 14, 30 |
| retargeting_enabled optional | 이 앱 이벤트 태그에 대해 리타게팅을 활성화할지 여부를 지정합니다. Type: boolean Default: true Possible values: true, false |
요청 예시
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_store_identifier=com.twitter.android&os_type=ANDROID&conversion_type=PURCHASE&provider_app_event_id=abc123&provider_app_event_name=test-tag
응답 예시
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id
매개변수
| Name | Description |
|---|---|
| account_id required | 레버리지 계정에 대한 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| id required | 요청에서 사용 중인 app event tag에 대한 참조입니다. Type: string Example: jhp |
예시 요청
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
응답 예시
App 리스트
GET accounts/:account_id/app_lists
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_lists
매개변수
| Name | Description |
|---|---|
| account_id required | 활용 중인 광고 계정의 식별자입니다. 리소스의 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연관되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| app_list_ids optional | 쉼표로 구분된 식별자 목록을 지정하여, 응답을 원하는 앱 리스트로만 한정합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: wm7x |
| count optional | 각 요청마다 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지의 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참고하세요. Type: string Example: 8x7v00oow |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순으로 정렬합니다. 자세한 내용은 Sorting을 참고하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 요청에 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 동시에 사용할 수 없습니다.Note: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200건으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
예시 요청
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x
응답 예시
GET accounts/:account_id/app_lists/:app_list_id
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parameters
| Name | Description |
|---|---|
| account_id required | 대상 계정의 식별자입니다. 이 값은 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결된 계정이어야 합니다. Type: string Example: 18ce54d4x5t |
| app_list_id required | 이 요청에서 사용하는 App 리스트를 가리키는 참조입니다. Type: string Example: 28ukf |
| with_deleted optional | 요청 결과에 삭제된 항목을 포함할지 여부입니다. Type: boolean Default: false Possible values: true, false |
예시 요청
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
응답 예시
POST accounts/:account_id/app_lists
app_list를 생성합니다.
현재 account_id당 최대 100개의 app_list 객체와 app_list당 최대 500개의 앱이 허용됩니다.
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_lists
매개변수
| Name | Description |
|---|---|
| account_id required | 대상 계정의 식별자입니다. 리소스의 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| app_store_identifiers required | app_list에 포함할 앱 스토어 식별자입니다.Type: string Example: com.twitter.android |
| name required | app_list에 지정할 이름입니다.Type: string Example: My First App List |
요청 예시
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android
응답 예시
DELETE accounts/:account_id/app_lists/:app_list_id
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parameters
| Name | Description |
|---|---|
| account_id required | 레버리지 계정의 식별자입니다. 리소스의 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| app_list_id required | 요청에서 사용 중인 앱 리스트를 참조하는 값입니다. Type: string Example: 28ukf |
요청 예시
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
응답 예시
앱 이벤트 프로바이더 구성
리소스 URL
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
매개변수
| Name | Description |
|---|---|
| account_id required | 활용할 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청마다 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| ids optional | 쉼표로 구분된 식별자 목록을 지정하여 원하는 구성만 응답에 포함되도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 25n |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순으로 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 요청에 삭제된 결과도 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 동시에 사용할 수 없습니다.Note: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200건으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
예시 요청
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n
응답 예시
GET accounts/:account_id/app_event_provider_configurations/:id
리소스 URL
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
매개변수
| Name | Description |
|---|---|
| account_id required | 레버리지 계정의 식별자입니다. 리소스의 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| id required | 요청에서 사용 중인 App 이벤트 공급자 구성에 대한 참조입니다. Type: string Example: 25n |
| with_deleted optional | 요청 결과에 삭제된 항목을 포함합니다. Type: boolean Default: false Possible values: true, false |
예제 요청
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n
응답 예시
POST accounts/:account_id/app_event_provider_configurations
리소스 URL
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
매개변수
| Name | Description |
|---|---|
| account_id required | 레버리지 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| provider_advertiser_id required | 공급자 사이트에서 사용되는 광고주의 식별자입니다. Type: string Example: client1 |
예제 요청
POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1
응답 예시
DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]
리소스 URL
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
매개변수
| Name | Description |
|---|---|
| account_id required | 레버리지드 계정의 식별자입니다. 이 값은 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| id required | 요청에서 사용 중인 app event provider 구성(app event provider configuration)에 대한 참조입니다. Type: string Example: e5g |
예시 요청
DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g
응답 예시
전환 기여도
GET conversion_attribution
twitter_attribution 노드는 항상 존재하며 값이 null이고, 아래 예시 응답에서 볼 수 있듯 기여가 있는 경우 해당 값으로 채워집니다. TAP 기여가 지정된 경우 tpn_attribution 노드가 존재하며 그에 맞게 채워집니다. 자세한 내용은 TAP 개요를 참고하세요.
리소스 URL
https://ads-api.x.com/12/conversion_attribution
Parameters
| Name | Description |
|---|---|
| app_id required | 해당 앱 스토어에서 사용하는 고유 식별자입니다. Type: int, string Example: 333903271, com.vine.android |
| conversion_time required | 밀리초까지 포함하는 ISO-8601 타임스탬프 형식의 전환 이벤트 시간입니다. Type: string Example: 2014-05-22T02:38:28.103Z |
| conversion_type required | 전환 이벤트의 유형입니다. Type: enum Possible values: ACHIEVEMENT_UNLOCKED, ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, INSTALL, INVITE, LEVEL_ACHIEVED, LOGIN, PURCHASE, RATED, RESERVATION, RE_ENGAGE, SEARCH, SHARE, SIGN_UP, SPENT_CREDITS, TUTORIAL_COMPLETE, UPDATE |
| hashed_device_id required | HMAC_SHA-256으로 해시된 IDFA 또는 AdID입니다. Type: string Example: ABCD1234XYZ |
| os_type required | 앱의 OS 유형입니다. Type: enum Possible values: IOS, ANDROID |
| click_window optional | 이 이벤트에 대한 클릭 윈도우(일 단위)입니다. Type: int Default: 14 Possible values: 1, 7, 14, 30 |
| extra_device_ids optional | hashed_device_id로 전달된 디바이스 ID의 SHA1 값을 다시 SHA256으로 해시한 값과, 추가적인 해시된 디바이스 ID입니다.Type: string Example: ABCD1234XYZ, DCBA4321XYZ |
| non_twitter_engagement_time optional | 전환 이전에 발생한 마지막 non-twitter 참여(engagement) 시간입니다. Type: string Example: 2014-05-22T02:38:28.103Z |
| non_twitter_engagement_type optional | 전환 이벤트 이전의 non-twitter 참여(engagement) 유형입니다. Type: enum Possible values: CLICK, VIEW |
| view_through_window optional | 이 이벤트에 대한 뷰 스루 윈도우(일 단위)입니다. Type: int Default: 1 Possible values: 0, 1, 7, 14, 30 |
요청 예시
GET https://ads-api.x.com/12/conversion_attribution?app_id=333903271&os_type=IOS&hashed_device_id=ABCD1234XYZ&conversion_type=INSTALL&conversion_time=2013-04-16T07:00:00.123Z&click_window=14&view_through_window=0