Descripción general de MACT
Eventos de conversión
Referencia de la API
Evento de conversión
POST conversion_event
Registra un evento de conversión de medición móvil. La respuesta indicará la atribución de X o de X Audience Platform (TAP). Esto se relaciona con el endpoint GET conversion_attribution. 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 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 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. Type: int, string Example: 333903271 , com.vine.android |
conversion_time obligatorio | La hora del evento de conversión en formato de marca de tiempo ISO‑8601, con milisegundos añadidos. Type: string Example: 2014-05-22T02:38:28.103Z |
conversion_type obligatorio | El tipo de evento de conversión. 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 obligatorio | El IDFA o AdID con hash HMAC_SHA-256. Type: string Example: ABCD1234XYZ |
os_type obligatorio | El tipo de SO de la app. Type: enum Possible values: IOS , ANDROID |
click_window opcional | La ventana de clic para este evento, en días. Type: int Nota: click_window debe ser mayor o igual que view_through_window.Default: 14 Possible values: 1 , 7 , 14 , 30 |
device_ip_address opcional | La dirección IPv4 o IPv6 del dispositivo cuando ocurrió el evento de conversión. Type: string Example: 192.133.78.1 |
level opcional | Un nivel asociado con este evento. Type: int Example: 2 |
non_twitter_engagement_time opcional | La hora de la última interacción fuera de X antes de la conversión. Type: string Example: 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. Type: enum Possible values: CLICK , VIEW |
number_items opcional | Número de artículos asociados con este evento. Type: int Example: 2 |
price_currency opcional | Se espera un código ISO 4217 que indique la moneda asociada con este evento. Type: String Examples: EUR , USD , JPY |
price_micro opcional | Un importe de precio asociado a este evento en micro-unidades. Type: int Example: 123450000 |
user_payment_info opcional | Un valor booleano que indica si la información de pago del usuario está almacenada en la app asociada con este evento. Type: bool Possible values: true or 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.Type: int Default: 1 Possible values: 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 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 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. Tipo: string Ejemplo: 18ce54d4x5t |
app_event_tag_ids opcional | Limita la respuesta únicamente 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 página siguiente de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
sort_by opcional | 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 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 tasa más bajos, actualmente de 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 aplicaciones 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 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_event_tag_id obligatorio | Referencia a la etiqueta de evento de la App con la que se opera en la solicitud. Type: string Example: jhp |
with_deleted opcional | Incluir 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
POST accounts/:account_id/app_event_tags
Crea una nueva etiqueta de evento de la 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 aprovechada. 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 obligatorio | El identificador de la tienda de aplicaciones. Type: string Example: com.twitter.android |
conversion_type obligatorio | 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 obligatorio | El tipo de sistema operativo de la App. Type: enum Possible values: IOS , ANDROID |
provider_app_event_id obligatorio | El id de la etiqueta de conversión en el sitio del proveedor. Type: string Example: provider_tag_j5394 |
provider_app_event_name obligatorio | El nombre de la etiqueta de conversión en el sitio del proveedor. Type: string Example: provider_name_a4382 |
deep_link_scheme opcional | Especifica el URI de deep link de la App asociada con esta etiqueta. Type: string Example: twitter:// |
post_engagement_attribution_window opcional | La ventana de atribución posterior a la interacción para estos eventos. Type: int Default: 30 Possible values: 1 , 7 , 14 , 30 |
post_view_attribution_window opcional | 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 opcional | 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
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 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. Tipo: string Ejemplo: 18ce54d4x5t |
id obligatorio | Una referencia a la etiqueta de evento de App con la que se opera 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 App
GET accounts/:account_id/app_lists
Recupera los detalles de algunas o todas las listas de Apps 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 requerido | 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_ids opcional | Limita la respuesta únicamente a las listas de apps deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: wm7x |
count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor opcional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Example: 8x7v00oow |
sort_by opcional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Type: string Example: created_at-asc |
with_deleted opcional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: 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 tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: 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
Recupera 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 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 obligatorio | Una referencia a la App List con la que opera en la solicitud. Type: string Example: 28ukf |
with_deleted opcional | Incluye los resultados eliminados en su 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
Crea unaapp_list
asociada a la cuenta actual.
Actualmente hay un límite de 100 objetos app_list
por account_id
y de 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 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. Tipo: string Ejemplo: 18ce54d4x5t |
app_store_identifiers obligatorio | Los identificadores de la tienda de aplicaciones que se incluirán en la app_list Tipo: string Ejemplo: com.twitter.android |
name obligatorio | El nombre que asignarás a la 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 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 obligatorio | Una referencia a la lista de Apps con la que se opera 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
GET accounts/:account_id/app_event_provider_configurations¶
Obtén los detalles de algunas o de todas las configuraciones del proveedor de eventos de la App (configuración central 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 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 |
count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor opcional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información. Type: string Example: 8x7v00oow |
ids opcional | Limita la respuesta únicamente a las configuraciones deseadas especificando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 ids. Type: string Example: 25n |
sort_by opcional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Type: string Example: created_at-asc |
with_deleted opcional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count opcional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son mutuamente excluyentes.Nota: Las solicitudes que incluyen total_count tendrán un límite de tasa más bajo, actualmente establecido en 200 por 15 minutos.Type: boolean Default: false Possible values: 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 principal para el seguimiento de conversiones de aplicaciones móviles) asociadas a la cuenta actual.URL del recurso
https://ads-api.x.com/11/accounts/:account_id/app_event_provider_configurations/:id
Parámetros
Name | Description |
---|---|
account_id obligatorio | 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 |
id obligatorio | Referencia a la configuración del proveedor de eventos de la App con la que opera la solicitud. Type: string Example: 25n |
with_deleted opcional | Incluir 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
Cree una nueva configuración de proveedor de eventos de la App asociada a la cuenta actual. Solo se puede asociar un proveedor MACT a una cuenta de anuncios determinada.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 utilizada. 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 |
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 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 |
id obligatorio | Referencia a la configuración del proveedor de eventos de la App con la que se está operando en la solicitud. Type: string Example: 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 a X para verificar la atribución de conversiones sin registrar un evento de conversión. La respuesta indicará la atribución en X. Esto está relacionado con el endpoint POST conversion_event. En la respuesta se reclamará atribución de X, de TAP o ninguna. El nodotwitter_attribution
siempre estará presente y tendrá el valor null
cuando no haya atribución en 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 informació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 obligatorio | El identificador único en la tienda de aplicaciones 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 | IDFA o AdID con hash HMAC_SHA-256. Tipo: string Ejemplo: ABCD1234XYZ |
os_type obligatorio | El tipo de SO de la App. Tipo: enum Valores posibles: IOS , ANDROID |
click_window opcional | La ventana de clic para este evento (en días). Tipo: int Valor predeterminado: 14 Valores posibles: 1 , 7 , 14 , 30 |
extra_device_ids opcional | Un SHA256 del SHA1 del id del dispositivo enviado 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 atribución por 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