Descripción general
Cada mes hacemos cambios y lanzamos varias funciones nuevas en la X Ads API. Estos cambios son casi siempre retrocompatibles; sin embargo, solemos tener un puñado de cambios incompatibles al año. Hemos recibido comentarios de desarrolladores sobre los retos que nuestra rápida cadencia de cambios en la Ads API supone en sus ciclos de desarrollo cuando se trata de implementar nuevas funciones, gestionar deprecaciones y probar cambios. Queremos mejorar la experiencia del desarrollador utilizando nuestra plataforma Ads, por lo que hemos introducido el concepto de versionado de nuestros endpoints. Algunas definiciones de conceptos de los que hablamos: Versión: se refiere al número de versión que aparece en la ruta URL de cualquier solicitud a la Ads API, por ejemplo: GET //accounts. Este estilo de versionado se conoce como versionado por URI. Cambios incompatibles (Breaking Changes): los cambios incompatibles son cualquier cambio que requiera recursos de los desarrolladores para mantener la funcionalidad existente. Esto incluye recursos empleados para investigar los cambios que deben realizarse, determinar las funciones/endpoints que se están deprecando y la implementación final de todos estos cambios. Una lista de cambios incompatibles incluye cosas como:- Eliminar un parámetro de la solicitud/respuesta de la API
- Modificar el nombre de cualquier parámetro o endpoint
- Cambio en la representación de valores (preview_url → card_uri)
- Cambio en el comportamiento de los endpoints (p. ej., estadísticas asíncronas vs síncronas)
- Añadir/cambiar parámetros opcionales u obligatorios (p. ej., hacer que name sea un campo obligatorio en la solicitud)
Estrategia de versionado
Los principios principales de la estrategia son:- Todos los cambios incompatibles se agruparán en una nueva versión
- Las deprecaciones para versiones existentes cada vez que se anuncie una nueva versión son de 6 meses
- En cualquier momento dado, la API permitirá solicitudes de dos versiones simultáneamente, aunque la más antigua de las dos no tendrá soporte
- Para permitir una adopción más rápida de nuevos productos, estos se lanzarán de forma continua (fuera de la cadencia de versionado)
-
Todas las respuestas de la API incluirán un
x-current-api-versionque se establecerá en la versión actual de la API, además de una cabecerax-api-warnal llamar a cualquier endpoint deprecado de la API.
v9
Hoy, 3 de marzo de 2021, la Versión 9 (v9) de la X Ads API ya está disponible. Este lanzamiento está diseñado para aumentar la paridad de funcionalidades, simplificar la creación de campañas e introducir actualizaciones clave en nuestros endpoints de Cards y Promoción de aplicaciones móviles. Al igual que con nuestras versiones anteriores, habrá un periodo de transición de 6 meses para migrar a v9. El 31 de agosto de 2021, la versión 8 (v8) existente de la Ads API dejará de estar disponible. Animamos a todos los desarrolladores a migrar a la última versión de la Ads API lo antes posible para evitar interrupciones del servicio.Nota: a partir de este lanzamiento, la versión 7 (v7) de la Ads API ha llegado a su fin de vida útil y ya no está disponible.
v8
Hoy, 20 de septiembre de 2020, presentamos la versión 8 de la X Ads API, diseñada para introducir nueva funcionalidad de Tailored Audiences, aumentar la paridad de funcionalidades con ads.x.com y mejorar tu experiencia de desarrollo. Como en versiones anteriores, habrá un periodo de transición de 6 meses para migrar a v8. El 2021-03-02 la versión 7 de la Ads API dejará de estar disponible. Animamos a todos los desarrolladores a migrar a la última versión de la API lo antes posible para evitar interrupciones del servicio. Para todos los detalles, consulta el anuncio en el foro de desarrolladores.v7
Hoy, 20 de marzo de 2020, presentamos la versión 7 de la X Ads API, diseñada para aumentar la paridad de funcionalidades con ads.x.com. Como en versiones anteriores, habrá un periodo de transición de 6 meses para migrar a v7. El 2020-09-01, la versión 6 de la Ads API dejará de estar disponible. Animamos a todos los desarrolladores a migrar a la última versión de la API lo antes posible para evitar interrupciones del servicio. La versión 5 de la Ads API ha llegado a su fin de vida útil y ya no está disponible. Para todos los detalles, consulta el anuncio en el foro de desarrolladores.v6
Hoy, 28 de agosto de 2019, X presenta la Ads API v6, con actualizaciones centradas en la consistencia y la mejora de la experiencia del desarrollador. Este lanzamiento incluye un nuevo endpoint para recuperar Tweets, estadísticas para Promoted Accounts, la capacidad de buscar entidades por nombre e información sobre el número actual de trabajos asíncronos de analytics en proceso. Además, hemos realizado actualizaciones centradas en la consistencia en los endpoints que usan medios y en nuestros endpoints de targeting criteria. Por último, hemos hecho actualizaciones menores en algunos nombres de parámetros y atributos de respuesta y estamos deprecando el endpoint Scoped Timeline. Para todos los detalles, consulta el anuncio en el foro de desarrolladores.v5
Hoy, 28 de febrero de 2019, X presenta la Ads API v5, con actualizaciones centradas en habilitar la escala y la eficiencia. Este lanzamiento incluye un nuevo endpoint para determinar qué entidades han estado activas en un periodo dado, estadísticas para Media Creatives (es decir, In-stream videos e imágenes en la X Audience Platform), la capacidad de obtener múltiples cards por card URI y mayor flexibilidad en la obtención de targeting criteria y otras entidades. Además, hemos corregido algunos bugs y hemos realizado actualizaciones en nombres de parámetros y atributos de respuesta. Por último, se han deprecado las app cards sin media y el endpoint POSTaccounts/:account_id/account_media.
Como en versiones anteriores, habrá un periodo de transición de 6 meses para migrar a v5. El 2019-08-28, la versión 4 de la Ads API dejará de estar disponible. Animamos a todos los partners a migrar a la última versión de la API lo antes posible para evitar interrupciones del servicio. La versión 3 de la Ads API ha llegado a su fin de vida útil y ya no está disponible.
Nuevo
Determinar qué entidades han estado activas El endpoint Active Entities indica si las métricas de analytics para entidades de ads han cambiado. Diseñado para usarse junto con los endpoints de analytics, Active Entities funciona especificando un tipo de entidad y un rango de fechas —un máximo de 90 días— y devuelve un array de IDs de entidades para las que tu plataforma debería solicitar analytics. Los IDs distintos de los devueltos no deberían consultarse en solicitudes de analytics posteriores. Este endpoint admite los siguientes tipos de entidad:CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, MEDIA_CREATIVE y PROMOTED_TWEET.
Estadísticas de MEDIA_CREATIVE
Los endpoints de analytics de la Ads API ahora proporcionan métricas para entidades Media Creative. Los Media Creatives son la forma en la que se promocionan los in-stream ads o imágenes en la X Audience Platform. La UI de X Ads muestra las métricas de Media Creative en las pestañas “In-stream videos” y “Display creatives”. Tanto los endpoints de analytics síncronos como asíncronos ahora admiten el enum de entidad MEDIA_CREATIVE.
Obtener múltiples cards
Mejorando el lanzamiento en v3 del endpoint diseñado para recuperar una sola card por su valor card URI, ahora es posible obtener múltiples cards usando el endpoint GET accounts/:account_id/cards/all. Ahora, en lugar de hacer una solicitud por cada card, puedes recuperar hasta 200 cards en una sola solicitud.
Dos cosas a tener en cuenta:
- La ruta URL ahora es
accounts/:account_id/cards/all. (La ruta anterior ya no está disponible.) Esto es para ser consistente con el endpoint diseñado para recuperar una card por ID. - El parámetro de solicitud obligatorio ahora se llama card_uris (en plural).
- GET accounts/:account_id/line_item_apps
- GET accounts/:account_id/media_creatives
- GET accounts/:account_id/promoted_accounts
- GET accounts/:account_id/preroll_call_to_actions
Cambiado
Recuperación de campañas y line items en borrador Se ha actualizado la forma de recuperar campañas y line items en borrador. Ahora, el parámetro with_draft(boolean), cuando se establece en true, devuelve tanto entidades en borrador como no en borrador. Esto es consistente con la forma en que se recuperan las entidades eliminadas (es decir, usando with_deleted). Anteriormente, obtener tanto entidades en borrador como no en borrador requería al menos dos solicitudes. Ahora, esto puede hacerse en una sola llamada a la API. | v4 | v5 | | :--- | :--- | :--- | |draft_only | with_draft | |
Segmentación por duración de activación de red
La Ads API ha resuelto un problema de visualización en el que, tras añadir la segmentación Network Activation Duration, se