Descripción general
- 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 (por ejemplo, estadísticas async vs sync)
- Agregar/cambiar parámetros opcionales u obligatorios (por ejemplo, hacer que name sea un campo obligatorio en la solicitud)
Estrategia de versionado
- Todos los cambios incompatibles se agruparán en una nueva versión
- El periodo de deprecación de las versiones existentes cuando se anuncie una nueva versión será de 6 meses
- En cualquier momento, la API permitirá solicitudes desde dos versiones simultáneamente; sin embargo, la más antigua de las dos no tendrá soporte
- Para facilitar 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 contendrán un
x-current-api-version, que se establecerá en la versión actual de la API, además de un encabezadox-api-warncuando se llamen endpoints de API en deprecación.
v9
Nota: A partir de esta versión, la versión 7 (v7) de la Ads API ha llegado al final de su vida útil y ya no está disponible.
v8
v7
v6
v5
accounts/:account_id/account_media se han declarado obsoletos.
Como en versiones anteriores, habrá un período 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. Recomendamos a todos los socios que migren a la versión más reciente de la API tan pronto como sea posible para evitar cualquier interrupción del servicio. La versión 3 de la Ads API ha llegado al final de su vida útil y ya no está disponible.
Nuevo
CAMPAIGN, FUNDING_INSTRUMENT, LINE_ITEM, MEDIA_CREATIVE y PROMOTED_TWEET.
Estadísticas de MEDIA_CREATIVE
Los endpoints de analítica del Ads API ahora proporcionan métricas para entidades Media Creative. Los Media Creatives son la forma en que se promocionan los anuncios in-stream o las imágenes en la X Audience Platform. La interfaz de X Ads muestra las métricas de Media Creative en las pestañas “In-stream videos” y “Display creatives”. Tanto los endpoints de analítica sincrónicos como asincrónicos ahora admiten el enum de entidad MEDIA_CREATIVE.
Obtener varias cards
Mejorando la versión v3 del endpoint diseñado para recuperar una sola card por su valor de URI de card, ahora es posible obtener varias cards utilizando 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 de URL ahora es
accounts/:account_id/cards/all. (La ruta anterior ya no está disponible.) Esto es para mantener la coherencia con el endpoint diseñado para recuperar una card por ID. - El parámetro de solicitud obligatorio ahora se llama card_uris (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
Changed
Recuperación de campañas y elementos de línea en borrador Se ha actualizado la forma en que se recuperan las campañas y los elementos de línea en borrador. Ahora, el parámetrowith_draft(boolean), cuando se establece en true, devuelve tanto entidades en borrador como entidades que no están en borrador. Esto es coherente 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 se puede hacer 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 corregido un problema de visualización en el que, después de agregar la segmentación de Network Activation Duration, el tipo de segmentación en la respuesta incluía el sufijo _IN_SEC. Hacer referencia a segundos resultaba confuso, ya que Network Activation Duration siempre se representa en meses. Esta corrección hace que la representación sea coherente y reduce la confusión.
| v4 | v5 |
| :--- | :--- | :--- |
| NETWORK_ACTIVATION_DURATION_IN_SEC | NETWORK_ACTIVATION_DURATION | |
Recuentos totales y cursores
En v5, with_total_count y cursor son exclusivos. Especificar ambos en una solicitud devolverá el código de error EXCLUSIVE_PARAMETERS. Antes de v5, with_total_count se ignoraba cuando se especificaba cursor. Este cambio hace que la relación sea explícita.
Eliminados
- En v4, se anunció que el parámetro de respuesta preview_url para las cards siempre era null. El paso final en esta migración es eliminar preview_url de todas las respuestas de cards.
- El atributo de respuesta account_id se está eliminando para los siguientes recursos, dado que el id de la cuenta de anuncios ya está presente en la URL, así como en request.params. (Es intencional excluir los instrumentos de financiación de esta lista, ya que los id padre deberían estar presentes en los objetos de respuesta, cuando sea posible, y los id de cuenta son entidades padre de los instrumentos de financiación).
- Medios de cuenta
- Proveedores de eventos de App
- Etiquetas de eventos de App
- Campañas
- Cards
- Line items
- Usuarios promocionables
- Criterios de segmentación
- Para las solicitudes GET accounts/:account_id/targeting_criteria, ya no devolvemos el campo parent_ids, ya que siempre era un array vacío.
- Nota: Esto no afecta a las cards de descarga de App de imagen y video.
- Los recursos
AMPLIFY_VIDEOagregados a la Media Library se agregan automáticamente como recursos de Account Media con el tipo creativoPREROLL. - Las imágenes con dimensiones específicas agregadas a la Media Library se agregan automáticamente como recursos de Account Media. El tipo creativo (por ejemplo,
INTERSTITIAL) depende de las dimensiones de la imagen. (Para las dimensiones, consulta nuestra página de Enumerations.)
v4
Nuevo
- TON Upload:
- GET accounts/:account_id/tailored_audience_changes
- GET accounts/:account_id/tailored_audience_changes/:tailored_audience_change_id
- POST accounts/:account_id/tailored_audience_changes
- PUT accounts/:accounti_d/tailored_audiences/global_opt_out
- Real Time Audiences:
- POST tailored_audience_memberships
list_type se eliminará de la solicitud y la respuesta en todos los endpoints de Tailored Audiences en la versión 4.
Settings Endpoints
Ahora permitimos que los administradores de cuentas establezcan y actualicen la configuración de usuario, cuenta e impuestos. La configuración de usuario corresponde a las preferencias de contacto específicas del usuario para una cuenta de anuncios determinada. Mediante el endpoint PUT accounts/:account_id, los anunciantes ahora pueden actualizar el nombre de su cuenta y el tipo de industria. Por último, los endpoints de configuración de impuestos permiten a los anunciantes en países donde se cobra un impuesto al valor agregado (IVA) actualizar información como el nombre de la empresa, la dirección, el ID de IVA y si la cuenta es propiedad del anunciante o de una agencia que anuncia en nombre de un anunciante.
Cambiado
lookalike_expansion en los endpoints POST accounts/:account_id/line_items y PUT accounts/:accountit/line_items/:line_item_id.
Uso de
country_code en todas partes
Como parte de un esfuerzo más amplio relacionado con la consistencia en la Ads API, estamos cambiando el nombre de los parámetros en los siguientes endpoints de app_country_code a country_code.
- POST accounts/:account_id/cards/image_app_download
- PUT accounts/:account_id/cards/image_app_download/:card_id
- POST accounts/:account_id/cards/video_app_download
- PUT accounts/:account_id/cards/video_app_download/:card_id
preview_url siempre null
Tal como se prometió en el anuncio de v3, todas las tarjetas existentes ahora tienen un card_uri. Como resultado, el valor de preview_url siempre será null.
Como recordatorio, asocia una tarjeta con un Tweet usando su valor card_uri. Consulta el siguiente ejemplo de solicitud.
$ twurl -X POST -H ads-api.x.com “/4/accounts/18ce54d4x5t/tweet?text=Version 4&card_uri=card://958225772740714496”
Eliminado
Endpoints de video Los endpoints accounts/:account_id/videos ya no estarán disponibles en v4. Este endpoint ha quedado obsoleto debido a la introducción de los endpoints de Media Library. Consulta la siguiente comparación de uso.-
endpoint de videos v3:
twurl -H ads-api.x.com "/3/accounts/18ce54d4x5t/videos" -
endpoint v4 de Media Library para videos:
twurl -H ads-api.x.com "/4/accounts/18ce54d4x5t/media_library?media_type=VIDEO"
as_user_id en la vista de Tweet
El parámetro as_user_id disponible en el endpoint GET accounts/:account_id/tweet/preview/:tweet_id ya no será aceptado. La vista previa siempre se mostrará como si fuera del autor del Tweet.
v3
- Dada una audiencia de entrada, recuperar los hashtags principales, @handles y eventos más relevantes.
- Dada una audiencia de entrada, recuperar información demográfica clave (como edad, género e ingresos del hogar).
- Dada una palabra clave, recuperar la serie temporal del volumen de Tweets.
Otros cambios
- La respuesta del endpoint GET insights/keywords/search ahora incluye un atributo related_keywords con 30 términos relacionados con las palabras clave de entrada.
- El tamaño máximo del lote de criterios de segmentación ahora es 500.
- Los atributos de respuesta card_uri y preview_url ahora son mutuamente excluyentes. Cuando una card tiene un card_uri, preview_url será null. Cuando una card no tiene un card_uri, solo se devolverá preview_url.
- Todas las cards creadas a partir de 2018-01-29 tendrán un card_uri.
- Para la versión 4, todas las cards existentes tendrán un card_uri.
- Ya no es posible crear cards con imágenes 5:2. Aunque las cards existentes basadas en imágenes 5:2 seguirán funcionando, recomendamos a los socios cambiar a las relaciones de aspecto con mejor rendimiento 1.91:1 o 1:1 (cuando se admitan).
- El endpoint PUT accounts/:account_id/targeting_criteria ya no está disponible. Hemos decidido realizar este cambio porque el comportamiento de reemplazo de este endpoint generaba confusión entre los anunciantes y no era coherente con nuestros otros endpoints PUT, que actualizan un único recurso a la vez. En su lugar, los socios deben usar el endpoint POST batch/accounts/:account_id/targeting_criteria, que proporciona una mayor flexibilidad, incluida la capacidad de agregar y eliminar segmentación en una sola solicitud.
- El atributo de respuesta paused ya no se devuelve para los instrumentos de financiación. En su lugar, consulte el atributo de respuesta entity_status para determinar si un instrumento de financiación está en pausa o no. Además, dado que paused y cancelled corresponden al mismo valor, cancelled tampoco se devuelve ya en la respuesta.
- Hemos eliminado el parámetro card_id del endpoint GET accounts/:account_id/tweet/preview.
- Dado que no es posible recuperar Tweets programados eliminados, el parámetro with_deleted ya no se admite.
- El parámetro draft_only se ha eliminado de los siguientes endpoints, ya que estas entidades nunca pueden estar en estado de borrador:
v2
-
total_countahora es un atributo de respuesta opcional. Solo estará disponible siwith_total_countse establece entrue -
Los campos
pausedydraft_onlyen los objetos de solicitud y respuestaline_itemsycampaignsse sustituyen por un único parámetroentity_status -
El parámetro
statusha pasado a llamarsetexten los endpoints POST accounts/:account_id/tweet y GET accounts/:account_id/tweet/preview -
Los valores enumerados
location_typedel endpoint GET targeting_criteria/locations ahora son plurales.COUNTRYahora esCOUNTRIES,REGIONahora esREGIONS, y así sucesivamente. La única excepción es que, en v2,CITYahora esMETROS, para reflejar correctamente el hecho de que el tipo de ubicación se refiere a Designated Marker Areas (DMA) o “metros”. -
display_propertiesen los endpoints PUT accounts/:account_id/promoted_tweets. Este valor tampoco se devolverá ya como parte de la respuesta - Como resultado del punto anterior, ya no es posible actualizar (PUT) entidades promoted_tweets
-
Se ha eliminado el parámetro
line_item_iden el endpoint GET accounts/:account_id/promoted_tweets - Ya no será posible crear Website Cards 5:2 en los endpoints v2
-
El atributo de respuesta
data_typeya no se devuelve
- Cards v2
- Creación y activación de campañas/line items en borrador
- Tweets programados
- Resúmenes de trabajos asíncronos
- Se debe usar el parámetro de solicitud
card_urien lugar de añadirpreview_urlal texto del Tweet cuando se asocia una tarjeta con un Tweet - Si el parámetro
card_urino se devuelve en la respuesta (durante el paso de creación de la tarjeta), utilice entoncespreview_url - Todos los nuevos formatos de tarjeta estarán disponibles de forma nativa en la API, aprovechando el parámetro
card_uri.
- Video Website Cards:
- El valor del parámetro
entity_statusen los endpoints POST accounts/:account_id/line_items y POST accounts/:account_id/campaigns se puede establecer enDRAFTpara crear cualquier nueva campaña o línea de pedido en borrador. - Conjunto de parámetros obligatorios para un borrador recién creado:
Notas¶
- Las líneas de pedido o campañas en borrador solo se pueden convertir de un
entity_statusdeDRAFTaPAUSEDoACTIVE. - Para activar una campaña completa (con múltiples líneas de pedido), cada línea de pedido dentro de la campaña, así como la propia campaña, deben establecerse con un
entity_statusdeACTIVE. - Para cambiar el
entity_statusde cualquier campaña o línea de pedido, utiliza el endpoint PUT correspondiente.
- Los Tweets programados incluyen los siguientes endpoints nuevos:
- Tweets programados:
- Administración de campañas:
- Los nuevos Tweets programados se pueden configurar para cualquier fecha futura.
- Actualmente, no es posible previsualizar un Tweet programado.
-
Solo los Tweets programados en el estado
SCHEDULEDpueden editarse o eliminarse. -
Los Tweets programados no se propagan al Firehose empresarial ni a ninguna otra API de datos hasta la fecha/hora
scheduled_at.
v1
- Compatibilidad con versiones
CUSTOMobjective ya no se admite- Los endpoints por lotes ya están disponibles de forma general
- Cambios en las estimaciones de alcance:
- Para ofrecer una mejor estimación del alcance, el endpoint ahora tiene en cuenta el presupuesto. Ahora se requieren los siguientes parámetros:
- [nuevo]
campaign_daily_budget_amount_local_micro currencybidobjective
- [nuevo]
- El objeto de respuesta ha cambiado y ahora devuelve rangos de valores en la respuesta.
infinite_countse ha renombrado comoinfinite_bid_countpara evitar confusión sobre su finalidad- Además de
counteinfinite_bid_count, ahora se devolverán los siguientes nuevos datos:impressionsengagementsestimated_daily_spend_local_micro
- Cambio de tipo de datos para audiencias personalizadas
- El
data_typecorrespondiente a Tailored Audiences se ha cambiado detailored_audiencesatailored_audienceen todas nuestras respuestas. - Las Shared Tailored Audiences ahora están disponibles en versión beta solo mediante API. Las Shared Tailored Audiences permiten que una única audiencia se utilice en varias cuentas publicitarias. Usa el endpoint POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions (y los relacionados) para administrar los permisos de una audiencia personalizada que quieras compartir entre varias cuentas publicitarias.
- Mejoras significativas en cómo recopilas métricas de rendimiento para cuentas de anunciantes:
- Para alinearnos con nuestras mejores prácticas, ahora solo permitiremos recuperar hasta 7 días de datos para los endpoints síncronos de estadísticas.
- Para simplificar la recuperación de métricas, hemos reemplazado el parámetro
metricspor un nuevo parámetrometric_groups. Los desarrolladores solo tienen que indicar qué grupos de métricas quieren que se devuelvan para una solicitud determinada.- Cualquier solicitud de métricas que no sean apropiadas para una entidad determinada se excluirán de la respuesta y se representarán como valores
null. Estas métricas no se contabilizarán para tu límite de costos de análisis.
- Cualquier solicitud de métricas que no sean apropiadas para una entidad determinada se excluirán de la respuesta y se representarán como valores
- La respuesta se ha simplificado significativamente y ahora se alineará mejor con la forma en que las métricas se exponen en nuestra interfaz de usuario.
- Anteriormente exponíamos una métrica separada para cada ubicación (Tweets promocionados en Búsqueda, Tweets promocionados en cronologías, Tweets promocionados en perfiles y detalles del Tweet, X Audience Platform). Ahora devolveremos un conjunto estandarizado de métricas para cada una (en lugar de
promoted_tweet_timeline_impressions,promoted_tweet_search_impressions,promoted_tweets_profile_impressions,promoted_tweets_tpn_impressions), que se expondrán, cuando se soliciten en una de las siguientes categorías, como una única métrica,impressions(esto se aplica a todas las métricas): ALL_ON_TWITTERPUBLISHER_NETWORK- Cuando realices una solicitud, obtendrás una única métrica
impressionspara que hacer corresponder los valores en nuestra interfaz de usuario sea más sencillo. - Debes hacer dos consultas para obtener tanto los datos de
ALL_ON_TWITTERcomo dePUBLISHER_NETWORK, ya que no se pueden combinar.
- Anteriormente exponíamos una métrica separada para cada ubicación (Tweets promocionados en Búsqueda, Tweets promocionados en cronologías, Tweets promocionados en perfiles y detalles del Tweet, X Audience Platform). Ahora devolveremos un conjunto estandarizado de métricas para cada una (en lugar de
- Los endpoints de estadísticas asíncronas ya están disponibles gracias a los comentarios de nuestros desarrolladores.
- Un nuevo conjunto de endpoints para solicitar estadísticas de forma asíncrona, para datos que no necesitas de inmediato o para recuperar datos históricos.
- Coloca en cola una tarea de estadísticas mediante un único endpoint nuevo. Obtendremos los datos que has solicitado según lo permitan los recursos.
- Puedes consultar un endpoint de estado de la tarea para comprobar si los datos están disponibles.
- Una vez que los datos estén disponibles, proporcionaremos un ID de recogida para que descargues la respuesta JSON, que reflejará la respuesta del endpoint síncrono.
- Consulta hasta 90 días de datos de hasta 20 entidades en una sola tarea.
- Consulta nuestra guía de migración de analytics v1, que incluye la correspondencia entre las métricas de v0 y las de v1
- Mejoras del Sandbox * Ahora puedes crear varias cuentas de anuncios de prueba en el entorno Sandbox. * Ahora puedes crear varios instrumentos de financiación para una cuenta de anuncios de prueba, solo en el entorno Sandbox. Esto te permite hacer pruebas con todos nuestros tipos de instrumentos de financiación. Antes, solo estaba disponible una fuente de financiación
CREDIT_CARDpara realizar pruebas. * ¿Quieres probar una función beta? Ahora puedes activar o desactivar funciones para una cuenta en el entorno Sandbox y ajustarlas a tus necesidades de prueba.