Descripción general de MACT
Eventos de conversión
Referencia de API
Evento de conversión
POST conversion_event
Registra un evento de conversión de medición móvil. La respuesta indicará atribución de X o de X Audience Platform (TAP). Esto se relaciona con el endpoint GET 95. En la respuesta se indicará atribución de X, de TAP o ninguna. El nodotwitter_attribution siempre estará presente y tendrá el valor null cuando no haya atribución de X (consulta el ejemplo de respuesta a continuación). Si se reclama atribución de TAP, habrá un nodo tpn_attribution y se completará en consecuencia. Consulta la introducción a 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 afectan los cálculos de atribución.
URL del recurso
https://ads-api.x.com/12/conversion_event
Parámetros
| Nombre | Descripción |
|---|---|
| app_id obligatorio | El identificador único en la tienda de apps correspondiente. Tipo: int, string Ejemplo: 333903271, com.vine.android |
| conversion_time obligatorio | La hora del evento de conversión en formato de marca de tiempo ISO-8601, con milisegundos. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| conversion_type obligatorio | 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 obligatorio | El IDFA o AdID con hash HMAC_SHA-256. Tipo: string Ejemplo: ABCD1234XYZ |
| os_type obligatorio | El tipo de sistema operativo de la App. Tipo: enum Valores posibles: IOS, ANDROID |
| click_window opcional | 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 opcional | Dirección IPv4 o IPv6 del dispositivo cuando ocurrió el evento de conversión. Tipo: string Ejemplo: 192.133.78.1 |
| level opcional | Un nivel asociado con este evento. Tipo: int Ejemplo: 2 |
| non_twitter_engagement_time opcional | La hora de la última interacción fuera de X previa a la conversión. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| non_twitter_engagement_type opcional | El tipo de interacción fuera de X previa al evento de conversión. Tipo: enum Valores posibles: CLICK, VIEW |
| number_items opcional | Número de artículos asociados con este evento. Tipo: int Ejemplo: 2 |
| price_currency opcional | Código ISO 4217 que indica la moneda asociada con este evento. Tipo: String Ejemplos: EUR, USD, JPY |
| price_micro opcional | Un monto de precio asociado a este evento en micros. Tipo: int Ejemplo: 123450000 |
| user_payment_info opcional | Valor booleano que indica si la información de pago del usuario está almacenada en la App asociada con este evento. Tipo: bool Valores posibles: true o false |
| view_through_window opcional | La ventana de visualización 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
GET accounts/:account_id/app_event_tags
Recupera los detalles de algunas o todas las etiquetas de eventos de App asociadas a la cuenta actual. Estas etiquetas definen las ventanas de conversión configuradas para cada tipo de conversión en el seguimiento de conversiones de Apps móviles.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la API de Anunciantes, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| app_event_tag_ids opcional | Limita la respuesta a las etiquetas de eventos de App deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id. Tipo: string Ejemplo: jhp |
| count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: 200 Mín., Máx.: 1, 1000 |
| cursor opcional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: 8x7v00oow |
| sort_by opcional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: created_at-asc |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: true, false |
| with_total_count opcional | 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 frecuencia más bajos, actualmente establecidos en 200 por 15 minutos.Tipo: boolean Predeterminado: false Valores posibles: 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
GET accounts/:account_id/app_event_tags/:app_event_tag_id
Recupera una etiqueta de evento de App específica asociada a la cuenta actual. Estas definen las ventanas de conversión configuradas para cada tipo de conversión en el seguimiento de conversiones de Apps móviles.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 obligatorio | El identificador de la cuenta apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| app_event_tag_id obligatorio | Referencia a la etiqueta de evento de App con la que operas en la solicitud. Tipo: string Ejemplo: jhp |
| with_deleted opcional | Incluye los resultados eliminados en tu solicitud. Tipo: boolean Valor predeterminado: false Valores posibles: true, false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Ejemplo de respuesta
POST accounts/:account_id/app_event_tags
Crea una nueva etiqueta de evento de App asociada a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| app_store_identifier obligatorio | El identificador de la tienda de Apps. Tipo: string Ejemplo: com.twitter.android |
| conversion_type obligatorio | 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 |
| os_type obligatorio | El tipo de SO de la App. Tipo: enum Valores posibles: IOS, ANDROID |
| provider_app_event_id obligatorio | El id de la etiqueta de conversión en el sitio del proveedor. Tipo: string Ejemplo: provider_tag_j5394 |
| provider_app_event_name obligatorio | El nombre de la etiqueta de conversión en el sitio del proveedor. Tipo: string Ejemplo: provider_name_a4382 |
| deep_link_scheme opcional | Especifica el URI de deep link para la App asociada con esta etiqueta. Tipo: string Ejemplo: twitter:// |
| post_engagement_attribution_window opcional | La ventana de atribución post-engagement para estos eventos. Tipo: int Predeterminado: 30 Valores posibles: 1, 7, 14, 30 |
| post_view_attribution_window opcional | La ventana de atribución post-view para estos eventos. Tipo: int Predeterminado: 1 Valores posibles: 0, 1, 7, 14, 30 |
| retargeting_enabled opcional | Indica si el retargeting debe estar habilitado para esta etiqueta de evento de App. Tipo: boolean Predeterminado: true Valores posibles: 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
DELETE accounts/:account_id/app_event_tags/:id
Elimina la etiqueta de evento de la App especificada que pertenece a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_event_tags/:id
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| id obligatorio | Una referencia a la etiqueta de evento de la App con la que operas en la solicitud. Tipo: string Ejemplo: jhp |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_event_tags/jhp
Ejemplo de respuesta
Listas de Apps
GET accounts/:account_id/app_lists
Obtén detalles de algunas o todas las listas de App asociadas a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/app_lists
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| app_list_ids opcional | Limita la respuesta a las listas de App deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id. Tipo: string Ejemplo: wm7x |
| count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: 200 Mín., máx.: 1, 1000 |
| cursor opcional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: 8x7v00oow |
| sort_by opcional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: created_at-asc |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: true, false |
| with_total_count opcional | 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 frecuencia más bajos, actualmente establecidos en 200 por 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
Obtén una lista de Apps específica asociada a la cuenta actual.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 apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio en 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_id obligatorio | Una referencia a la lista de Apps con la que operas en la solicitud. Tipo: string Ejemplo: 28ukf |
| with_deleted opcional | Incluye los resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: 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
Crea unaapp_list asociada a la cuenta actual.
Actualmente, hay 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
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| app_store_identifiers obligatorio | Los identificadores de la tienda de apps que se incluirán en app_list.Tipo: string Ejemplo: com.twitter.android |
| name obligatorio | El nombre que asignarás a app_list.Tipo: string Ejemplo: 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
Elimina la lista de Apps especificada asociada a la cuenta actual.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 apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| app_list_id obligatorio | Una referencia a la lista de App con la que se opera en la solicitud. Tipo: string Ejemplo: 28ukf |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/app_lists/28ukf
Respuesta de ejemplo
Configuración de proveedores de eventos de App
GET accounts/:account_id/app_event_provider_configurations¶
Obtén los detalles de algunas o todas las configuraciones del proveedor de eventos de App (configuración principal para el seguimiento de conversiones en aplicaciones móviles) asociadas a la cuenta actual.URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud independiente. Tipo: int Predeterminado: 200 Mín., máx.: 1, 1000 |
| cursor opcional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: 8x7v00oow |
| ids opcional | Limita la respuesta a las configuraciones deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id. Tipo: string Ejemplo: 25n |
| sort_by opcional | Ordena por un atributo compatible en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: created_at-asc |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: true, false |
| with_total_count opcional | 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 frecuencia 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
Recupera un id específico de las configuraciones del proveedor de eventos (configuración básica para el seguimiento de conversiones en Apps móviles) asociadas con la cuenta actual.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 apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| id obligatorio | Una referencia a la configuración del proveedor de eventos de App con la que operas en la solicitud. Tipo: string Ejemplo: 25n |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Valor predeterminado: false Valores posibles: 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
Crea una nueva configuración de proveedor de eventos de App asociada con la cuenta actual. Solo puede haber un proveedor MACT asociado a una cuenta de anuncios específica.URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta apalancada. 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. Tipo: string Ejemplo: 18ce54d4x5t |
| provider_advertiser_id obligatorio | 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[¶]
Elimina la configuración del proveedor de eventos de la App especificada que pertenece a la cuenta actual.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 apalancada. 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. 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
Consulta X para verificar la atribución de conversiones sin registrar un evento de conversión. La respuesta indicará la atribución de X. Esto se relaciona con el endpoint POST conversion_event. En la respuesta se indicará atribución de X, de TAP o ninguna. El nodotwitter_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 a continuación. Si se reclama atribución de TAP, habrá un nodo tpn_attribution y se completará en consecuencia. Consulta la introducción a 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 obligatorio | El identificador único en la tienda de apps correspondiente. Tipo: int, string Ejemplo: 333903271, com.vine.android |
| conversion_time obligatorio | La hora del evento de conversión en formato de marca de tiempo ISO-8601, con milisegundos. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| conversion_type obligatorio | 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 obligatorio | El IDFA o AdID con hash HMAC_SHA-256. Tipo: string Ejemplo: ABCD1234XYZ |
| os_type obligatorio | El tipo de sistema operativo de la App. Tipo: enum Valores posibles: IOS, ANDROID |
| click_window opcional | La ventana de clic para este evento, en días. Tipo: int Predeterminado: 14 Valores posibles: 1, 7, 14, 30 |
| extra_device_ids opcional | Un SHA256 del SHA1 del id del dispositivo pasado en hashed_device_id, más cualquier id de dispositivo adicional con hash.Tipo: string Ejemplo: ABCD1234XYZ, DCBA4321XYZ |
| non_twitter_engagement_time opcional | La hora de la última interacción fuera de X previa a la conversión. Tipo: string Ejemplo: 2014-05-22T02:38:28.103Z |
| non_twitter_engagement_type opcional | El tipo de interacción fuera de X previa al evento de conversión. Tipo: enum Valores posibles: CLICK, VIEW |
| view_through_window opcional | La ventana de visualización atribuida para este evento, en días. Tipo: int Predeterminado: 1 Valores posibles: 0, 1, 7, 14, 30 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/95?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