Introducción
Las métricas de analytics ayudan a socios y anunciantes a comprender el rendimiento del contenido que promocionan en X. Esto incluye información como impresiones, clics, visualizaciones de video y gasto. Además, los socios y anunciantes pueden obtener métricas detalladas para diversos segmentos de las audiencias a las que llegan. La Ads API admite dos formas de obtener métricas detalladas de rendimiento de campaña: de manera sincrónica y asincrónica. Con las llamadas de analytics sincrónicas, las métrricas solicitadas se devuelven en la respuesta. Con los endpoints de analytics asincrónicos, las métricas solicitadas están disponibles en un archivo de resultados descargable después de que el “job” asociado haya terminado de procesarse. El endpoint sincrónico admite periodos de tiempo cortos y es ideal para optimizaciones de campaña en tiempo real. Los endpoints asincrónicos admiten periodos de tiempo mucho más largos y, por lo tanto, están pensados para obtener muchos más datos, ideal para generar informes o realizar cargas históricas.Detalles
Sincrónico vs. asincrónico
| Función | Sincrónico | Asincrónico |
|---|---|---|
| Limitación de tasa | A nivel de usuario: 250 solicitudes/15 minutos | A nivel de cuenta: 100 trabajos concurrentes* |
| Intervalo de tiempo | 7 días | 90 días (sin segmentación) 45 días (con segmentación) |
| Segmentación | No | Sí |
| Respuesta | Datos de métricas | Estado de procesamiento del trabajo** |
| Caso de uso recomendado | Optimización en tiempo real Solicitudes de la interfaz de usuario | Sincronización programada periódica Relleno de datos históricos |
- Se refiere al número máximo de trabajos que pueden estar en estado de procesamiento en un momento dado.
Casos de uso
- Optimización en tiempo real: usar métricas de rendimiento para actualizar campañas activas
- Sincronización: sincronizaciones periódicas en segundo plano
- Incorporación de nuevas cuentas: rellenar datos históricos
Opciones de solicitud
- Entidades: el tipo de entidad, así como hasta 20 id de entidad para las que deseas solicitar analytics
- Rango temporal: las horas de inicio y fin, expresadas en ISO 8601
- Nota: deben expresarse en horas completas
- Grupos de métricas: uno o más conjuntos de métricas relacionadas (consulta Métricas y segmentación para ver la lista de métricas dentro de cada grupo)
- Granularidad: especifica el nivel de agregación en el que se deben devolver las métricas
- Ubicación: determina si las métricas se obtienen para anuncios que se publicaron dentro o fuera de X
- Nota: solo se puede especificar un único valor de ubicación por solicitud
start_time y end_time para especificar un rango temporal. Estos valores deben alinearse con la granularidad indicada de la siguiente manera.
TOTAL: especifica cualquier rango temporal (dentro de los límites del endpoint)DAY: tanto la hora de inicio como la de fin deben alinearse con la medianoche en la zona horaria de la cuentaHOUR: especifica cualquier rango temporal (dentro de los límites del endpoint)
start_time=2019-01-01T00:00:00Z y end_time=2019-01-02T00:00:00Z devolverá métricas de analytics equivalentes a un solo día (no dos), ya que este rango temporal abarca únicamente un período de 24 horas.
Segmentación
Disponible solo a través de nuestros endpoints de analytics asíncronos, la segmentación permite a socios y anunciantes obtener métricas desglosadas por valores de segmentación específicos. Para solicitar métricas segmentadas, usa el parámetro de solicitud segmentation_type. Para más detalles sobre las opciones de segmentación, consulta Métricas y segmentación.
Preguntas frecuentes
- Asegúrate de solicitar datos para todas las ubicaciones:
ALL_ON_TWITTERyPUBLISHER_NETWORK,SPOTLIGHTyTREND. - Recuerda que las horas de finalización en la Ads API son exclusivas; en la interfaz de Ads son inclusivas.
- En cuanto las métricas de informes estén disponibles, podrás recuperarlas. Están disponibles casi en tiempo real. Sin embargo, estos resultados iniciales son estimaciones y, por lo tanto, es de esperar que cambien. Las métricas se finalizan después de 24 horas, con la excepción de los datos de gasto.
- Las métricas de gasto generalmente se finalizan dentro de los 3 días posteriores al evento. No obstante, procesamos datos de facturación hasta 14 días desde la fecha del evento (por ejemplo, para el filtrado de spam).
- Usa el Active Entities endpoint
null?
- Es probable que la campaña no haya tenido impresiones durante el período de tiempo solicitado.
- Usa el Active Entities endpoint para determinar para qué entidades obtener analytics y para qué período de tiempo.
null mientras que la interfaz muestra 0?
- La interfaz opta por mostrar estos valores como 0, pero los valores son equivalentes.
- Admitimos los siguientes valores de ubicación en analytics:
ALL_ON_TWITTERyPUBLISHER_NETWORK,SPOTLIGHTyTREND(es decir, la X Audience Platform).
- Sí. El estado de la entidad no afecta la disponibilidad de las métricas de analytics.
- No se espera que los datos segmentados se acumulen al 100% con los datos no segmentados, debido a cómo se derivan.
- No admitimos la multisegmentación.
Mejores prácticas
Limitación de tasa y reintentos
- En las consultas sujetas a limitación de tasa (las que devuelven un código de estado
HTTP 429), debes revisar el encabezadox-rate-limit-resety volver a intentar únicamente en o después de la hora indicada. - En las consultas que devuelven un código de estado
HTTP 503 Service Unavailable, debes revisar el encabezadoretry-aftery volver a intentar solo después de la hora indicada. - Las aplicaciones que no respeten los tiempos indicados para los reintentos podrían ver su acceso a la Ads API revocado o limitado sin previo aviso.
Métricas de Analytics en pocas palabras
- Todas las métricas de analytics quedan bloqueadas y no cambian después de 24 horas, con la excepción de
billed_charge_local_micro. - La métrica
billed_charge_local_microes una estimación durante hasta 3 días después de que se devuelve el data. - Después de 24 horas, esta métrica puede disminuir debido a créditos por gasto excesivo (anuncios publicados después del
end_timeindicado) y por eventos facturables que se determinen como no válidos. Esta métrica cambia mínimamente después de 24 horas. - Consulta Analytics para obtener más información.
Obtención de datos no segmentados en tiempo real
- Proporciona siempre tanto
start_timecomoend_time. - No extraigas datos de entidades con más de 7 días de antigüedad.
- Solicita datos (idealmente) con granularidad
HOUR, ya que siempre puedes agregar y consolidar métricas para obtener granularidadDAYyTOTAL. - Solicita datos (idealmente) a nivel de
line_itemsypromoted_tweets, ya que siempre puedes agregar y consolidar estas métricas para obtener totales en toda la jerarquía de entidades de anuncios (es decir, a nivel de campaña, instrumento de financiación o cuenta). - Guarda y almacena localmente los valores de las métricas de analytics.
- No consultes repetidamente datos con más de 30 días. Estos datos no cambiarán y deben almacenarse localmente.
- Todos los datos no segmentados son en tiempo real y deberían estar disponibles en cuestión de segundos tras producirse un evento.
- Agrupa las métricas de conversión y las de no conversión en solicitudes separadas.
Obtención de datos segmentados
- Consulta las pautas anteriores para “Obtención de datos en tiempo real no segmentados”. A continuación se ofrece orientación adicional.
- En la mayoría de los tipos de datos segmentados, es posible que los datos no estén completos durante hasta 1 hora en ciertos momentos. Los datos segmentados por
INTERESTSpueden retrasarse hasta 12 horas. - No se espera que los datos segmentados sumen el 100% de los no segmentados, debido a la forma en que se derivan.
Obtención de datos históricos
- Al completar datos retrospectivos (por ejemplo, al agregar una nueva cuenta de anunciante), puede que debas hacer varias solicitudes en intervalos más pequeños de
start_timeyend_time. - Limita tus consultas a ventanas de 30 días.
- Regula estas solicitudes y distribúyelas en el tiempo para no agotar los límites de velocidad de estas consultas.
Ejemplo
fetch_stats) en nuestro repositorio de ads-platform-tools en GitHub.
Métricas por objetivo
ENGAGEMENTS
ENGAGEMENT y BILLING. MEDIA también aplica si se utiliza contenido multimedia en los creativos.
| Métrica derivada | Cálculo de la métrica expuesta |
| Tasa de engagement | engagements/impressions |
| CPE | billed_charge_local_micro/engagements |
| Tasa de visualización de medios | media_views/impressions |
WEBSITE_CLICKS y WEBSITE_CONVERSIONS
ENGAGEMENT, BILLING y WEB_CONVERSION. MEDIA también aplica si se utiliza contenido multimedia en los creativos.
| Métrica derivada | Cálculo de la métrica expuesta |
| CPM | billed_charge_local_micro/impressions/1000 |
| Tasa de clics | clicks/impressions |
| CPLC | billed_charge_local_micro/clicks |
| Conversiones totales | conversion_custom + conversion_site_visits + conversion_sign_ups + conversion_downloads + conversion_purchases |
| Tasa de conversión | Conversiones totales / impressions |
| CPA | billed_charge_local_micro / Conversiones totales |
APP_INSTALLS y APP_ENGAGEMENTS
ENGAGEMENT, BILLING, MOBILE_CONVERSION y LIFE_TIME_VALUE_MOBILE_CONVERSION. MEDIA y VIDEO también aplican si se utiliza una app card de medios o video en los creativos.
| Métrica derivada | Cálculo de la métrica expuesta |
| CPM | billed_charge_local_micro/impressions/1000 |
| Tasa de clics de la App | app_clicks/impressions |
| CPAC | billed_charge_local_micro/app_clicks |
| CPI | billed_charge_local_micro/mobile_conversion_installs |
FOLLOWERS
ENGAGEMENT y BILLING. MEDIA también aplica si se utiliza contenido multimedia en los creativos.
| Métrica derivada | Cálculo de la métrica expuesta |
| CPM | billed_charge_local_micro/impressions/1000 |
| Tasa de seguimiento | follows/impressions |
| CPF | billed_charge_local_micro/follows |
| Tasa de visualización de medios | media_views/impressions |
LEAD_GENERATION
ENGAGEMENT y BILLING. MEDIA también aplica si se utiliza contenido multimedia en los creativos.
| Métrica derivada | Cálculo de la métrica expuesta |
| CPM | billed_charge_local_micro/impressions/1000 |
| Leads | card_engagements |
| Tasa de leads | card_engagements/impressions |
| Costo por lead | billed_charge_local_micro/card_engagements |
VIDEO_VIEWS
ENGAGEMENT, BILLING y VIDEO.
| Métrica derivada | Cálculo de la métrica expuesta |
| CPM | billed_charge_local_micro/impressions/1000 |
| Tasa de video | video_total_views/impressions |
| Costo por visualización | billed_charge_local_micro/video_total_views |
VIDEO_VIEWS_PREROLL
ENGAGEMENT, BILLING y VIDEO.
| Métrica derivada | Cálculo de la métrica expuesta |
| CPM | billed_charge_local_micro/impressions/1000 |
| Tasa de vídeo | video_total_views/impressions |
| Costo por visualización | billed_charge_local_micro/video_total_views |
Métricas y segmentación
| Grupos de métricas | |||||||
| Entidad | ENGAGEMENT | BILLING | VIDEO | MEDIA | WEB_CONVERSION | MOBILE_CONVERSION | LIFE_TIME_VALUE_MOBILE_CONVERSION |
ACCOUNT | ✔* | ||||||
FUNDING_INSTRUMENT | ✔* | ✔ | |||||
CAMPAIGN | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
LINE_ITEM | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
PROMOTED_TWEET | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
MEDIA_CREATIVE | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
ORGANIC_TWEET | ✔ | ✔ |
ENGAGEMENT no están disponibles a nivel de cuenta e instrumento de financiación. Consulta la sección ENGAGEMENT para más detalles.
Métricas disponibles por grupo de métricas
ENGAGEMENT
| Métrica | Descripción | Segmentación disponible | Tipo de dato | Disponible para cuenta / instrumento de financiación |
engagements | Número total de interacciones | ✔ | Array de enteros | ✔ |
impressions | Número total de impresiones | ✔ | Array de enteros | ✔ |
retweets | Número total de retweets | ✔ | Array de enteros | ✔ |
replies | Número total de respuestas | ✔ | Array de enteros | ✔ |
likes | Número total de Me gusta | ✔ | Array de enteros | ✔ |
follows | Número total de follows | ✔ | Array de enteros | ✔ |
card_engagements | Número total de interacciones con la Card | ✔ | Array de enteros | |
clicks | Número total de clics, incluidos los Me gusta y otras interacciones | ✔ | Array de enteros | |
app_clicks | Número de intentos de instalación o apertura de la App | ✔ | Array de enteros | |
| url_clicks | Número total de clics en el enlace o en la Website Card de un anuncio, incluidos los obtenidos | ✔ | Array de enteros | |
qualified_impressions | Número total de impresiones cualificadas | ✔ | Array de enteros | |
carousel_swipes | Número total de deslizamientos en imágenes o videos de Carrusel | ✔ | Array de enteros |
BILLING
| Métrica | Descripción | Segmentación disponible | Tipo de datos |
billed_engagements | Número total de interacciones facturadas | ✔ | Array de enteros |
billed_charge_local_micro | Gasto total en micros | ✔ | Array de enteros |
VIDEO
video_total_views dentro del grupo de métricas VIDEO contabilizará cualquier visualización con al menos un 50% en pantalla durante 2 segundos, según el estándar del MRC.
Nuestra definición original de visualización de video (100% en pantalla durante al menos 3 segundos) seguirá disponible como la nueva métrica video_3s100pct_views en el grupo de métricas VIDEO. Para seguir ofertando y que la facturación se base en la definición original de visualización, usa la nueva VIEW_3S_100PCT como bid_unit.
| Métrica | Descripción | Segmentación disponible | Tipo de dato |
video_total_views | Número total de visualizaciones de video | ✔ | Array de ints |
video_views_25 | Número total de visualizaciones en las que se vio al menos el 25% del video | ✔ | Array de ints |
video_views_50 | Número total de visualizaciones en las que se vio al menos el 50% del video | ✔ | Array de ints |
video_views_75 | Número total de visualizaciones en las que se vio al menos el 75% del video | ✔ | Array de ints |
video_views_100 | Número total de visualizaciones en las que se vio el 100% del video | ✔ | Array de ints |
video_cta_clicks | Clics totales en el llamado a la acción | ✔ | Array de ints |
video_content_starts | Número total de inicios de reproducción de video | ✔ | Array de ints |
video_3s100pct_views | Número total de visualizaciones en las que se reprodujeron al menos 3 segundos con el 100% en pantalla (definición anterior de video_total_views) | ✔ | Array de ints |
video_6s_views | Número total de visualizaciones en las que se vieron al menos 6 segundos del video | ✔ | Array de ints |
video_15s_views | Número total de visualizaciones en las que se vieron al menos 15 segundos del video o el 95% de la duración total | ✔ | Array de ints |
MEDIA
| Métrica | Descripción | Segmentación disponible | Tipo de datos |
media_views | Número total de visualizaciones (reproducción automática y al hacer clic) de medios en videos, Vines, GIF y imágenes. | ✔ | Arreglo de enteros |
media_engagements | Número total de clics en medios en videos, Vines, GIF y imágenes. | ✔ | Arreglo de enteros |
WEB_CONVERSION
| Métrica | Descripción | Segmentación disponible | Tipo de dato |
conversion_purchases | Número de conversiones de tipo PURCHASE y el importe de venta y la cantidad de pedidos correspondientes | Solo PLATFORMS | Objeto JSON |
conversion_sign_ups | Número de conversiones de tipo SIGN_UP y el importe de venta y la cantidad de pedidos correspondientes | Solo PLATFORMS | Objeto JSON |
conversion_site_visits | Número de conversiones de tipo SITE_VISIT y el importe de venta y la cantidad de pedidos correspondientes | Solo PLATFORMS | Objeto JSON |
conversion_downloads | Número de conversiones de tipo DOWNLOAD y el importe de venta y la cantidad de pedidos correspondientes | Solo PLATFORMS | Objeto JSON |
conversion_custom | Número de conversiones de tipo CUSTOM y el importe de venta y la cantidad de pedidos correspondientes | Solo PLATFORMS | Objeto JSON |
MOBILE_CONVERSION
| Métrica | Descripción | Segmentación disponible | Tipo de dato |
mobile_conversion_spent_credits | Desglose de conversiones móviles del tipo SPENT_CRÉDITO por Post_vista, Post_interacción, asistida, orden_cantidad y ventas_importe | ✔ | Objeto JSON |
mobile_conversion_installs | Desglose de conversiones móviles de tipo INSTALL por Post_vista, Post_interacción, asistida, pedido_cantidad y ventas_importe | ✔ | Objeto JSON |
mobile_conversion_content_views | Desglose de conversiones móviles del tipo CONTENT_VISTA por Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto de JSON |
mobile_conversion_add_to_wishlists | Desglose de conversiones móviles del tipo ADD_A_LISTA DE DESEOS por Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_checkouts_initiated | Desglose de conversiones móviles del tipo CHECKOUT_INITIATED by Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_reservations | Desglose de conversiones móviles de tipo RESERVATION por publicación_vista, Post_interacción, asistida, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_tutorials_completed | Desglose de conversiones móviles del tipo TUTORIAL_COMPLETED por Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_achievements_unlocked | Desglose de conversiones móviles de tipo ACHIEVEMENT_DESBLOQUEADO por Post_vista, Post_interacción, asistida, orden_cantidad y ventas_importe | ✔ | Objeto JSON |
mobile_conversion_searches | Desglose de conversiones móviles de tipo SEARCH por Post_vista, publicación_interacción, asistido, pedido_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_add_to_carts | Desglose de conversiones móviles del tipo ADD_PARA_CARRITO por Post_vista, Post_participación, asistido, orden_cantidad y ventas_importe | ✔ | Objeto JSON |
mobile_conversion_payment_info_additions | Desglose de conversiones móviles de tipo PAYMENT_INFORMACIÓN_ADICIÓN por Post_vista, Post_interacción, asistido, pedido_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_re_engages | Desglose de conversiones móviles del tipo RE_INTERACCIÓN por Post_vista, Post_interacción, asistido, pedido_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_shares | Desglose de conversiones móviles de tipo SHARE por Post_vista, Post_interacción, asistida, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_rates | Desglose de conversiones móviles de tipo RATE por Post_vista, Post_interacción, asistida, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_logins | Desglose de conversiones móviles de tipo LOGIN por Post_vista, Post_interacción, asistida, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_updates | Desglose de conversiones móviles de tipo UPDATE por Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_levels_achieved | Desglose de conversiones móviles del tipo LEVEL_LOGRADO por Post_vista, Post_interacción, asistida, pedido_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_invites | Desglose de conversiones móviles de tipo INVITE por Post_vista, Post_interacción, asistida, orden_cantidad y venta_importe | ✔ | Objeto JSON |
mobile_conversion_key_page_views | Desglose de conversiones móviles de tipo KEY_PÁGINA_VER por Post_ver y publicar_interacción | ✔ | Objeto JSON |
| móvil_conversión_Descargas | Desglose de conversiones móviles de tipo DOWNLOAD por Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto JSON |
| móvil_conversión_compras | Desglose de conversiones móviles de tipo PURCHASE por Post_vista, Post_interacción, asistido, orden_cantidad y venta_importe | ✔ | Objeto JSON |
| móvil_conversión_firmar_oops | Desglose de conversiones móviles del tipo FIRMA_SUBIDAS por Post_vista, Post_interacción, asistida, orden_cantidad y ventas_importe | ✔ | Objeto JSON |
| dispositivo móvil_conversión_sitio_visitas | Desglose de conversiones móviles de tipo SITIO_VISITAS por Post_vista, Post_interacción, asistida, orden_cantidad y venta_importe | ✔ | Objeto JSON |
LIFE_TIME_VALUE_MOBILE_CONVERSION
| Métrica | Descripción | Segmentación disponible | Tipo de dato |
mobile_conversion_lifetime_value_purchases | Desglose de conversiones móviles de tipo PURCHASE | Objeto JSON | |
mobile_conversion_lifetime_value_sign_ups | Desglose de conversiones móviles de tipo SIGN_UP | Objeto JSON | |
mobile_conversion_lifetime_value_updates | Desglose de conversiones móviles de tipo UPDATE | Objeto JSON | |
mobile_conversion_lifetime_value_tutorials_completed | Desglose de conversiones móviles de tipo TUTORIAL_COMPLETED | Objeto JSON | |
mobile_conversion_lifetime_value_reservations | Desglose de conversiones móviles de tipo RESERVATION | Objeto JSON | |
mobile_conversion_lifetime_value_add_to_carts | Desglose de conversiones móviles de tipo ADD_TO_CART | Objeto JSON | |
mobile_conversion_lifetime_value_add_to_wishlists | Desglose de conversiones móviles de tipo ADD_TO_WISHLIST | Objeto JSON | |
mobile_conversion_lifetime_value_checkouts_initiated | Desglose de conversiones móviles de tipo CHECKOUT_INITIATED | Objeto JSON | |
mobile_conversion_lifetime_value_levels_achieved | Desglose de conversiones móviles de tipo LEVEL_ACHIEVED | Objeto JSON | |
mobile_conversion_lifetime_value_achievements_unlocked | Desglose de conversiones móviles de tipo ACHIEVEMENT_UNLOCKED | Objeto JSON | |
mobile_conversion_lifetime_value_shares | Desglose de conversiones móviles de tipo SHARE | Objeto JSON | |
mobile_conversion_lifetime_value_invites | Desglose de conversiones móviles de tipo INVITE | Objeto JSON | |
mobile_conversion_lifetime_value_payment_info_additions | Desglose de conversiones móviles de tipo PAYMENT_INFO_ADDITION | Objeto JSON | |
mobile_conversion_lifetime_value_spent_credits | Desglose de conversiones móviles de tipo SPENT_CREDIT | Objeto JSON | |
mobile_conversion_lifetime_value_rates | Desglose de conversiones móviles de tipo RATE | Objeto JSON |
Segmentación
MEDIA_CREATIVE u ORGANIC_TWEET.
Algunos tipos de segmentación requieren que se envíen parámetros adicionales. Estos se documentan a continuación.
Al segmentar por CITIES o POSTAL_CODES, la API solo devolverá ubicaciones dirigidas. La segmentación por región y área metropolitana devolverá ubicaciones tanto dirigidas como no dirigidas.
| Tipo de segmentación | se requiere el parámetro country | se requiere el parámetro platform |
AGE | ||
APP_STORE_CATEGORY | ||
AUDIENCES | ||
CITIES | ✔ | |
CONVERSATIONS | ||
CONVERSION_TAGS | ||
DEVICES | ✔ | |
EVENTS | ||
GENDER | ||
INTERESTS | ||
KEYWORDS | ||
LANGUAGES | ||
LOCATIONS | ||
METROS | ✔ | |
PLATFORMS | ||
PLATFORM_VERSIONS | ✔ | |
POSTAL_CODES | ✔ | |
REGIONS | ✔ | |
SLIDES | ||
SIMILAR_TO_FOLLOWERS_OF_USER | ||
TV_SHOWS |
Métricas derivadas
metric sin llaves es una devuelta por los endpoints de Analytics de la Ads API. Cualquier nombre entre {llaves} indica una métrica derivada para esa categoría.
INTERACCIONES
| Métrica derivada | Cálculo de la métrica expuesta |
promoted_tweet_search_impressions + promoted_tweet_timeline_impressions + promoted_tweet_profile_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
| {Total Engagements} | promoted_account_follows + promoted_tweet_search_engagements + promoted_tweet_timeline_engagements + promoted_tweet_profile_engagements o promoted_account_follows + promoted_tweet_search_clicks + promoted_tweet_search_replies + promoted_tweet_search_retweets + promoted_tweet_search_follows + promoted_tweet_timeline_clicks + promoted_tweet_timeline_replies + promoted_tweet_timeline_retweets + promoted_tweet_timeline_follows + promoted_tweet_profile_clicks + promoted_tweet_profile_replies + promoted_tweet_profile_retweets + promoted_tweet_profile_follows |
| {Engagement Rate} | {Total Engagements} / {Impressions} |
billed_charge_local_micro / {Total Engagements} | |
| {Media Views} | promoted_tweet_timeline_media_views + promoted_tweet_search_media_views + promoted_tweet_profile_media_views |
| {Media View Rate} | {Media Views} / {Impressions} |
WEBSITE_CLICKS
| Métrica Derivada | Cálculo de Métrica Expuesta |
promoted_tweet_search_impressions + promoted_tweet_timeline_impressions + promoted_tweet_profile_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
| {Link Clicks} | promoted_tweet_search_url_clicks + promoted_tweet_timeline_url_clicks + promoted_tweet_profile_url_clicks |
| {Click Rate} | {Link Clicks} / {Impressions} |
billed_charge_local_micro / {Link Clicks} | |
conversion_site_visits | |
| {Conversion Rate} | conversion_site_visits / {Impressions} |
billed_charge_local_micro / conversion_site_visits |
APP_INSTALLS y APP_ENGAGEMENTS
| Métrica derivada | Cálculo de la métrica expuesta |
promoted_tweet_search_impressions + promoted_tweet_timeline_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
| {App Clicks} | promoted_tweet_app_install_attempts + promoted_tweet_app_open_attempts + promoted_tweet_timeline_url_clicks + promoted_tweet_search_url_clicks |
| {App Click Rate} | {App Clicks} / {Impressions} |
billed_charge_local_micro / {App Clicks} | |
billed_charge_local_micro / mobile_conversion_installs |
SEGUIDORES
| Métrica derivada | Cálculo de la métrica expuesta |
promoted_account_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
promoted_account_follows | |
| {Follow Rate} | promoted_account_follow_rate |
billed_charge_local_micro / promoted_account_follows | |
| {Media Views} | promoted_tweet_timeline_media_views + promoted_tweet_search_media_views + promoted_tweet_profile_media_views |
| {Media View Rate} | {Media Views} / {Impressions} |
LEAD_GENERATION
| Métrica derivada | Cálculo de métrica expuesta |
promoted_tweet_search_impressions + promoted_tweet_timeline_impressions + promoted_tweet_profile_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
promoted_tweet_search_card_engagements + promoted_tweet_timeline_card_engagements + promoted_tweet_profile_card_engagements | |
| {Lead Rate} | {Leads} / {Impressions} |
| {Cost Per Lead} | billed_charge_local_micro / {Leads} |
VIDEO_VIEWS
| Métrica derivada | Cálculo de métrica expuesta |
promoted_tweet_search_impressions + promoted_tweet_timeline_impressions + promoted_tweet_profile_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
| {Video Views} | promoted_video_total_views |
| {Video Rate} | promoted_video_total_views / {Impressions} |
| {Cost Per View} | billed_charge_local_micro / promoted_video_total_views |
IMPRESIONES_CUALIFICADAS
| Métrica derivada | Cálculo de la métrica expuesta |
promoted_tweet_search_impressions + promoted_tweet_timeline_impressions + promoted_tweet_profile_impressions | |
billed_charge_local_micro / {Impressions} / 1000 | |
| {Qualified Impressions} | promoted_tweet_timeline_qualified_impressions + promoted_tweet_search_qualified_impressions + promoted_tweet_profile_qualified_impressions |
| {Qualified Impression Rate} | {Qualified Impressions} / {Impressions} |
| {Cost Per 1000 Qualified Impressions} | billed_charge_local_micro / {Qualified Impressions} / 1000 |
PERSONALIZADO
placement_type de PROMOTED_ACCOUNT, consulta el objetivo FOLLOWERS más arriba. Para las demás ubicaciones con este objetivo, consulta ENGAGEMENTS para ver las métricas derivadas correspondientes.
Guías
Entidades activas
Introducción
Data
Endpoint
Solicitud
entity, start_time y end_time.
twurl -H ads-api.x.com "/11/stats/accounts/18ce54d4x5t/active_entities?entity=PROMOTED_TWEET&start_time=2019-03-05T00:00:00Z&end_time=2019-03-06T00:00:00Z"
Se admiten los siguientes valores para entity: CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, MEDIA_CREATIVE, PROMOTED_ACCOUNT y PROMOTED_TWEET. Esto refleja los tipos de entidad que admiten nuestros endpoints de analytics.
Los valores de start_time y end_time deben expresarse en formato ISO 8601 y especificar qué intervalos horarios consultar. Deben expresarse en horas completas.
Este endpoint también admite tres parámetros opcionales que se pueden usar para filtrar los resultados: funding_instrument_ids, campaign_ids y line_item_ids. Funcionan en todos los niveles de la jerarquía de anuncios y con cualquier tipo de entity especificado.
Respuesta
data incluye un objeto por cada entidad que debe incluirse en una solicitud de analytics posterior. No debes solicitar analytics para IDs fuera de este conjunto.
Cada objeto incluye cuatro campos: entity_id, activity_start_time, activity_end_time y placements. Las horas de inicio y fin de la actividad representan el intervalo de tiempo al que se aplican los eventos de cambio de la entidad asociada y, por lo tanto, determinan las fechas que deben especificarse en solicitudes de analytics posteriores. La matriz placements puede incluir los siguientes valores: ALL_ON_TWITTER, PUBLISHER_NETWORK, SPOTLIGHT y TREND. Indica qué ubicaciones deben solicitarse para el ID de la entidad indicada.
Uso
- Con qué frecuencia solicitar información de entidades activas y, por lo tanto, con qué frecuencia obtener analytics.
- Cómo usar las horas de inicio y fin de la actividad para determinar los valores
start_timeyend_timede la solicitud de analytics.
Resumen
- Realiza la solicitud de Active Entities.
- Divide la respuesta por placement. Un grupo para
ALL_ON_TWITTER, otro paraPUBLISHER_NETWORK, otro paraSPOTLIGHTy otro paraTREND. - Para cada grupo de placement, haz lo siguiente.
- Extrae los id de entidad.
- Determina los valores de
start_timeyend_timede analytics.- Encuentra el
activity_start_timemínimo. Redondea este valor hacia abajo. - Encuentra el
activity_end_timemáximo. Redondea este valor hacia arriba.
- Encuentra el
- Realiza las solicitudes de analytics.
- Agrupa los id de entidad en lotes de 20.
- Usa los valores de
start_timeyend_timedel punto 3b. - Especifica el valor de
placementcorrespondiente.
- Escribe en tu almacén de datos.
Frecuencia
start_time de la solicitud actual sea igual al end_time de la solicitud anterior.
Nota: Una ventana de tiempo debe solicitarse solo una vez. Solicitar la misma ventana más de una vez generará solicitudes de analíticas innecesarias. (Excepción a continuación).
| Hora de solicitud | Marca de tiempo de start_time | Marca de tiempo de end_time |
| 00:15:00 | 00:00:00 | 00:15:00 |
| 00:30:00 | 00:15:00 | 00:30:00 |
| 00:45:00 | 00:30:00 | 00:45:00 |
| 01:00:00 | 00:45:00 | 01:00:00 |
Tiempos de actividad
activity_start_time y el máximo activity_end_time. Modifica estos valores redondeando hacia abajo la hora mínima de inicio de actividad y redondeando hacia arriba la hora máxima de fin de actividad. En concreto, establece en cero las marcas de tiempo en ambos y añade un día a la hora de finalización, como se muestra en la siguiente tabla. Estos serán los tiempos de inicio y fin que deberán especificarse en solicitudes de analytics posteriores.
| Tiempos mínimos y máximos de actividad | Tiempos derivados |
| 2019-03-04T20:55:20Z 2019-03-05T14:40:59Z | 2019-03-04T00:00:00Z 2019-03-06T00:00:00Z |
DAY en la solicitud de analytics.)
Ejemplo
start_time y end_time de analytics se establecen en 2019-02-11T00:00:00Z y 2019-02-12T00:00:00Z, respectivamente. Vemos que el tercer elemento de cada uno de los arreglos de métricas a continuación es distinto de cero, como esperábamos según la información sobre entidades activas.
Guía asíncrona
Referencia de API
Analíticas asincrónicas
Introducción
Uso
- Crea el job con el endpoint POST stats/jobs/accounts/:account_id.
- Realiza solicitudes a intervalos regulares al endpoint GET stats/jobs/accounts/:account_id para determinar si el job ha terminado de procesarse.
- Una vez que el job haya terminado de procesarse, descarga el archivo de datos.
- Descomprime el archivo de datos.
segmentation_type al crear el job.
Ejemplo
id e id_str.
A continuación, debes comprobar si el trabajo que creaste utilizando el id_str de la respuesta anterior ha terminado de procesarse, tal como se indica con "status": "SUCCESS" en la respuesta. Esto significa que los datos están listos para descargar. El campo url contiene el enlace de descarga.
job_ids para comprobar el estado de varias tareas a la vez especificando hasta 200 id de tarea.
A continuación, descarga el archivo de datos utilizando el valor url indicado.
Alcance y frecuencia media
GET stats/accounts/:account_id/reach/campaigns
Obtén analíticas de alcance y frecuencia media para las campañas especificadas.https://ads-api.x.com/stats/accounts/:account_id/reach/campaigns
| 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 |
| campaign_ids obligatorio | Limita la respuesta a las campañas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 20 id. Nota: Se pueden proporcionar hasta 20 id de campaña. Tipo: string Ejemplo: 8fgzf |
| end_time obligatorio | Limita los datos recuperados a la hora de finalización especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-26T07:00:00Z |
| start_time obligatorio | Limita los datos recuperados a la hora de inicio especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-19T07:00:00Z |
GET https://ads-api.x.com/12/stats/accounts/18ce54d4x5t/reach/campaigns?campaign_ids=8fgzf&start_time=2017-05-19&end_time=2017-05-26
GET stats/accounts/:account_id/reach/funding_instruments
Obtén analíticas de alcance y frecuencia media para los instrumentos de financiación especificados.URL del recurso
https://ads-api.x.com/stats/accounts/:account_id/reach/funding_instruments
| 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 |
| funding_instrument_ids obligatorio | Restringe la respuesta a los instrumentos de financiación deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 20 id. Nota: Se pueden proporcionar hasta 20 id de instrumentos de financiación. Tipo: string Ejemplo: lygyi |
| end_time obligatorio | Restringe los datos recuperados a la hora de finalización especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-26T07:00:00Z |
| start_time obligatorio | Restringe los datos recuperados a la hora de inicio especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-19T07:00:00Z |
Ejemplo de solicitud
Respuesta de ejemplo
Analítica sincrónica
GET stats/accounts/:account_id
Recupera analíticas sincrónicas de la cuenta actual. Se permite un intervalo de tiempo máximo (end_time - start_time) de 7 días.
URL del recurso
https://ads-api.x.com/12/stats/accounts/:account_id
| 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 |
| end_time obligatorio | Restringe los datos recuperados hasta la hora de finalización especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-26T07:00:00Z |
| entity obligatorio | El tipo de entidad para la que se recuperarán datos. Tipo: enum Valores posibles: ACCOUNT, CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, ORGANIC_TWEET, PROMOTED_ACCOUNT, PROMOTED_TWEET, MEDIA_CREATIVE |
| entity_ids obligatorio | Las entidades específicas para las que se recuperarán datos. Especifica una lista de id de entidad separada por comas. Nota: Se pueden proporcionar hasta 20 id de entidad. Tipo: string Ejemplo: 8u94t |
| granularity obligatorio | Especifica el nivel de detalle de los datos recuperados. Tipo: enum Valores posibles: DAY, HOUR, TOTAL |
| metric_groups obligatorio | Las métricas específicas que deben devolverse. Especifica una lista de grupos de métricas separada por comas. Para obtener más información, consulta Métricas y segmentación. Nota: Los datos de MOBILE_CONVERSION deben solicitarse por separado.Tipo: enum Valores posibles: BILLING, ENGAGEMENT, LIFE_TIME_VALUE_MOBILE_CONVERSION, MEDIA, MOBILE_CONVERSION, VIDEO, WEB_CONVERSION |
| placement obligatorio | Restringe los datos recuperados a una ubicación específica. Nota: Solo se acepta un valor por solicitud. Para entidades con ubicación tanto en X como en X Audience Platform, se requieren solicitudes separadas, una para cada valor de ubicación. Tipo: enum Valores posibles: ALL_ON_TWITTER, PUBLISHER_NETWORK, SPOTLIGHT, TREND |
| start_time obligatorio | Restringe los datos recuperados a la hora de inicio especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-19T07:00:00Z |
Ejemplo de solicitud
Ejemplo de respuesta
Entidades activas
GET stats/accounts/:account_id/active_entities
Recupera detalles sobre qué métricas de analytics de las entidades han cambiado en un período de tiempo determinado. Este endpoint debe usarse junto con nuestros endpoints de analytics. Los resultados de este endpoint indican para qué entidades de anuncios solicitar analytics. Consulta nuestra Guía de entidades activas para conocer las pautas de uso. Los eventos de cambio están disponibles en intervalos de una hora.- Los valores
start_timeyend_timeespecifican qué intervalos de una hora consultar. - El array
datadevuelto incluirá un objeto por cada entidad que deba incluirse en solicitudes de analytics posteriores. - IMPORTANTE: Las fechas que deben especificarse en las solicitudes de analytics posteriores deben determinarse en función de los valores
activity_start_timeyactivity_end_time.- Estos valores representan los rangos de tiempo a los que se aplican los eventos de cambio almacenados. Esto se devuelve por entidad.
end_time - start_time) de 90 días.
https://ads-api.x.com/12/stats/accounts/:account_id/active_entities
| 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. Tipo: string Ejemplo: 18ce54d4x5t |
| end_time obligatorio | Limita los datos recuperados hasta la hora de finalización especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-26T07:00:00Z |
| entity obligatorio | El tipo de entidad para la que se recuperarán datos. Tipo: enum Valores posibles: CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, MEDIA_CREATIVE, PROMOTED_ACCOUNT, PROMOTED_TWEET |
| start_time obligatorio | Limita los datos recuperados a partir de la hora de inicio especificada, expresada en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Tipo: string Ejemplo: 2017-05-19T07:00:00Z |
| campaign_ids opcional | Limita la respuesta solo a las entidades asociadas con las campañas deseadas, especificando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 id. Nota: Mutuamente excluyente con funding_instrument_ids y line_item_ids.Tipo: string Ejemplo: 8wku2 |
| funding_instrument_ids opcional | Limita la respuesta solo a las entidades asociadas con los instrumentos de financiación deseados, especificando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 id. Nota: Mutuamente excluyente con campaign_ids y line_item_ids.Tipo: string Ejemplo: lygyi |
| line_item_ids opcional | Limita la respuesta solo a las entidades asociadas con los line items deseados, especificando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 id. Nota: Mutuamente excluyente con campaign_ids y line_item_ids.Tipo: string Ejemplo: 8v7jo |
Ejemplo de solicitud
GET https://ads-api.x.com/12/stats/accounts/18ce54d4x5t/active_entities?entity=PROMOTED_TWEET&start_time=2019-02-28&end_time=2019-03-01