Descripción general
- POST accounts/:account_id/cards Tweets:
- POST accounts/:account_id/tweets - Para agregar tarjetas a los Tweets, use el parámetro card_uri. Tweets programados:
- POST accounts/:account_id/scheduled_tweets
Cards
Imagen
- Sitio web: 1:1 y 1.91:1
- Descarga de App con imagen: 1:1 y 1.91:1
- Encuesta: 1.91:1
- Conversación con imagen: 1.91:1
- Mensaje directo con imagen: 1.91:1
Video
- Video de sitio web: 16:9 y 1:1
- Descarga de App en video: 16:9 y 1:1
- Encuesta: 16:9
- Conversación en video: 16:9
- Mensaje directo en video: 16:9
Video promocionado
media_id
, asocia el video a una cuenta de anuncios usando el endpoint POST accounts/:account_id/videos. El id
del video, a veces denominado media_key
, se utilizará en solicitudes posteriores. Es una cadena que comienza con un int, seguida de un guion bajo y termina con un valor long. Por ejemplo: 13_875943225764098048
.
Video promocionado en Tweets
id
del video. En este paso, también puedes proporcionar un título del video, una descripción y un llamado a la acción (CTA). Estos valores se mostrarán a los usuarios.
Video promocionado en tarjetas
- POST accounts/:account_id/cards/video_website
- POST accounts/:account_id/cards/video_app_download
- POST accounts/:account_id/cards/video_conversation
id
del video y, opcionalmente, el media_id
de la imagen (para la imagen de portada).
Por último, crea el Tweet con el endpoint POST accounts/:account_id/tweet. Las tarjetas se adjuntan a los Tweets usando el parámetro card_uri
.
Información general
- (A partir de 2015-10-22) Al cargar videos para usarlos en contenido promocionado, el parámetro
media_category
debe establecerse con el valoramplify_video
para todas las solicitudes del comandoINIT
al endpoint POST media/upload (chunked). El uso de este parámetro garantiza que el video se procese de forma asíncrona y se prepare para su uso en contenido promocionado. El comandoSTATUS
se puede usar para comprobar la finalización del procesamiento asíncrono después de cargar el video. - La duración máxima permitida para videos promocionados es actualmente de 10 minutos, con un tamaño de archivo de 500 MB o menos.
- El video cargado debe ser MP4 o MOV.
- El video cargado generalmente se procesa con rapidez, pero los tiempos de procesamiento pueden variar según la duración del video y el tamaño del archivo.
- Las imágenes de póster cargadas deben estar en formato PNG o JPG. No hay requisitos de relación de aspecto ni de tamaño, pero la imagen de póster se ajustará para adaptarse al reproductor de video.
Guías
Tweets programados
Introducción
- Crear, modificar y ver Tweets programados
- Asociar un Tweet programado con un elemento de línea
- Consultar y administrar Tweets programados existentes
- Una vez que un Tweet programado esté publicado, recuperar el
id
del Tweet en vivo
Endpoints de la API
Gestión de Tweets programados
- GET accounts/:account_id/scheduled_tweets (obtener la lista de todos los Tweets programados)
- GET accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (consultar un Tweet programado específico utilizando su
id
) - POST accounts/:account_id/scheduled_tweets (crear un nuevo Tweet programado)
- PUT accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (modificar un Tweet programado existente)
- DELETE accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (eliminar un Tweet programado utilizando su
id
) - GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (vista previa de un Tweet programado existente)
Tweets promocionados programados
- GET accounts/:account_id/scheduled_promoted_tweets (obtiene una lista de todos los Tweets promocionados programados)
- GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (consulta un Tweet promocionado programado mediante su
id
) - POST accounts/:account_id/scheduled_promoted_tweets (crea un nuevo Tweet promocionado programado)
- DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (elimina un Tweet promocionado programado existente mediante su
id
)
Vista de Tweet programado
- GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (ver un Tweet programado existente)
Creación de Tweet programado:
- Valide que el usuario autenticado tenga acceso para crear Tweets orgánicos para un @handle determinado. Los privilegios para crear Tweets “solo promocionados” requieren que el usuario autenticado sea un usuario de la cuenta con permisos del compositor de Tweet.
- Valide que no haya más de 30 Tweets programados para crearse dentro de una ventana de 15 minutos respecto a la hora scheduled_at. Un mensaje de error SCHEDULED_TWEET_LIMIT_EXCEEDED indica que se han programado demasiados Tweets dentro del mismo intervalo futuro de 15 minutos. Los anunciantes deberán eliminar un Tweet programado existente o mover la hora scheduled_at hacia antes o hacia después.
El Tweet programado se “publica”:
- Estas reglas de validación se ejecutan en el momento de scheduled_at y son idénticas a las aplicadas en la creación normal de Tweets en la API. Por ejemplo, un Tweet programado no se publicará y el scheduled_status se establecerá en FAILED si el Tweet programado contiene una imagen y un GIF a la vez.
Flujo de trabajo
scheduled_at
, junto con el text
del Tweet si no se incluyen entidades multimedia en el Tweet. Además, este endpoint ofrece algunas opciones adicionales que permiten crear un Tweet programado en nombre de otro @handle mediante el parámetro as_user_id
, así como la posibilidad de agregar una tarjeta (card_uri
) y cualquier contenido multimedia (media_ids
). Nota: un Tweet solo puede contener entidades del mismo tipo, es decir, Video, GIF o Imagen. El parámetro nullcast
controla si el Tweet es “solo promocionado” o no. Todos los Tweets programados recién creados son “solo promocionados” (nullcast=true
) de forma predeterminada. Si nullcast=false
, entonces se crea un Tweet programado orgánico.
Una vez que un Tweet programado se crea correctamente, la respuesta contendrá un campo id
, que se refiere al identificador único del propio Tweet programado. Además de este campo, también se devuelve otro campo llamado tweet_id
. Este campo es null
inicialmente; sin embargo, una vez que el Tweet se publique, este campo se completa con el ID del Tweet “en vivo”.
tweet_id
se completará con el ID del Tweet “en vivo”.
Ver un Tweet programado
El endpoint GET accounts/:account_id/tweet_previews puede utilizarse a continuación con el id
del Tweet programado del paso anterior para generar una vista previa del Tweet. La respuesta de la API contendrá una URL de iframe lista para usar que permitirá renderizar una vista previa del Tweet programado. El CSS y las imágenes pertinentes se servirán directamente a través de X.
nullcast=true
), cualquiera de los cuales puede asociarse con un elemento de línea. Para facilitar esto, también ofrecemos un endpoint POST accounts/:account_id/scheduled_promoted_tweets. Este endpoint solo permite asociar un único Tweet programado promocionado con un elemento de línea en una sola llamada a la API. Para asociar varios Tweets programados al mismo elemento de línea, son necesarias varias llamadas a la API.
Tenga en cuenta que no es posible modificar un Tweet programado promocionado existente.
SCHEDULED
y que el Scheduled Tweet proporcionado sea válido para el objetivo indicado, no se ejecutan otras validaciones. Cualquier regla de validación restante que aplique al line item y al Scheduled Tweet se ejecuta cuando el Tweet pasa a estar “en vivo”.
Para garantizar que no haya problemas con la entrega de la campaña, se recomienda que el Scheduled Tweet tenga scheduled_at
un horario anterior a las fechas de flight de la campaña/line item.
Por ejemplo, supongamos que el Scheduled Tweet está configurado para pasar a estar en vivo después de la fecha de inicio de la campaña (y que solo hay un único Tweet asociado con un único line item): la campaña estará ACTIVE
; sin embargo, dado que el Scheduled Tweet aún no está en vivo, no habrá creativos disponibles para su entrega.
Gestión de Scheduled Tweet
Los conjuntos restantes de endpoints permiten a los consumidores de la API gestionar todos sus Scheduled Tweets y Scheduled Promoted Tweets. Estas APIs pueden usarse para devolver una lista de todos los Scheduled Tweets, opcionalmente filtrados por un estado dado, así como para buscar un Scheduled Tweet específico por su id
.
¿Qué sucede cuando un Tweet programado se publica?
scheduled_at
, se realizan las siguientes actualizaciones:
- Se crea el Tweet “publicado”; sin embargo, puede haber una latencia de hasta 1 segundo
- El
tweet_id
se agrega a las siguientes entidades: - Tweet programado
- Tweet programado promocionado
- Se crea una nueva entidad de Tweet promocionado
Mejores prácticas
- Asegúrate de que el Tweet sea válido al crear el Tweet programado (por ejemplo, un Tweet solo puede incluir una imagen, un video o un GIF, y no una combinación de los tres)
- Asegúrate de que las fechas de la campaña (es decir,
start_time
yend_time
) estén alineadas con la horascheduled_at
del Tweet programado - No programes Tweets con más de un año de antelación (365 días)
- Actualmente no se admite la vista previa de Tweets programados (es decir, la posibilidad de previsualizarlos antes de crearlos)
Biblioteca multimedia
Introducción
Endpoints de la API
- POST media/upload o POST media/upload (por partes) (subir contenido multimedia)
- POST accounts/:account_id/media_library (añadir contenido multimedia a la Biblioteca de medios)
Adición a la biblioteca
Parámetros de la solicitud
Atributos
Uso
Identificación de Cards
Introducción
card_uri | preview_url |
---|---|
card://1043282691834048513 | https://cards.x.com/cards/18ce54d4x5t/68w3s |
Identificación de Tweets con card_uri
Para los Tweets creados con el valor de URI de la tarjeta, busque la referencia a la tarjeta en el atributo de respuesta card_uri. El siguiente ejemplo de respuesta utiliza el endpoint GET accounts/:account_id/tweets.Identificación de Tweets con preview_url
Para los Tweets creados al incluir la URL de vista previa como parte del texto del Tweet, la URL se puede encontrar en entities[“urls”][i][“expanded_url”] (el campo text incluye una URL acortada de t.co), donde i es un índice de matriz (un Tweet puede contener varias URL). En los objetos de Tweet programados y en borrador, la URL de vista previa siempre aparecerá en el campo text.Obtención de cards
Identificación de medios
Introducción
ID de contenido multimedia | Clave de contenido multimedia |
---|---|
1029825579531807971 | 13_1029825579531807971 |
Imágenes
Recurso | Identificador | Atributo(s) |
---|---|---|
Tarjetas de imagen | Ninguno | |
Tweet | Ambos | entities["media"]["id_str"] entities["media"]["media_key"] |
Tweet programado | Ambos | media_ids y media_keys |
Borrador de Tweet | Ambos | media_ids y media_keys |
Medios de la cuenta | Ninguno | |
Biblioteca de medios | Ambos | media_id y media_key |
Recurso | Atributo(s) | Formato |
---|---|---|
Tarjetas de imagen | image | .jpg |
Tweet* | entities["media"][0]["media_url"] o extended_entities["media"][i]["media_url"] | .jpg |
Tweet programado | Ninguno | |
Borrador de Tweet | Ninguno | |
Medios de la cuenta | media_url | .jpg |
Biblioteca de medios | media_url | .jpg |
- Estas ubicaciones de URL dependen de si el Tweet contiene una sola imagen o varias imágenes.
Videos
Resource | Identifier | Attribute(s) |
---|---|---|
Video cards | May be either | video_content_id |
Video poll cards | None | |
Tweet | Both | entities["media"]["id_str"] entities["media"]["media_key"] |
Scheduled Tweet | Both | media_ids and media_keys |
Draft Tweet | Both | media_ids and media_keys |
Account Media | Media key | video_id |
Media Library | Both | media_id and media_key |
Resource | Attribute(s) | Format |
---|---|---|
Video cards | video_url and video_hls_url | .vmap .m3u8 |
Tweet with video | extended_entities["media"][i]["video_info"]["variants"][j]["url"] | .mp4 |
Scheduled Tweet | None | |
Draft Tweet | None | |
Account Media | None | |
Media Library | media_url | .mp4 |
Biblioteca de medios
Recurso | En la Biblioteca de medios |
---|---|
Tarjetas de imagen | No |
Tarjetas de video | Sí* |
Tweets (cualquier medio)** | Sí |
Tweets programados | Sí |
Tweets en borrador | Sí |
Imágenes de Account Media | No |
Videos de Account Media (PREROLL ) | Sí |
- Para tarjetas donde
video_content_id
es una media key. Cuando el valor es un media ID, el recurso sigue existiendo en la Biblioteca de medios, pero recuperarlo implica anteponerle un prefijo numérico y un guion bajo. ** Los Tweets solo devuelven media IDs. Si bien se garantiza que el recurso existe en la Biblioteca de medios, obtenerlo implica anteponerle un prefijo numérico y un guion bajo.
- Cuando se agrega un recurso AMPLIFY_VIDEO a la Biblioteca de medios, se agrega automáticamente como un recurso de Account Media con el tipo creativo PREROLL.
- Cuando se agregan a la Biblioteca de medios imágenes que tienen dimensiones específicas (consulta “Creative Types” en nuestra página de enumeraciones), se agregan automáticamente como recursos de Account Media. El tipo creativo (p. ej., INTERSTITIAL) depende de las dimensiones de la imagen.
Tweets
Introducción
Tweets nullcasted
Promocionar Tweets
IDs de Tweet
Carruseles
Introducción
- Cargar multimedia
- Crear la tarjeta
- Crear el Tweet
- Promocionar el Tweet
Endpoints
Cuerpo de la solicitud POST en JSON
- Un componente
SWIPEABLE_MEDIA
, que acepta un array de claves de medios - Uno de los siguientes:
- Un componente
DETAILS
para especificar información del sitio web - Un componente
BUTTON
para especificar información de la App
SWIPEABLE_MEDIA
debe incluir un array media_keys
en el que se pueden especificar entre 2 y 6 imágenes o videos. El orden en que se pasan las claves de medios determina el orden en que se renderizarán.
Sitio web | App | |
---|---|---|
Especificar el tipo de componente | "type": "DETAILS" | "type": "BUTTON" |
Título/Etiqueta | "title": "X" | "label": { "type": "ENUM", "value": "INSTALL" } |
Destino | "destination": { "type": "WEBSITE", "url": "https://www.x.com" } | "destination": { "type": "APP", ... } |
BUTTON
requieren un código de país y al menos un identificador de App. Opcionalmente aceptan enlaces profundos (deep links). Para una descripción de estos campos, consulta la documentación de referencia.
Con todo esto, a continuación se muestra un ejemplo de cuerpo de POST en JSON para un carrusel de App.
Ejemplo
media_type
para acotar los resultados a un tipo de medio específico.
card_uri
, que se utilizará al crear un Tweet.
Tweet
Use el endpoint POST accounts/:account_id/tweet para crear su Tweet. Utilice el card_uri
de la solicitud anterior. (Respuesta truncada por legibilidad.)
etiquetado-de-metadata-creativa
Introducción
Etiquetado de recursos creativos
exiftool -contributor="<YOUR APP ID>" -creative_file.jpg
exiftool -date="<date>" -creative_file.jpg
El app_id se puede encontrar en el portal de desarrolladores en Projects & Apps. Ejemplo: 16489123
El siguiente ejemplo agrega app_id como etiqueta contributor y date como etiqueta date para una imagen:
exiftool -xmp:all -G1 <filename>
Ejemplo:
exiftool -xmp:all -G1 eiffel_tower.jpg
¿Preguntas?
Referencia de la API
Contenido multimedia de la cuenta
GET accounts/:account_id/account_media
Recupera los detalles de parte o de todos los medios de la cuenta asociados con la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/account_media
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | 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 |
account_media_ids opcional | Limita la respuesta únicamente a los medios de la cuenta deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 3wpx |
count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 200 Min, Max: 1 , 1000 |
creative_types opcional | Limita la respuesta únicamente a los medios de la cuenta que coincidan con los tipos creativos especificados. Se puede indicar más de un tipo creativo separando con comas los valores del enum. Type: enum Possible values: BANNER , BANNER_TABLET , INTERSTITIAL , INTERSTITIAL_LANDSCAPE , INTERSTITIAL_LANDSCAPE_TABLET , INTERSTITIAL_TABLET , MEDIUM_RECTANGLE , PREROLL , VAST_PREROLL |
cursor opcional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información. Type: string Example: 8x7v00oow |
sort_by opcional | Ordena por un atributo compatible 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 la 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/account_media?account_media_ids=3wpx
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_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 |
account_media_id obligatorio | Una referencia al contenido multimedia de la cuenta con el que se opera en la solicitud. Tipo: string Ejemplo: 2pnfd |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: false Valores posibles: true , false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_id
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta correspondiente. 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 |
account_media_id obligatorio | Una referencia al contenido multimedia de la cuenta con el que se opera en la solicitud. Type: string Example: 2pnfd |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd
Ejemplo de respuesta
Tarjetas
card_uri
con cualquiera de los endpoints POST accounts/:account_id/tweet, POST statuses/update, POST accounts/:account_id/scheduled_tweets o POST accounts/:account_id/draft_tweets .
Recupera los detalles de algunas o todas las tarjetas asociadas con la cuenta actual.
Nota: Esto solo devuelve las tarjetas que se crearon mediante el endpoint POST accounts/:account_id/cards. Las tarjetas creadas mediante otros endpoints no se devuelven.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards
Parámetros
Name | Description |
---|---|
account_id required | 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 |
card_types optional | Limita la respuesta a los tipos de tarjeta deseados especificando una lista de valores enum separados por comas. Tipo: enum Valores posibles: IMAGE_APP , IMAGE_CAROUSEL_APP , IMAGE_CAROUSEL_WEBSITE , IMAGE_MULTI_DEST_CAROUSEL_WEBSITE , IMAGE_WEBSITE , MIXED_MEDIA_MULTI_DEST_CAROUSEL_WEBSITE , MIXED_MEDIA_SINGLE_DEST_CAROUSEL_APP , MIXED_MEDIA_SINGLE_DEST_CAROUSEL_WEBSITE , VIDEO_APP , VIDEO_CAROUSEL_APP , VIDEO_CAROUSEL_WEBSITE , VIDEO_MULTI_DEST_CAROUSEL_WEBSITE , VIDEO_WEBSITE |
card_id optional | Limita la respuesta a las tarjetas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id de tarjetas. Tipo: string Ejemplo: 1044294149527166979,1044301099031658496 |
card_uris optional | Limita la respuesta a las tarjetas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 valores de URI de tarjeta. Tipo: string Ejemplo: card://1044294149527166979,card://1044301099031658496 |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: 100 Mín., máx.: 1 , 200 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
include_legacy_cards optional | Incluye tarjetas de sitio web y de App heredadas en la respuesta. Las tarjetas heredadas son aquellas cuya URL de recurso tiene el siguiente formato: accounts/:account_id/cards/:card_type. Consulta esta publicación del foro para desarrolladores para obtener más contexto. Tipo: boolean Predeterminado: false Valores posibles: true , false |
q optional | Parámetro query opcional para limitar tarjetas por name . Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: realiza coincidencia por prefijo sin distinción de mayúsculas. Tipo: string Ejemplo: dtc |
sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: created_at-asc |
with_deleted optional | Incluye 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/cards?count=1
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/:card_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 |
card_id obligatorio | El id de las cards. Tipo: string Ejemplo: 1044294149527166979 |
with_deleted opcional | Incluya resultados eliminados en su solicitud. Tipo: boolean Valor predeterminado: false Valores posibles: true , false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
Ejemplo de respuesta
POST accounts/:account_id/cards
Crea una tarjeta nueva asociada a la cuenta especificada. Las solicitudes para crear tarjetas solo aceptan cuerpos JSON en una petición POST. ElContent-Type
debe establecerse en application/json
.
Consulta nuestra guía de carruseles para ver un ejemplo de uso detallado.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards
Parámetros
name
de la tarjeta y un arreglo de components
. Los componentes se representan como objetos y describen los atributos de la tarjeta orientados al anunciante.
El siguiente ejemplo muestra la estructura general del payload (pero incluye información no operativa).
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 |
name obligatorio | El nombre de la tarjeta. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: component based card |
components a veces obligatorio | Describe los componentes que se utilizarán para crear la tarjeta. Información adicional a continuación. No se puede especificar junto con slides . Nota: El orden de los componentes es importante. Tipo: array of objects |
slides a veces obligatorio | Usa este array of array para crear Multi-Destination Carousels. Describe cada tarjeta como un conjunto de componentes. Cada diapositiva debe ser una representación completa de una tarjeta. No se puede especificar junto con components . Nota: El orden de cada diapositiva es importante. Tipo: array of array |
Componentes
type
que determina el esquema del objeto. La X Ads API admite los siguientes tipos de componentes, agrupados en componentes basados en medios y en descripción.
- Medios:
MEDIA
: imagen o video individualSWIPEABLE_MEDIA
: entre 2 y 6 imágenes o videos- Descripción:
DETAILS
BUTTON
type
). Estos se enumeran en la siguiente tabla.
type de componente | Campo | Tipo de valor |
---|---|---|
MEDIA | media_key | string |
SWIPEABLE_MEDIA | media_keys | array of strings |
DETAILS | title destination | string object |
BUTTON | label destination | object object |
BUTTON
en el contexto del arreglo components
(omitiendo intencionalmente la clave name
). (Los puntos suspensivos indican lugares donde sería necesario especificar más información.)
DETAILS
o BUTTON
. Los componentes basados en descripciones se representan debajo del contenido multimedia y tienen destinos asociados, ya sean URLs o apps móviles.
Etiqueta
Las etiquetas definen el texto que se muestra en los botones y, por lo tanto, solo aplican al componente BUTTON
. Los objetos de etiqueta tienen dos claves obligatorias: type
y value
. El type
debe establecerse en ENUM
y el value
puede ser uno de: BOOK
, CONNECT
, INSTALL
, OPEN
, ORDER
, PLAY
o SHOP
.
Basándonos en el ejemplo anterior, lo siguiente muestra el objeto label
dentro del componente BUTTON
.
DETAILS
o BUTTON
. Hay dos tipos de destino: WEBSITE
o APP
.
Nota: Los destinos de sitio web solo se pueden usar con componentes DETAILS
y los destinos de App solo se pueden usar con componentes BUTTON
.
Destino de sitio web
Nombre | Descripción |
---|---|
type required | El tipo de destino, que determina su esquema. Tipo: enum Valores posibles: WEBSITE |
url required | La URL del sitio web a la que se redirigirá al usuario. Tipo: string Ejemplo: https://devcommunity.x.com/c/advertiser-api |
Nombre | Descripción |
---|---|
type required | El tipo de destino, que determina su esquema. Tipo: enum Valores posibles: APP |
country_code required | El código de dos letras ISO 3166-1 alpha-2 del país donde se vende la App. Tipo: string Ejemplo: US |
googleplay_app_id sometimes required | El nombre del paquete de la aplicación en Google Play. Nota: Se requiere al menos uno de los siguientes: ios_app_store_identifier o googleplay_app_id . Tipo: string Ejemplo: com.twitter.android |
ios_app_store_identifier sometimes required | El identificador de la App Store de iOS. Nota: Se requiere al menos uno de los siguientes: ios_app_store_identifier o googleplay_app_id . Tipo: string Ejemplo: 333903271 |
googleplay_deep_link optional | Un enlace profundo a la App de Android que está promocionando. Nota: Solo se puede usar si se ha proporcionado un googleplay_app_id . Tipo: string |
ios_deep_link optional | Un enlace profundo a la App de iOS que está promocionando. Nota: Solo se puede usar si se ha proporcionado un ios_app_store_identifier . Tipo: string |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards
Ejemplo de respuesta
Content-Type
debe establecerse en application/json
.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/1321554298900107264
Parámetros
Nombre | Descripción |
---|---|
account_id required | 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 |
name optional | El nombre de la tarjeta. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: component based card |
components optional | Describe los componentes que se usarán para actualizar la tarjeta. Información adicional a continuación. No se puede especificar junto con slides . Nota: El orden de los componentes es importante. Tipo: array of objects |
slides optional | Use este arreglo de arreglos para actualizar los carruseles de múltiples destinos (Multi-Destination Carousels). Describe cada tarjeta como un grupo de componentes. Cada diapositiva debe ser una representación completa de una tarjeta. No se puede especificar junto con components . Nota: El orden de cada diapositiva es importante. Tipo: array of array |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/:card_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 |
card_id obligatorio | El id de la tarjeta que se eliminará. Type: string Example: 1044294149527166979 |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
Respuesta de ejemplo
Obtención de tarjetas
card_uri
, asociadas a la cuenta actual.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/all
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 |
card_uris obligatorio | Limita la respuesta a las tarjetas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 valores de URI de tarjeta. Tipo: string Ejemplo: card://1044294149527166979,card://1044301099031658496 |
with_deleted opcional | Incluye resultados eliminados en la solicitud. Tipo: boolean Predeterminado: false Valores posibles: true , false |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/all?card_uris=card://1044294149527166979,card://1044301099031658496
Ejemplo de respuesta
card_id
, asociada a la cuenta actual.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/all/:card_id
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 al usuario autenticado. Type: string Example: 18ce54d4x5t |
card_id obligatorio | Una referencia a la card con la que se opera en la solicitud. Type: string Example: 508pf |
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/cards/all/508pf
Ejemplo de respuesta
Borradores de Tweets
GET accounts/:account_id/draft_tweets
Recupera los detalles de algunos o de todos los Draft Tweets asociados a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets
Parámetros
Nombre | Descripción |
---|---|
account_id requerido | 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 al usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
count opcional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Valor predeterminado: 100 Mín., máx.: 1 , 200 |
cursor opcional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: c-jh1g0ryb |
user_id opcional | Especifica el usuario para el que se recuperarán Draft Tweets. Si no se establece, se usa el usuario promocionable FULL de la cuenta. Tipo: string Ejemplo: 756201191646691328 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?count=1
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_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 |
draft_tweet_id obligatorio | Una referencia al Draft Tweet con el que se opera en la solicitud. Type: string Example: 994788364334325760 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994788364334325760
Ejemplo de respuesta
POST accounts/:account_id/draft_tweets
Crea un Tweet en borrador para el usuario totalmente promocionable de la cuenta (valor predeterminado) o para el usuario especificado en el parámetroas_user_id
.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets
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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
as_user_id obligatorio | El id de usuario del anunciante en cuyo nombre publicas el Tweet. El anunciante debe otorgar acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso te permite llamar a la API usando los tokens OAuth de tu propio handle en lugar de los del anunciante. Type: string Example: 756201191646691328 |
text a veces obligatorio | El texto de tu actualización de estado. Obligatorio si no se especifican media_keys . Type: string Example: Just setting up my X. |
card_uri opcional | Asocia una card con el Tweet usando el valor card_uri de cualquier respuesta de cards, si está disponible. Type: string Example: card://960880280705392541 |
media_keys opcional | Asocia contenido multimedia con el Tweet especificando una lista de identificadores separada por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Type: string Example: 13_1153584529292270722 |
nullcast opcional | Indica si se debe crear un Tweet nullcast (o “solo promocionado”). Type: boolean Default: true Possible values: true , false |
name opcional | El nombre del Draft Tweet. Longitud máxima: 80 caracteres. Type: string Example: Tweet with name |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?as_user_id=756201191646691328&text=Just setting up my X.
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_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 |
draft_tweet_id obligatorio | Una referencia al Draft Tweet con el que opera en la solicitud. Type: string Example: 994747471329873920 |
card_uri opcional | Asocie una Card con el Tweet usando el valor card_uri de cualquier respuesta de Cards, si está disponible. Nota: Para desasignar (eliminar), especifique el parámetro sin valor. Type: string Example: card://970582057284129151 |
media_keys opcional | Asocie contenido multimedia al Tweet especificando una lista de identificadores separada por comas. Incluya hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Nota: Para desasignar (eliminar), especifique el parámetro sin valor. Type: string Example: 13_1153584529292270722 |
nullcast opcional | Indica si se debe crear un Tweet con nullcast (o “Promoted-only”). Type: boolean Possible values: true , false |
text opcional | El texto de la actualización de estado. Type: string Example: just setting up my twttr |
name opcional | El nombre del Draft Tweet. Longitud máxima: 80 caracteres. Type: string Example: Tweet with name |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994747471329873920?text=just setting up my twttr
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_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. Type: string Example: 18ce54d4x5t |
draft_tweet_id obligatorio | Referencia al Draft Tweet con el que opera en la solicitud. Type: string Example: 994787835663155200 |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994787835663155200
Ejemplo de respuesta
POST accounts/:account_id/draft_tweets/preview/:draft_tweet_id
Previsualizar un Draft Tweet en un dispositivo móvil. Una solicitud correcta envía una notificación a cada dispositivo en el que el usuario autenticado haya iniciado sesión. Al hacer clic en la notificación, se abre una línea de tiempo que permite al usuario ver e interactuar con el Draft Tweet, lo que le permite probar la reproducción automática, el volumen, la pantalla completa, el acoplamiento de la video website card y otros comportamientos. Nota: Las previsualizaciones en el dispositivo solo son visibles para el usuario que recibe la notificación. Nota: Las notificaciones solo se envían a las apps oficiales de X.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets/preview/:draft_tweet_id
Parámetros
Nombre | Descripción |
---|---|
account_id required | 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 |
draft_tweet_id required | Referencia al Draft Tweet con el que se opera en la solicitud. Tipo: string Ejemplo: 996132315829948416 |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/preview/996132315829948416
Ejemplo de respuesta
Tarjetas de conversación con imagen
card_uri
con cualquiera de los endpoints POST accounts/:account_id/tweet, POST statuses/update o POST accounts/:account_id/scheduled_tweets.
GET accounts/:account_id/cards/image_conversation
Recupera los detalles de algunas o todas las tarjetas de conversación con imágenes asociadas a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta con apalancamiento. 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 |
card_ids opcional | Limita la respuesta únicamente a las image conversation cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: 59woh |
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. Consulte Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
q opcional | Un parámetro query opcional para limitar las cards por name . Omita este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: Realiza coincidencia de prefijo sin distinción de mayúsculas y minúsculas. Tipo: string Ejemplo: night |
sort_by opcional | Ordena por un atributo admitido en orden ascendente o descendente. Consulte Sorting para más información. Tipo: string Ejemplo: created_at-asc |
with_deleted opcional | Incluye los resultados eliminados en la 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 velocidad 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/cards/image_conversation?card_ids=59woh
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_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. Type: string Example: 18ce54d4x5t |
card_id obligatorio | Una referencia a la imagen de conversación (image conversation card) con la que se opera en la solicitud. Type: string Example: 59woh |
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/cards/image_conversation/59woh
Ejemplo de respuesta
POST accounts/:account_id/cards/image_conversation
Crea una nueva tarjeta de conversación con imagen asociada a la cuenta especificada. Consulta Carga de medios para obtener información útil sobre cómo subir imágenes a nuestros endpoints.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation
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. Tipo: string Ejemplo: 18ce54d4x5t |
first_cta obligatorio | El hashtag de la llamada a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareNow |
first_cta_tweet obligatorio | El texto del Tweet que se usará cuando se haga clic en el primer CTA. Tipo: string Ejemplo: I Heart @AdsAPI |
media_key obligatorio | La media_key de una imagen que se usará en esta tarjeta. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de 800 px y una relación de aspecto ancho:alto de 1.91:1. Tipo: string Ejemplo: 3_1151345051104991073 |
name obligatorio | El nombre de la tarjeta. Tipo: string Ejemplo: image conversation card |
thank_you_text obligatorio | El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: string Ejemplo: Thank you |
second_cta a veces obligatorio | El hashtag de la llamada a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Nota: Obligatorio si title no está establecido. Ejemplo: #ShareAgain |
second_cta_tweet a veces obligatorio | El texto del Tweet que se usará cuando se haga clic en el segundo CTA. Nota: Obligatorio si second_cta está establecido. Tipo: string Ejemplo: I Heart @AdsAPI Again |
title a veces obligatorio | El título de la tarjeta, que aparece debajo de la imagen y encima de los CTA. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si second_cta no está establecido. Ejemplo: Start a conversation |
third_cta opcional | El hashtag de la llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareMore |
third_cta_tweet a veces obligatorio | El texto del Tweet que se usará cuando se haga clic en el tercer CTA. Tipo: string Nota: Obligatorio si third_cta está establecido. Ejemplo: I Heart @TwitterDev |
fourth_cta opcional | El hashtag de la llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareExtra |
fourth_cta_tweet a veces obligatorio | El texto del Tweet que se usará cuando se haga clic en el cuarto CTA. Tipo: string Nota: Obligatorio si fourth_cta está establecido. Ejemplo: I Heart @TwitterDev Again |
unlocked_image_media_key opcional | Un media_key de una imagen que se usará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la biblioteca de medios de la cuenta. Nota: Se requiere un ancho mínimo de 800 px y una relación de aspecto ancho:alto de 5:2. Tipo: string Ejemplo: 3_883112887618682880 |
thank_you_url opcional | La URL que se mostrará junto con el texto de agradecimiento. Tipo: string Ejemplo: https://example.com/thankyou |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation?media_key=3_957113581522141184&name=image conversation card&first_cta=#moon&first_cta_tweet=stars&thank_you_text=thanks&title=Full moon
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id
Parámetros
Nombre | Descripción |
---|---|
account_id required | El identificador de la cuenta apalancada. Aparece en la ruta del recurso y generalmente 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 |
card_id required | Una referencia a la image conversation card con la que operas en la solicitud. Tipo: string Ejemplo: 4i0qg |
first_cta optional | El hashtag de la llamada a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareNow |
first_cta_tweet optional | El texto del Tweet que se usará cuando se haga clic en el primer CTA. Tipo: string Ejemplo: I Heart @AdsAPI |
second_cta optional | El hashtag de la llamada a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Nota: Obligatorio si title no está establecido. Ejemplo: #ShareAgain |
second_cta_tweet optional | El texto del Tweet que se usará cuando se haga clic en el segundo CTA. Nota: Obligatorio si second_cta está establecido. Tipo: string Ejemplo: I Heart @AdsAPI Again |
third_cta optional | El hashtag de la llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareMore |
third_cta_tweet optional | El texto del Tweet que se usará cuando se haga clic en el tercer CTA. Tipo: string Nota: Obligatorio si third_cta está establecido. Ejemplo: I Heart @TwitterDev |
fourth_cta optional | El hashtag de la llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareExtra |
fourth_cta_tweet optional | El texto del Tweet que se usará cuando se haga clic en el cuarto CTA. Tipo: string Nota: Obligatorio si fourth_cta está establecido. Ejemplo: I Heart @TwitterDev Again |
media_key optional | La media key de una imagen que se usará en esta card. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de 800 px y una relación de aspecto ancho:alto de 1.91:1. Tipo: string Ejemplo: 3_1151345051104991073 |
name optional | El nombre de la card. Tipo: string Ejemplo: moon card |
thank_you_text optional | El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: string Ejemplo: Thank you |
thank_you_url optional | La URL que se mostrará junto con el texto de agradecimiento. Tipo: string Ejemplo: https://example.com/thankyou |
title optional | El título de la card, que aparece debajo de la imagen y encima de las CTAs. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si second_cta no está establecido. Ejemplo: Start a conversation |
unlocked_image_media_key optional | Un media_key de una imagen que se usará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de 800 px y una relación de aspecto ancho:alto de 5:2. Tipo: string Ejemplo: 3_883112887618682880 |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/59woh?name=moon card
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_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 |
card_id obligatorio | Una referencia a la Image Conversation Card con la que se opera en la solicitud. Type: string Example: 4i0qe |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/4i0qe
Ejemplo de respuesta
Biblioteca multimedia
GET accounts/:account_id/media_library
Recupera los detalles de algunos o todos los objetos de la biblioteca multimedia asociados a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/media_library
Parámetros
Nombre | Descripción |
---|---|
account_id required | 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 |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 20 Min, Max: 1 , 50 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Example: c-1 |
media_type optional | Limita la respuesta al tipo de medio deseado. Type: enum Possible values: GIF , IMAGE , VIDEO |
q optional | Una query opcional para acotar el recurso por los campos name , title , file_name y description . Nota: realiza coincidencias de términos sin distinción entre mayúsculas y minúsculas. Type: string Min, Max length: 1 , 255 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?count=1
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta con apalancamiento. 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 |
media_key obligatorio | Referencia al objeto de la biblioteca multimedia con el que se opera en la solicitud. Type: string Example: 13_909110614026444802 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/13_909110614026444802
Ejemplo de respuesta
AMPLIFY_VIDEO
a la Media Library, quedará disponible automáticamente como un recurso PREROLL
de account_media.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/media_library
Parámetros
Name | Description |
---|---|
account_id required | 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 al usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
media_key required | El media_key del contenido cargado. Se devuelve un media_key en la respuesta de POST media/upload cuando se especifica una media_category . Tipo: string Ejemplo: 3_931236738554519552 |
description optional | La descripción que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 200 caracteres. No se muestra en el Tweet de forma predeterminada. Para mostrar la description del video, usa el parámetro video_description con el endpoint POST accounts/:account_id/tweet. Nota: Solo puede usarse con videos. Tipo: string Ejemplo: Esta es la descripción debajo del video. |
file_name optional | El nombre de archivo del objeto de la biblioteca de medios. Longitud máxima: 255. El nombre de archivo puede verse en el detalle de medios de cada recurso en la interfaz de Media Library en ads.x.com. Este campo estará vacío cuando no se establezca file_name . Tipo: string Ejemplo: coffee.jpeg |
name optional | El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta debajo de cada recurso en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando no se establezca name . Tipo: string Ejemplo: Latte |
poster_media_key optional | Especifica una imagen de póster para el video usando el media_key de una imagen cargada. Si no se especifica, se usará el primer fotograma. Nota: Solo puede usarse con videos. Tipo: string Ejemplo: 3_890599134483242005 |
title optional | El título (encabezado) que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 70 caracteres. No se muestra en el Tweet de forma predeterminada. Para mostrar el title del video, usa el parámetro video_title con el endpoint POST accounts/:account_id/tweet. Nota: Solo puede usarse con videos. Tipo: string Ejemplo: Título del video |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?media_key=3_931236738554519552
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
Parámetros
Name | Description |
---|---|
account_id required | 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 |
media_key required | Referencia al objeto de la biblioteca de medios con el que se opera en la solicitud. Type: string Example: 16_844800354743074820 |
description optional | La descripción que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 200 caracteres. No se muestra en el Tweet de forma predeterminada. Para mostrar la description del video, use el parámetro video_description con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: Esta es la descripción debajo del video. |
file_name optional | El nombre de archivo del objeto de la biblioteca de medios. Longitud máxima: 255. El nombre de archivo se puede ver en el detalle de medios de cada recurso en la interfaz de Media Library en ads.x.com. Estará vacío cuando no se haya establecido file_name . Type: string Example: coffee.jpeg |
name optional | El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta debajo de cada recurso en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando no se haya establecido name . Type: string Example: Latte |
poster_media_key optional | Especifique una imagen de póster para el video usando la media_key de una imagen cargada. Nota: Solo se puede usar con videos. Type: string Example: 3_885003359340375465 |
title optional | El título (encabezado) que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 70 caracteres. No se muestra en el Tweet de forma predeterminada. Para mostrar el title del video, use el parámetro video_title con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: Video title |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/16_844800354743074820?title=cat GIF&description=in space
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta con apalancamiento. 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 |
media_key obligatorio | Una referencia al objeto de la biblioteca de medios con el que se opera en la solicitud. Type: string Example: 7_860318603387600896 |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/7_860318603387600896
Ejemplo de respuesta
Tarjetas de encuesta
GET accounts/:account_id/cards/poll
Obtiene los detalles de algunas o todas las tarjetas de encuesta asociadas a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/poll
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 |
card_ids opcional | Limita la respuesta únicamente a las poll cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: 57i77 |
count opcional | Especifica la cantidad de registros a 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 Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
q opcional | Parámetro query opcional para delimitar cards por name . Omite este parámetro para recuperar todo. Longitud máxima: 80 caracteres. Nota: Realiza coincidencia por prefijo sin distinción entre mayúsculas y minúsculas. Tipo: string Ejemplo: night |
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 incluyen total_count tendrán límites de tasa 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/cards/poll?card_ids=57i77
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_id
Parámetros
Nombre | Descripción |
---|---|
account_id required | 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. Type: string Example: 18ce54d4x5t |
card_id required | Una referencia a la poll card con la que está operando en la solicitud. Type: string Example: 57i8t |
with_deleted optional | Incluya 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/cards/poll/57i8t
Ejemplo de respuesta
POST accounts/:account_id/cards/poll
Crea una nueva tarjeta de encuesta asociada a la cuenta especificada. Este endpoint admite la creación de tarjetas de encuesta con una imagen, un video o sin contenido multimedia. Las encuestas con contenido multimedia se denominan Media Forward Polls. Nota: El producto Media Forward Polls está en beta y requiere la función de cuentaPROMOTED_MEDIA_POLLS
.
Nota: No es posible actualizar (PUT) las tarjetas de encuesta.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/poll
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 anuncios, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
duration_in_minutes obligatorio | El tiempo (en minutos) durante el cual la encuesta permanecerá abierta. Tras cumplirse el duration_in_minutes especificado, la encuesta se cerrará y ya no se aceptarán votos. Esto corresponde a end_time en la respuesta. Nota: Esto comienza en cuanto se crea la tarjeta y no cuando se agrega a un Tweet. Type: int Min, Max: 5 , 10080 |
first_choice obligatorio | La primera opción de la encuesta. Longitud máxima: 25 caracteres. Type: string Example: One |
name obligatorio | El nombre de la tarjeta. Type: string Example: poll card |
second_choice obligatorio | La segunda opción de la encuesta. Longitud máxima: 25 caracteres. Type: string Example: Two |
fourth_choice opcional | La cuarta opción de la encuesta. Longitud máxima: 25 caracteres. Nota: Al usar este parámetro, se deben establecer la primera, segunda y tercera opciones. Type: string Example: Four |
media_key opcional | El media_key de una imagen o video de la biblioteca de medios que se usará en esta tarjeta. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para este medio. Nota: La imagen o el video deben estar en la biblioteca de medios de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800 px y una relación de aspecto de 1.91:1 (ancho:alto). |
third_choice opcional | La tercera opción de la encuesta. Longitud máxima: 25 caracteres. Nota: Al usar este parámetro, se deben establecer la primera y la segunda opciones. Type: string Example: Three |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll?duration_in_minutes=10080&first_choice=East&second_choice=West&media_key=13_950589518557540353&name=best coast poll
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_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 |
card_id obligatorio | Una referencia a la poll card con la que está trabajando en la solicitud. Type: string Example: 57i9t |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll/57i9t
Ejemplo de respuesta
Llamadas a la acción de preroll
GET accounts/:account_id/preroll_call_to_actions
Recupera los detalles de algunas o todas las llamadas a la acción (CTA) de preroll asociadas con los line items de la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | 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 al usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
line_item_ids opcional | Limita la respuesta únicamente a los CTA de preroll asociados con los line items especificados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: 8v53k |
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 Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
preroll_call_to_action_ids opcional | Limita la respuesta únicamente a los CTA de preroll deseados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: 8f0 |
sort_by opcional | Ordena por el atributo admitido 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 la 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 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/preroll_call_to_actions?line_item_ids=8v53k
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_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 |
preroll_call_to_action_id obligatorio | Una referencia al preroll call to action con el que opera en la solicitud. Type: string Example: 8f0 |
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/preroll_call_to_actions/8f0
Ejemplo de respuesta
POST accounts/:account_id/preroll_call_to_actions
Configura la llamada a la acción (CTA) opcional para un elemento de líneaPREROLL_VIEWS
.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions
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 al usuario autenticado. Type: string Example: 18ce54d4x5t |
call_to_action obligatorio | El texto del CTA para el botón mostrado en el anuncio. Type: enum Possible values: GO_TO , SEE_MORE , SHOP , VISIT_SITE , WATCH_NOW |
call_to_action_url obligatorio | La URL a la que se redirige al usuario cuando se hace clic en el botón de CTA. Type: string Example: https://www.x.com |
line_item_id obligatorio | Referencia al line item con el que se opera en la solicitud. Type: string Example: 8v53k |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_id=8v53k&call_to_action=VISIT_SITE&call_to_action_url=https://www.x.com
Ejemplo de respuesta
PREROLL_VIEWS
.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_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 |
preroll_call_to_action_id obligatorio | Referencia al CTA de prerroll con el que se opera en la solicitud. Type: string Example: 8f0 |
call_to_action opcional | El texto del CTA para el botón mostrado en el anuncio. Type: enum Possible values: GO_TO , SEE_MORE , SHOP , VISIT_SITE , WATCH_NOW |
call_to_action_url opcional | La URL a la que se redirige al usuario cuando se hace clic en el botón del CTA. Type: string Example: https://www.x.com |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0?call_to_action=WATCH_NOW
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_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 |
preroll_call_to_action_id obligatorio | Una referencia al CTA de prerroll con el que está operando en la solicitud. Tipo: string Ejemplo: 8f0 |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0
Ejemplo de respuesta
Tweets programados
GET accounts/:account_id/scheduled_tweets
Recupera los detalles de algunos o todos los Tweets programados asociados a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets
Parámetros
Nombre | Descripción |
---|---|
account_id required | 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 al usuario autenticado. Type: string Example: 18ce54d4x5t |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud independiente. Type: int Default: 100 Min, Max: 1 , 200 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Example: c-j3cn6n40 |
user_id optional | Especifica el usuario para el que se recuperarán los Tweets programados. Si no se especifica, se usa el usuario promocionable FULL de la cuenta. Type: long Example: 756201191646691328 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?count=1
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_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 |
scheduled_tweet_id obligatorio | Referencia al Scheduled Tweet con el que se opera en la solicitud. Type: string Example: 917438609065623552 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/917438609065623552
Ejemplo de respuesta
POST accounts/:account_id/scheduled_tweets
Cree un Tweet programado para el usuario totalmente promocionable de la cuenta (valor predeterminado) o para el usuario especificado en el parámetroas_user_id
.
URL de recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets
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 |
scheduled_at obligatorio | La hora, expresada en ISO 8601, a la que el Tweet debe publicarse (o ponerse en línea). Nota: Los Tweets solo se pueden programar hasta un año en el futuro. Nota: Los Tweets deben programarse con granularidad de minuto; los segundos se ignorarán. Type: string Example: 2017-12-31T23:59:00Z |
as_user_id obligatorio | El id de usuario del anunciante en cuyo nombre publicas el Tweet. El anunciante debe otorgar acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso te permite llamar a la API utilizando los tokens OAuth de tu propio handle en lugar de los del anunciante. Type: long Example: 756201191646691328 |
text a veces obligatorio | El texto de tu actualización de estado. Obligatorio si no se especifica media_keys . Type: string Example: just setting up my twttr |
card_uri opcional | Asocia una Card con el Tweet usando el valor card_uri de cualquier respuesta de Cards, si está disponible. Type: string Example: card://855591459410511943 |
media_keys opcional | Asocia contenido multimedia al Tweet especificando una lista de identificadores separada por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Type: string Example: 13_1153584529292270722 |
nullcast opcional | Indica si se debe crear un Tweet de tipo nullcast (o “solo Promocionado”). Type: boolean Default: true Possible values: true , false |
name opcional | El nombre del Tweet programado. Longitud máxima: 80 caracteres. Type: string Example: Tweet with name |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?as_user_id=756201191646691328&media_keys=3_917438348871983104&scheduled_at=2018-01-01
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_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 |
scheduled_tweet_id obligatorio | Referencia al Scheduled Tweet con el que se opera en la solicitud. Tipo: string Ejemplo: 870321875435442177 |
card_uri opcional | Asocia una Card con el Tweet usando el valor card_uri de cualquier respuesta de Cards, si está disponible. Nota: Para desasignar (eliminar), especifica el parámetro sin valor. Tipo: string Ejemplo: card://875146925316386347 |
media_keys opcional | Asocia contenido multimedia con el Tweet especificando una lista de identificadores separada por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Nota: Para desasignar (eliminar), especifica el parámetro sin valor. Tipo: string Ejemplo: 13_1153584529292270722 |
nullcast opcional | Indica si se debe crear un Tweet “nullcasted” (o “Promoted-only”). Tipo: boolean Valores posibles: true , false |
scheduled_at opcional | La hora, expresada en ISO 8601, a la que debe publicarse el Tweet. Tipo: string Ejemplo: 2017-12-31T23:59:59Z |
text opcional | El texto de la actualización de estado. Tipo: string Ejemplo: just setting up my twttr |
name opcional | El nombre del Scheduled Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: Tweet with name |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875057751231037440?text=winter solstice
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_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 |
scheduled_tweet_id obligatorio | Una referencia al Scheduled Tweet con el que está operando en la solicitud. Tipo: string Ejemplo: 870321875435442177 |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875064008595787776
Ejemplo de respuesta
Vistas previas de Tweets
GET accounts/:account_id/tweet_previews
Vista previa de Tweets publicados, programados o en borrador.- Permite previsualizar varios Tweets (hasta 200) en una sola solicitud a la API
- Renderizado preciso y actualizado del diseño y estilo del Tweet
- Compatible con los formatos y tipos de tarjeta más recientes
- Devuelve un iframe
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/tweet_previews
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 API de Ads, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: 18ce54d4x5t |
tweet_ids obligatorio | Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Nota: Los ID deben corresponder al tweet_type especificado. Por ejemplo, si se envía un ID de Scheduled Tweet y se especifica tweet_type=PUBLISHED , no se devolverá una vista previa para ese ID. Type: long Example: 1122911801354510336,1102836745790316550 |
tweet_type obligatorio | El tipo de Tweet para los tweet_ids especificados. Type: enum Possible values: DRAFT , PUBLISHED , SCHEDULED |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet_previews?tweet_ids=1122911801354510336,1102836745790316550&tweet_type=PUBLISHED
Ejemplo de respuesta
Tweets
GET accounts/:account_id/tweets
Obtén los detalles del Tweet del usuario completamente promocionable de la cuenta (predeterminado) o del usuario especificado en el parámetrouser_id
. Puede ser cualquiera de los usuarios promocionables de la cuenta.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/tweets
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. Tipo: string Ejemplo: 18ce54d4x5t |
tweet_type obligatorio | El tipo de Tweet para los tweet_ids especificados. Tipo: enum Valores posibles: DRAFT , PUBLISHED , SCHEDULED |
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 Pagination para más información. Tipo: string Ejemplo: AAAAAFhLRpQLNF-sGBSgAA |
include_mentions_and_replies opcional | Indica si se deben excluir las menciones y respuestas de la lista de Tweets disponibles. Tipo: boolean Predeterminado: false Valores posibles: true , false |
name opcional | Una query opcional para acotar los Tweets por name . Omite este parámetro para recuperar todos. Longitud máxima: 80 caracteres. Nota: realiza coincidencia por prefijo sin distinción de mayúsculas/minúsculas. Tipo: string Ejemplo: dtc |
timeline_type opcional | Indica si se deben devolver Tweets nullcasted (también llamados “Promoted-only”), Tweets orgánicos o ambos. Tipo: enum Predeterminado: NULLCAST Valores posibles: ALL , NULLCAST , ORGANIC |
trim_user opcional | Indica si se debe excluir el objeto de usuario en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto de usuario que se devolverá es el id de usuario del autor del Tweet. Tipo: boolean Predeterminado: false Valores posibles: true , false |
tweet_ids opcional | Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Nota: los IDs deben corresponder al tweet_type especificado. Por ejemplo, si se pasa un ID de Tweet programado, entonces tweet_type debe ser SCHEDULED para que ese Tweet se devuelva en la respuesta. Tipo: long Ejemplo: 1122911801354510336,1102836745790316550 |
user_id opcional | Especifica el usuario al que se acotarán los Tweets. De manera predeterminada, se usa el usuario promocionable FULL de la cuenta cuando no se establece. Tipo: long Ejemplo: 756201191646691328 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets?tweet_ids=1166476031668015104&tweet_type=PUBLISHED&trim_user=true
Ejemplo de respuesta
POST accounts/:account_id/tweet
Cree un Tweet para el usuario promocionable completo de la cuenta (predeterminado) o para el usuario especificado en el parámetroas_user_id
. Se admite la creación de Tweets nullcasted (predeterminada) y orgánicos. Los Tweets nullcasted no aparecen en la cronología pública y no se muestran a los seguidores. Cualquiera de los dos tipos puede usarse en campañas.
Si el usuario autenticado no es el usuario promocionable FULL
de esta cuenta, determine si tiene permiso para publicar Tweets en su nombre realizando una solicitud al endpoint GET accounts/:account_id/authenticated_user_access. Un permiso de TWEET_COMPOSER
indica que el usuario puede usar este endpoint para crear Tweets nullcasted en nombre del usuario promocionable FULL
.
Al usar el endpoint upload.x.com para contenido multimedia, pase el mismo valor de user_id
en el parámetro additional_owners
que el valor de as_user_id
que envía a este endpoint.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/tweet
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 X Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
as_user_id obligatorio | El id de usuario del anunciante en cuyo nombre publicas el Tweet. El anunciante debe otorgar acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso te permite llamar a la API usando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: long Ejemplo: 756201191646691328 |
text a veces obligatorio | El texto de tu actualización de estado. Obligatorio si no se especifican media_keys . Tipo: string Ejemplo: hello, world |
card_uri opcional | Asocia una card con el Tweet usando el valor card_uri de cualquier respuesta de cards, si está disponible. Tipo: string Ejemplo: card://853503245793641682 |
conversation_settings opcional | Elige quién puede responder a este Tweet. Cualquier persona mencionada siempre puede responder. Nota: Este campo no se devolverá en la respuesta a la solicitud POST, pero se devolverá al realizar una solicitud GET. Nota: Este parámetro solo funciona en la X Ads API v8 y posteriores. Tipo: enum Predeterminado: EVERYONE Valores posibles: EVERYONE , FOLLOWING , MENTIONED_USERS |
media_keys opcional | Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Tipo: string Ejemplo: 13_1153584529292270722 |
name opcional | El nombre del Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: Tweet with name |
nullcast opcional | Indica si se debe crear un Tweet nullcasted (o “Promoted-only”). Nota: Los Tweets orgánicos (nullcast=false ) solo pueden crearse para el usuario autenticado. Tipo: boolean Predeterminado: true Valores posibles: true , false |
trim_user opcional | Indica si se debe excluir el objeto de usuario en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto de usuario que se devolverá es el id de usuario del autor del Tweet. Tipo: boolean Predeterminado: false Valores posibles: true , false |
tweet_mode opcional | Indica si la respuesta debe estar en modo de compatibilidad o extendido. Consulta esto para obtener más información. Tipo: string Valores posibles: compat , extended |
video_cta opcional | La CTA del video. Tipo: enum Valores posibles: VISIT_SITE , WATCH_NOW |
video_cta_value opcional | El valor de la CTA correspondiente del video. Tipo: string Ejemplo: https://dev.x.com |
video_description opcional | La descripción que aparece debajo del video. Longitud máxima: 200 caracteres. Tipo: string Ejemplo: Integra con la plataforma publicitaria de X |
video_title opcional | El título (encabezado) que aparece debajo del video. Longitud máxima: 70 caracteres. Tipo: string Ejemplo: X Ads API |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet?text=hello, world&as_user_id=756201191646691328&trim_user=true
Ejemplo de respuesta
name
del Tweet especificado perteneciente a la cuenta actual.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/tweets/:tweet_id/name
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. Tipo: string Ejemplo: 18ce54d4x5t |
tweet_id obligatorio | Referencia al Tweet con el que se opera en la solicitud. Tipo: long Ejemplo: 994747471329873920 |
name opcional | Nombre del Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: Tweet con nombre |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets/994747471329873920/name?name=new Tweet name
Ejemplo de respuesta
Tarjetas de conversación en video
card_uri
con cualquiera de los endpoints POST accounts/:account_id/tweet, POST statuses/update o POST accounts/:account_id/scheduled_tweets.
GET accounts/:account_id/cards/video_conversation
Obtiene los detalles de algunas o todas las tarjetas de conversación de video asociadas a la cuenta actual.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation
Parámetros
Nombre | Descripción |
---|---|
account_id required | 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 |
card_ids optional | Limita la respuesta únicamente a las video conversation cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: 5a86h |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: 200 Mín., Máx.: 1 , 1000 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: 8x7v00oow |
q optional | Parámetro query opcional para limitar las cards por name . Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: Realiza coincidencia por prefijo sin distinción de mayúsculas y minúsculas. Tipo: string Ejemplo: night sky |
sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: created_at-asc |
with_deleted optional | Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: false Valores posibles: true , false |
with_total_count optional | 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 velocidad 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/cards/video_conversation?card_ids=5a86h
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_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. Type: string Example: 18ce54d4x5t |
card_id obligatorio | Una referencia a la video conversation card con la que se opera en la solicitud. Type: string Example: 4i0ya |
with_deleted opcional | Incluye los 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/cards/video_conversation/5a86h
Ejemplo de respuesta
POST accounts/:account_id/cards/video_conversation
Crea una nueva tarjeta de conversación de video asociada a la cuenta especificada. Consulta Uploading Media para obtener información útil sobre cómo subir imágenes a nuestros endpoints.URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta aprovechada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la API de Anunciantes, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
first_cta obligatorio | El hashtag de llamada a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #APIs |
first_cta_tweet obligatorio | El texto del Tweet que se utilizará cuando se haga clic en el primer CTA. Tipo: string Ejemplo: Ads API |
media_key obligatorio | La clave de medios para un video que se utilizará en esta tarjeta. Nota: El video debe estar en la Biblioteca de Medios de la cuenta. Nota: Se requiere una relación de aspecto de 16:9. Tipo: string Ejemplo: 13_1168079965037467209 |
name obligatorio | El nombre de la tarjeta. Tipo: string Ejemplo: video conversation card |
thank_you_text obligatorio | El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: string Ejemplo: Build it |
title a veces obligatorio | El título de la tarjeta, que aparece debajo del video y encima de los CTA. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si second_cta no está configurado. Ejemplo: Developers |
second_cta a veces obligatorio | El hashtag de llamada a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Nota: Obligatorio si title no está configurado. Ejemplo: #ShareAgain |
second_cta_tweet a veces obligatorio | El texto del Tweet que se utilizará cuando se haga clic en el segundo CTA. Nota: Obligatorio si second_cta está configurado. Tipo: string Ejemplo: I Heart @AdsAPI Again |
poster_media_key opcional | La clave de medios para una imagen de póster que se utilizará en esta tarjeta. Si no se especifica, se utilizará el primer fotograma. Nota: El video debe estar en la Biblioteca de Medios de la cuenta. Tipo: long Ejemplo: 3_882726458191298561 |
third_cta opcional | El hashtag de llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareMore |
third_cta_tweet a veces obligatorio | El texto del Tweet que se utilizará cuando se haga clic en el tercer CTA. Tipo: string Nota: Obligatorio si third_cta está configurado. Ejemplo: I Heart @TwitterDev |
fourth_cta opcional | El hashtag de llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareExtra |
fourth_cta_tweet a veces obligatorio | El texto del Tweet que se utilizará cuando se haga clic en el cuarto CTA. Tipo: string Nota: Obligatorio si fourth_cta está configurado. Ejemplo: I Heart @TwitterDev Again |
thank_you_url opcional | La URL que se mostrará con el texto de agradecimiento. Tipo: string Ejemplo: https://example.com/thankyou |
unlocked_image_media_key opcional | Un media_key de una imagen que se utilizará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la biblioteca de medios de la cuenta. Tipo: string Ejemplo: 3_883112887618682880 |
unlocked_video_media_key opcional | El identificador de un video del endpoint GET accounts/:account_id/media_library que se utilizará en el escenario de desbloqueo instantáneo. Tipo: string Ejemplo: 13_867520357225418752 |
Ejemplo de solicitud
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?first_cta=#APIs&first_cta_tweet=X Ads API&name=video conversation card&thank_you_text=Build it&title=Developers&media_key=13_958388276489895936
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta aprovechada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la API de Advertiser, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
card_id obligatorio | Una referencia a la tarjeta de conversación de video con la que estás operando en la solicitud. Tipo: string Ejemplo: 5a86h |
first_cta opcional | El hashtag de Llamada a la Acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #APIs |
first_cta_tweet opcional | El texto del Tweet que se utilizará cuando se haga clic en el primer CTA. Tipo: string Ejemplo: X Ads API |
second_cta opcional | El hashtag de Llamada a la Acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Nota: Obligatorio si title no está establecido. Ejemplo: #ShareAgain |
second_cta_tweet opcional | El texto del Tweet que se utilizará cuando se haga clic en el segundo CTA. Nota: Obligatorio si second_cta está establecido. Tipo: string Ejemplo: I Heart @AdsAPI Again |
third_cta opcional | El hashtag de Llamada a la Acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareMore |
third_cta_tweet opcional | El texto del Tweet que se utilizará cuando se haga clic en el tercer CTA. Tipo: string Nota: Obligatorio si third_cta está establecido. Ejemplo: I Heart @TwitterDev |
fourth_cta opcional | El hashtag de Llamada a la Acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: #ShareExtra |
fourth_cta_tweet opcional | El texto del Tweet que se utilizará cuando se haga clic en el cuarto CTA. Tipo: string Nota: Obligatorio si fourth_cta está establecido. Ejemplo: I Heart @TwitterDev Again |
media_key opcional | La clave de medios para un video que se utilizará en esta tarjeta. Nota: El video debe estar en la Biblioteca de Medios de la cuenta. Nota: Se requiere una relación de aspecto de 16:9. Tipo: string Ejemplo: 13_1168079965037467209 |
name opcional | El nombre de la tarjeta. Tipo: string Ejemplo: developers card |
poster_media_key opcional | La clave de medios para una imagen de póster que se utilizará en esta tarjeta. Si no se especifica, se utilizará el primer fotograma. Nota: El video debe estar en la Biblioteca de Medios de la cuenta. Tipo: long Ejemplo: 3_882726458191298561 |
thank_you_text opcional | El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: string Ejemplo: Build it |
thank_you_url opcional | La URL que se mostrará con el texto de agradecimiento. Tipo: string Ejemplo: https://example.com/thankyou |
title opcional | El título de la tarjeta, que aparece debajo del video y encima de los CTA. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si second_cta no está establecido. Ejemplo: Start a conversation |
unlocked_image_media_key opcional | Un media_key de una imagen que se utilizará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la biblioteca de medios de la cuenta. Tipo: string Ejemplo: 3_883112887618682880 |
unlocked_video_media_key opcional | El identificador de un video del endpoint GET accounts/:account_id/media_library que se utilizará en el escenario de desbloqueo instantáneo. Tipo: string Ejemplo: 13_867520357225418752 |
Ejemplo de solicitud
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/5a86h?name=developers%20card
Ejemplo de respuesta
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_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 Ads API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: 18ce54d4x5t |
card_id obligatorio | Una referencia a la tarjeta de conversación de video con la que opera en la solicitud. Type: string Example: 4i0ya |
Solicitud de ejemplo
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/4i0ya