Descripción general de MACT
Eventos de conversión
Referencia de la API
Evento de conversión
POST conversion_event
twitter_attribution siempre estará presente y tendrá un valor de null cuando no haya atribución de X (consulta el ejemplo de respuesta a continuación). Si se asigna atribución de TAP, estará presente un nodo tpn_attribution y se rellenará en consecuencia. Consulta la descripción general de TAP para obtener más información.
Hay varios parámetros opcionales disponibles para establecer metadatos asociados con cada evento de conversión. Estos metadatos no tienen ningún efecto en los cálculos de atribución.
URL del recurso
https://ads-api.x.com/12/conversion_event
Parámetros
| Nombre | Descripción |
|---|---|
| app_id required | El identificador único correspondiente en la tienda de aplicaciones. Tipo: int, string Ejemplo: 333903271, com.vine.android |
| conversion_time required | La hora del evento de conversión en formato de marca de tiempo ISO-8601, con milisegundos añadidos. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| conversion_type required | El tipo de evento de conversión. Tipo: enum Valores posibles: 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 | El IDFA o AdID con hash HMAC_SHA-256. Tipo: string Ejemplo: ABCD1234XYZ |
| os_type required | El tipo de sistema operativo (OS) para la aplicación. Tipo: enum Valores posibles: IOS, ANDROID |
| click_window optional | La ventana de clic para este evento en días. Tipo: int Nota: click_window debe ser mayor o igual que view_through_windowPredeterminado: 14 Valores posibles: 1, 7, 14, 30 |
| device_ip_address optional | Dirección IPv4 o IPv6 del dispositivo cuando ocurrió el evento de conversión. Tipo: string Ejemplo: 192.133.78.1 |
| level optional | Un nivel asociado a este evento. Tipo: int Ejemplo: 2 |
| non_twitter_engagement_time optional | La hora de la última interacción fuera de X antes de la conversión. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| non_twitter_engagement_type optional | El tipo de interacción fuera de X previa al evento de conversión. Tipo: enum Valores posibles: CLICK, VIEW |
| number_items optional | Número de elementos asociados a este evento. Tipo: int Ejemplo: 2 |
| price_currency optional | Se espera que sea un código ISO 4217 que indique la moneda asociada con este evento. Tipo: string Ejemplos: EUR, USD, JPY |
| price_micro optional | Un importe asociado a este evento en microunidades. Tipo: int Ejemplo: 123450000 |
| user_payment_info optional | Un valor booleano que indica si la información de pago del usuario está almacenada en la aplicación asociada con este evento. Tipo: bool Valores posibles: true o false |
| view_through_window optional | La ventana de visualización (view-through) para este evento en días. Nota: click_window debe ser mayor o igual que view_through_window.Tipo: int Predeterminado: 1 Valores posibles: 0, 1, 7, 14, 30 |
Ejemplo de solicitud
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
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| app_event_tag_ids optional | Limita la respuesta solo a las etiquetas de eventos de App deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: jhp |
| count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud independiente. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: 8x7v00oow |
| sort_by optional | Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: created_at-asc |
| with_deleted optional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | Incluye el atributo de respuesta total_count.Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.Type: boolean Default: false Possible values: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:app_event_tag_id
Parámetros
| Nombre | Descripción |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| app_event_tag_id required | Una referencia a la etiqueta de evento de App que se utiliza en la solicitud. Type: string Example: jhp |
| with_deleted optional | Incluir los resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parámetros
| Nombre | Descripción |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| app_store_identifier required | El identificador de la tienda de aplicaciones. Type: string Example: com.twitter.android |
| conversion_type required | El tipo de evento de conversión. 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 | El tipo de sistema operativo de la app. Type: enum Possible values: IOS, ANDROID |
| provider_app_event_id required | El ID de la etiqueta de conversión en el sitio del proveedor. Type: string Example: provider_tag_j5394 |
| provider_app_event_name required | El nombre de la etiqueta de conversión en el sitio del proveedor. Type: string Example: provider_name_a4382 |
| deep_link_scheme optional | Especifica el URI de deep link para la app asociada con esta etiqueta. Type: string Example: twitter:// |
| post_engagement_attribution_window optional | La ventana de atribución post-engagement para estos eventos. Type: int Default: 30 Possible values: 1, 7, 14, 30 |
| post_view_attribution_window optional | La ventana de atribución posterior a la visualización para estos eventos. Type: int Default: 1 Possible values: 0, 1, 7, 14, 30 |
| retargeting_enabled optional | Especifica si se debe habilitar el retargeting para esta etiqueta de evento de app. Type: boolean Default: true Possible values: true, false |
Ejemplo de solicitud
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
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, salvo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| id required | Una referencia a la etiqueta de evento de App con la que estás trabajando en la solicitud. Tipo: string Ejemplo: jhp |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Respuesta de ejemplo
Listas de Apps
GET accounts/:account_id/app_lists
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| app_list_ids optional | Limita la respuesta únicamente a las listas de apps deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: wm7x |
| count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: 200 Mín., Máx.: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
| sort_by optional | Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: created_at-asc |
| with_deleted optional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: true, false |
| with_total_count optional | Incluye el atributo de respuesta total_count.Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.Tipo: boolean Predeterminado: false Valores posibles: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?app_list_ids=wm7x
Ejemplo de respuesta
GET accounts/:account_id/app_lists/:app_list_id
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| app_list_id obligatorio | Una referencia a la lista de apps con la que estás operando en la solicitud. Type: string Example: 28ukf |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Ejemplo de respuesta
POST accounts/:account_id/app_lists
app_list asociada a la cuenta actual.
Actualmente existe un límite de 100 objetos app_list por account_id y 500 Apps por app_list.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: 18ce54d4x5t |
| app_store_identifiers required | Los identificadores de la tienda de aplicaciones que se incluirán en la app_listType: string Example: com.twitter.android |
| name required | El nombre que asignarás a la app_listType: string Example: My First App List |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists?name=app list&app_store_identifiers=com.twitter.android
Ejemplo de respuesta
DELETE accounts/:account_id/app_lists/:app_list_id
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists/:app_list_id
Parameters
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| app_list_id required | Una referencia a la lista de Apps con la que estás trabajando en la solicitud. Type: string Example: 28ukf |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Ejemplo de respuesta
Configuraciones del proveedor de eventos de la App
URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parameters
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Tipo: int Predeterminado: 200 Mín., máx.: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
| ids optional | Limita la respuesta únicamente a las configuraciones deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 identificadores. Tipo: string Ejemplo: 25n |
| sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: created_at-asc |
| with_deleted optional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: true, false |
| with_total_count optional | Incluye el atributo de respuesta total_count.Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.Tipo: boolean Predeterminado: false Valores posibles: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?ids=25n
Ejemplo de respuesta
GET accounts/:account_id/app_event_provider_configurations/:id
URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parameters
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| id required | Una referencia a la configuración del proveedor de eventos de App que usas en la solicitud. Type: string Example: 25n |
| with_deleted optional | Incluye los resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/25n
Ejemplo de respuesta
POST accounts/:account_id/app_event_provider_configurations
URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| provider_advertiser_id required | El identificador del anunciante en el sitio del proveedor. Tipo: string Ejemplo: client1 |
Ejemplo de solicitud
POST https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations?provider_advertiser_id=client1
Ejemplo de respuesta
DELETE accounts/:account_id/app_event_provider_configurations/:id[¶]
URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| id obligatorio | Una referencia a la configuración del proveedor de eventos de la App con la que operas en la solicitud. Tipo: string Ejemplo: e5g |
Ejemplo de solicitud
DELETE https://ads-api.x.com/11/accounts/18ce54d4x5t/app_event_provider_configurations/e5g
Ejemplo de respuesta
Atribución de conversiones
GET conversion_attribution
twitter_attribution siempre estará presente y tendrá un valor de null cuando no haya atribución de X, y se completará como se muestra en el ejemplo de respuesta más abajo. Si se indica atribución de TAP, habrá un nodo tpn_attribution presente y se completará en consecuencia. Consulta la descripción general de TAP para obtener más información.
URL del recurso
https://ads-api.x.com/12/conversion_attribution
Parámetros
| Nombre | Descripción |
|---|---|
| app_id required | El identificador único correspondiente en la tienda de aplicaciones. Tipo: int, string Ejemplo: 333903271, com.vine.android |
| conversion_time required | La hora del evento de conversión en formato de marca de tiempo ISO-8601, incluyendo milisegundos. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| conversion_type required | El tipo de evento de conversión. Tipo: enum Valores posibles: 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 | El IDFA o AdID con hash HMAC_SHA-256. Tipo: string Ejemplo: ABCD1234XYZ |
| os_type required | El tipo de sistema operativo para la aplicación. Tipo: enum Valores posibles: IOS, ANDROID |
| click_window optional | La ventana de clic para este evento, en días. Tipo: int Valor predeterminado: 14 Valores posibles: 1, 7, 14, 30 |
| extra_device_ids optional | Un SHA256 del SHA1 del ID de dispositivo enviado en hashed_device_id, más cualquier ID de dispositivo adicional con hash.Tipo: string Ejemplo: ABCD1234XYZ, DCBA4321XYZ |
| non_twitter_engagement_time optional | La hora de la última interacción fuera de X anterior a la conversión. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| non_twitter_engagement_type optional | El tipo de interacción fuera de X anterior al evento de conversión. Tipo: enum Valores posibles: CLICK, VIEW |
| view_through_window optional | La ventana de visualización para este evento, en días. Tipo: int Valor predeterminado: 1 Valores posibles: 0, 1, 7, 14, 30 |
Ejemplo de solicitud
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