Descripción general
- POST accounts/:account_id/cards Tweets:
- POST accounts/:account_id/tweets - Para agregar tarjetas a Tweets, usa el parámetro card_uri. Tweets programados:
- POST accounts/:account_id/scheduled_tweets
Cards
La Ads API admite varios tipos de tarjetas que se pueden usar en Tweets, que luego pueden promocionarse en campañas. Nota: una vez publicado el Tweet, los detalles de la tarjeta son visibles públicamente. Esto puede incluir información sobre el usuario propietario de la tarjeta.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 Website: 16:9 y 1:1
- Video App Download: 16:9 y 1:1
- Poll: 16:9
- Video Conversation: 16:9
- Video Direct Message: 16:9
Video Promocionado
media_id, asocia el video con 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 valor int (entero), seguida de un guion bajo y que 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 muestran a los usuarios.
Video promocionado en Cards
- 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 póster).
Finalmente, crea el Tweet usando el endpoint POST accounts/:account_id/tweet. Las Cards se adjuntan a los Tweets mediante el parámetro card_uri.
Información general
- (A partir de 2015-10-22) Al cargar vídeos que se utilizarán en contenido promocionado, el parámetro
media_categorydebe establecerse con el valoramplify_videopara todas las solicitudes de comandoINITal endpoint POST media/upload (chunked). El uso de este nuevo parámetro garantiza que el vídeo se preprocese de forma asíncrona y se prepare para su uso en contenido promocionado. El comandoSTATUSse puede usar para comprobar que el procesamiento asíncrono haya finalizado después de la carga del vídeo. - La longitud máxima permitida actualmente para un vídeo promocionado es de 10 minutos, con un tamaño de archivo de 500 MB o menos.
- El vídeo cargado debe ser mp4 o mov.
- El vídeo cargado generalmente se procesa rápidamente, pero los tiempos de procesamiento pueden variar en función de la duración del vídeo y del tamaño del archivo.
- Las imágenes de portada cargadas deben estar en formato png o jpg. No hay requisitos de tamaño ni de relación de aspecto, pero la imagen de portada se ajustará para adaptarse al reproductor de vídeo.
Guías
Tweets programados
Introducción
- Crear, modificar y ver Tweets programados recientemente
- Asociar un Tweet programado con una partida (line item)
- Consultar y administrar Tweets programados existentes
- Una vez que un Tweet programado se publique, recuperar el
iddel Tweet publicado
Endpoints de la API
Gestión de Tweets programados
- GET accounts/:account_id/scheduled_tweets (obtener una lista de todos los Tweets programados)
- GET accounts/:account_id/scheduled_tweets/:scheduled_tweet_id (buscar un Tweet programado específico mediante 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 mediante su
id) - GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id (obtener una vista previa de un Tweet programado existente)
Tweets promocionados programados
- GET accounts/:account_id/scheduled_promoted_tweets (obtener una lista de todos los Tweets promocionados programados)
- GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (consultar un Tweet promocionado programado mediante su
id) - POST accounts/:account_id/scheduled_promoted_tweets (crear un nuevo Tweet promocionado programado)
- DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id (eliminar 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:
- Verifica 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 de Tweet composer
- Verifica que no haya más de 30 Tweets que estén programados para crearse dentro de una ventana de 15 minutos con 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 adelantar o retrasar la horascheduled_at.
El Tweet programado se publica:
- Estas reglas de validación se ejecutan en el momento indicado por scheduled_at y son idénticas a las que se aplican al crear un Tweet normal en la API. Por ejemplo, un Tweet programado no se publicará y el scheduled_status se establecerá en FAILED si el Tweet programado contiene tanto una imagen como un GIF.
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, junto con la posibilidad de añadir una card (card_uri) y cualquier contenido multimedia (media_ids). Ten en cuenta que un Tweet solo puede contener entidades del mismo tipo, es decir, ya sea de video, GIF o imagen. El parámetro nullcast controla si el Tweet es un Tweet “solo promocionado” (“Promoted-Only”) o no. Todos los Tweets programados recién creados son “Promoted-Only” (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 inicialmente null; sin embargo, una vez que el Tweet se publica, este campo se completa con el identificador 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 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 usarse y mostrar una vista previa del Tweet programado. El CSS correspondiente y las imágenes se servirán directamente desde X.
nullcast=true), cualquiera de los cuales se puede asociar con un elemento de línea. Para facilitar esto, también proporcionamos el endpoint POST accounts/:account_id/scheduled_promoted_tweets. Este endpoint solo permite que un único Tweet programado promocionado se asocie con un elemento de línea en una sola llamada a la API. Para asociar varios Tweets programados al mismo elemento de línea, es necesario realizar múltiples llamadas a la API.
Ten en cuenta que no es posible modificar un Tweet programado promocionado existente.
SCHEDULED y que el Scheduled Tweet dado 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 asegurarse de que no haya problemas con la entrega de la campaña, se recomienda que el Scheduled Tweet tenga el campo scheduled_at configurado para un momento anterior a las fechas de vuelo de la campaña/line item.
Por ejemplo, supongamos que el Scheduled Tweet está configurado para publicarse después de la fecha de inicio de la campaña (y que solo hay un único Tweet asociado a un único line item); entonces 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 Tweets
Los conjuntos restantes de endpoints permiten a los consumidores de la API gestionar todos sus Scheduled Tweets y Scheduled Promoted Tweets. Estas APIs se pueden usar tanto para devolver una lista de todos los Scheduled Tweets, opcionalmente filtrados por un estado determinado, como para buscar un Scheduled Tweet concreto por su id.
¿Qué sucede cuando un Tweet programado se publica?
scheduled_at, se realizan las siguientes actualizaciones:
- Se crea el Tweet “en vivo”; sin embargo, esto puede presentar una latencia de hasta 1 segundo
- El
tweet_idse añade 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 tener una imagen, un video o un GIF, y no una combinación de ellos)
- Asegúrate de que las fechas de vuelo de la campaña (es decir,
start_timeyend_time) se alineen con la horascheduled_atdel Tweet programado - Los Tweets programados no deben programarse para más de un año en el futuro (365 días)
- Actualmente no está disponible la vista previa de Tweets programados (es decir, la posibilidad de previsualizar Tweets programados antes de su creación)
Biblioteca multimedia
Introducción
Endpoints de la API
- POST media/upload o POST media/upload (chunked) (subir contenido multimedia)
- POST accounts/:account_id/media_library (agregar contenido multimedia a la biblioteca multimedia)
Agregar a la biblioteca
Parámetros de la solicitud
Atributos
Uso
media_keys.
Identificación de las Cards
Introducción
card_uri de la Card o mediante su preview_url. A continuación se presentan valores de ejemplo para cada uno.
| card_uri | preview_url |
|---|---|
| card://1043282691834048513 | https://cards.x.com/cards/18ce54d4x5t/68w3s |
card_uri en la respuesta cards para las Cards recién creadas.
Nota: A partir de la versión 5 de la Ads API, preview_url ya no se devuelve en la respuesta cards.
El tipo de referencia en la respuesta del objeto Tweet dependerá de la forma en que se creó el Tweet. En otras palabras, si el Tweet se creó utilizando el parámetro de solicitud card_uri, el valor de card_uri de la Card aparecerá en la respuesta. Por otro lado, si preview_url se incluyó como parte del texto del Tweet, la URL de vista previa aparecerá en la respuesta.
Identificación de Tweets con card_uri
Identificar Tweets con preview_url
Obtención de cards
Identificar contenido multimedia
Introducción
| Media ID | Media key |
|---|---|
| 1029825579531807971 | 13_1029825579531807971 |
Imágenes
| Resource | Identifier | Attribute(s) |
|---|---|---|
| Image 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 | None | |
| Media Library | Both | media_id and media_key |
| Resource | Attribute(s) | Format |
|---|---|---|
| Image cards | image | .jpg |
| Tweet* | entities["media"][0]["media_url"] o extended_entities["media"][i]["media_url"] | .jpg |
| Scheduled Tweet | None | |
| Draft Tweet | None | |
| Account Media | media_url | .jpg |
| Media Library | media_url | .jpg |
- La ubicación de esta URL depende 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 |
video_content_id, hay inconsistencias en el tipo de valor devuelto. En algunos casos es un media ID; en otros, una media key.
A continuación se muestra información sobre cómo acceder a la URL del video.
| 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 |
video_url y video_hls_url con URLs .vmap y .m3u8, respectivamente.
Media Library
A veces es necesario recuperar información adicional sobre un recurso multimedia. Un caso de uso, en el caso de las video cards, es obtener la URL mp4 en lugar de la vmap. Esto está disponible en la Media Library. Para más detalles sobre la información disponible, consulta nuestra Media Library Guide. La mayoría de los recursos que pertenecen al FULL promotable user de la cuenta de anuncios se pueden encontrar en la biblioteca. Sin embargo, hay algunas excepciones. Obtención de medios Como se indicó anteriormente, las image cards no contienen referencias ni amedia IDs ni a media keys. Como resultado, no es posible obtener sus recursos a través de la Media Library. Esto también es cierto para las imágenes de Account Media.
Las video cards requieren que el recurso de video forme parte de la Media Library (o del recurso Videos previo) antes de crearlas. Como resultado, estos recursos siempre podrán recuperarse en la Media Library. Esto también es cierto para los recursos PREROLL de Account Media.
Por último, siempre se garantiza que los medios incluidos en Tweets estén en la Media Library.
La siguiente tabla resume qué recursos pueden recuperarse en la Media Library, teniendo en cuenta si la respuesta del recurso incluye un identificador que se pueda usar en la búsqueda.
| Resource | In the Media Library |
|---|---|
| Image cards | No |
| Video cards | Yes* |
| Tweets (any media)** | Yes |
| Scheduled Tweets | Yes |
| Draft Tweets | Yes |
| Account media images | No |
Account media videos (PREROLL) | Yes |
- Para cards donde
video_content_ides una media key. Cuando el valor es un media ID, el recurso sigue existiendo en la Media Library, pero recuperarlo implica anteponerle un prefijo numérico y un guion bajo. ** Los Tweets solo devuelven media IDs. Aunque se garantiza que el recurso existe en la Media Library, obtenerlo implica anteponerle un prefijo numérico y un guion bajo.
- Cuando un recurso AMPLIFY_VIDEO se añade a la Media Library, se añade automáticamente como un recurso de Account Media con creative type PREROLL.
- Cuando se añaden a la Media Library imágenes que tienen dimensiones específicas (consulta “Creative Types” en nuestra página de enumeraciones), se añaden automáticamente como recursos de Account Media. El creative type (por ejemplo, INTERSTITIAL) depende de las dimensiones de la imagen.
Tweets
Introducción
Tweets nullcast
Promocionar Tweets
IDs de Tweet
Carruseles
Introducción
- Cargar los recursos multimedia
- Crear la card
- Crear el Tweet
- Promocionar el Tweet
Endpoints
Cuerpo JSON POST
- Un componente
SWIPEABLE_MEDIA, que acepta un array de media keys - Uno de los siguientes:
- Un componente
DETAILSpara especificar la información del sitio web - Un componente
BUTTONpara especificar la información de la App
SWIPEABLE_MEDIA debe incluir un array media_keys donde puedes especificar entre 2 y 6 imágenes o vídeos. El orden en que se pasen las media keys determina el orden en que se mostrarán.
| Sitio web | App | |
|---|---|---|
| Specify the component type | "type": "DETAILS" | "type": "BUTTON" |
| Title/Label | "title": "X" | "label": { "type": "ENUM", "value": "INSTALL" } |
| Destination | "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 deep links. Para obtener una descripción de estos campos, consulta la documentación de referencia.
Con todo esto, a continuación se muestra un ejemplo del cuerpo JSON de una solicitud POST de un carrusel de App.
Ejemplo
media_type para limitar los resultados a un tipo de contenido multimedia en particular.
card_uri, que se usará para crear un Tweet.
Tweet
Utiliza el endpoint POST accounts/:account_id/tweet para crear tu Tweet. Utiliza el card_uri de la solicitud anterior. (Respuesta truncada para mayor legibilidad.)
etiquetado-de-metadatos-de-creatividades
Introducción
Etiquetado de recursos creativos
exiftool -contributor="<YOUR APP ID>" -creative_file.jpg
exiftool -date="<date>" -creative_file.jpg
La app_id se puede encontrar en la Consola de desarrollador en Projects & Apps. Ejemplo: 16489123
El siguiente ejemplo agrega app_id como la etiqueta contributor y date como la 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
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/account_media
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| account_media_ids opcional | Limita la respuesta a los medios de cuenta deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Type: string Example: 3wpx |
| count opcional | Especifica el número de registros que se intentará recuperar por cada solicitud. Type: int Default: 200 Min, Max: 1, 1000 |
| creative_types opcional | Limita la respuesta a los medios de cuenta que coincidan con los tipos creativos especificados. Se puede especificar más de un tipo creativo separando los valores del enum con comas. 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 siguiente página de resultados. Consulta Paginación para obtener más información. Type: string Example: 8x7v00oow |
| sort_by opcional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para obtener más información. Type: string Example: created_at-asc |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true, false |
| with_total_count opcional | Incluye el atributo de respuesta total_count. Nota: Este parámetro y cursor son excluyentes. Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 cada 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 dentro de 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 |
| account_media_id obligatorio | Una referencia al medio de la cuenta con el que está operando en la solicitud. Tipo: string Ejemplo: 2pnfd |
| with_deleted opcional | Incluye los 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/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 required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio en todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| account_media_id required | Una referencia al contenido multimedia de la cuenta con el que se opera en la solicitud. Tipo: string Ejemplo: 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.
Obtén los detalles de algunas o todas las tarjetas asociadas a la cuenta actual.
Nota: Esto solo devuelve tarjetas que se hayan creado 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 dentro de 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_types optional | Restringe la respuesta únicamente a los tipos de tarjeta deseados especificando una lista separada por comas de valores de enumeración (enum). Type: enum Possible values: 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 | Restringe la respuesta únicamente a las tarjetas deseadas especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 card IDs. Type: string Example: 1044294149527166979,1044301099031658496 |
| card_uris optional | Restringe la respuesta únicamente a las tarjetas deseadas especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 valores de card URI. Type: string Example: card://1044294149527166979,card://1044301099031658496 |
| count optional | Especifica el número de registros que se intentará recuperar por cada solicitud distinta. 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: 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. Type: boolean Default: false Possible values: true, false |
| q optional | Una consulta opcional para limitar las tarjetas por name. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: realiza una coincidencia de prefijo que no distingue entre mayúsculas y minúsculas. Type: string Example: dtc |
| sort_by optional | Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Type: string Example: created_at-asc |
| with_deleted optional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: 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 required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| card_id required | El id de las tarjetas. Tipo: string Ejemplo: 1044294149527166979 |
| with_deleted optional | Incluye también los 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/1321554298900107264
Ejemplo de respuesta
POST accounts/:account_id/cards
Content-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 para la tarjeta y un array de components. Los componentes se representan como objetos y describen los atributos de la tarjeta visibles para el anunciante.
El siguiente ejemplo muestra la estructura general del payload (pero incluye información no válida).
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 |
| name required | El nombre de la tarjeta. Longitud máxima: 80 caracteres. Type: string Example: component based card |
| components sometimes required | Describe los componentes que se usarán para crear la tarjeta. Información adicional a continuación. No puede especificarse junto con slides. Nota: El orden de los componentes es importante. Type: array of objects |
| slides sometimes required | Utiliza este array de arrays para crear carruseles de destinos múltiples. Describe cada tarjeta como un grupo de componentes. Cada slide debe ser una representación completa de una tarjeta. No puede especificarse junto con components. Nota: El orden de cada slide es importante. Type: array of array |
Componentes
type que determina el esquema del objeto. La Ads API admite los siguientes tipos de componentes, agrupados en componentes basados en medios y en descripción.
- Medios:
MEDIA: un solo video o una sola imagenSWIPEABLE_MEDIA: entre 2 y 6 videos o imágenes- Descripción:
DETAILSBUTTON
type). Estos se enumeran en la siguiente tabla.
Component type | 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 array components (omitiendo intencionalmente la clave name). (Los puntos suspensivos indican los lugares donde sería necesario especificar más información.)
DETAILS o BUTTON. Los componentes basados en descripciones se renderizan debajo del contenido multimedia y tienen destinos asociados, ya sean direcciones URL o aplicaciones móviles.
Label
Los Labels definen el texto que se muestra en los botones y, por lo tanto, solo se aplican al componente BUTTON. Los objetos Label tienen dos claves obligatorias: type y value. El type debe establecerse en ENUM y el value puede ser uno de los siguientes valores: BOOK, CONNECT, INSTALL, OPEN, ORDER, PLAY o SHOP.
Tomando como base el ejemplo anterior, a continuación se 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
| Name | Description |
|---|---|
| type required | El tipo de destino, que determina su esquema. Type: enum Possible values: WEBSITE |
| url required | La URL del sitio web al que se redirige a un usuario. Type: string Example: https://devcommunity.x.com/c/advertiser-api |
| Name | Description |
|---|---|
| type required | El tipo de destino, que determina su esquema. Type: enum Possible values: APP |
| country_code required | El código de dos letras ISO 3166-1 alpha-2 del país donde se vende la app. Type: string Example: 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. Type: string Example: 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. Type: string Example: 333903271 |
| googleplay_deep_link optional | Un deep link a la app de Android que se está promocionando. Nota: Solo se puede usar si se ha proporcionado un googleplay_app_id. Type: string |
| ios_deep_link optional | Un deep link a la app de iOS que se está promocionando. Nota: Solo se puede usar si se ha proporcionado un ios_app_store_identifier. Type: 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
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| name optional | El nombre de la card. Longitud máxima: 80 caracteres. Type: string Example: component based card |
| components optional | Describe los componentes que se usarán para actualizar la card. Información adicional a continuación. No se puede especificar junto con slides. Nota: El orden de los componentes es importante. Type: array of objects |
| slides optional | Utilice este array de arrays para actualizar Multi-Destination Carousels. Describe cada card como un grupo de componentes. Cada slide debe ser una representación completa de una card. No se puede especificar junto con components. Nota: El orden de cada slide es importante. Type: 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 con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| card_id obligatorio | El id de la card que se va a eliminar. Tipo: string Ejemplo: 1044294149527166979 |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264
Ejemplo de respuesta
Obtención de Cards
card_uri, asociadas a la cuenta actual.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/all
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| card_uris required | Limita la respuesta únicamente a las cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 valores de URI de card. Type: string Example: card://1044294149527166979,card://1044301099031658496 |
| with_deleted optional | Incluye los resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: 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 utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| card_id obligatorio | Una referencia a la card con la que se opera en la solicitud. Tipo: string Ejemplo: 508pf |
| with_deleted opcional | Incluye los 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/cards/all/508pf
Ejemplo de respuesta
Tweets en borrador
GET accounts/:account_id/draft_tweets
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets
Parameters
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| count optional | Especifica el número de registros que se intentará recuperar por cada solicitud. Type: int Default: 100 Min, Max: 1, 200 |
| cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: c-jh1g0ryb |
| user_id optional | Especifica el usuario para el que se recuperarán Tweets en borrador. De manera predeterminada, cuando no se especifica, se usa el usuario promocionable FULL de la cuenta. Type: string Example: 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 con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| draft_tweet_id obligatorio | Una referencia al Tweet en borrador con el que estás trabajando en la solicitud. Tipo: string Ejemplo: 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
as_user_id.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/draft_tweets
Parámetros
| Nombre | Descripción |
|---|---|
| account_id obligatorio | Identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| as_user_id obligatorio | id de usuario del anunciante en cuyo nombre se publica 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 permite llamar a la API utilizando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: string Ejemplo: 756201191646691328 |
| text a veces obligatorio | Texto de la actualización de estado. Es obligatorio si no se especifican media_keys. Tipo: string Ejemplo: Just setting up my X. |
| card_uri opcional | Asocia una tarjeta (card) con el Tweet usando el valor card_uri de cualquier respuesta de cards, si está disponible. Tipo: string Ejemplo: card://960880280705392541 |
| media_keys opcional | Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Se pueden incluir hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Tipo: string Ejemplo: 13_1153584529292270722 |
| nullcast opcional | Indica si se debe crear un Tweet nullcast (o “Promoted-only”, solo promocionado). Tipo: boolean Valor predeterminado: true Valores posibles: true, false |
| name opcional | Nombre del borrador de Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: 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 con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| draft_tweet_id obligatorio | Una referencia al Draft Tweet con el que está trabajando en la solicitud. Tipo: string Ejemplo: 994747471329873920 |
| card_uri opcional | Asocie una card con el Tweet usando el valor de card_uri de cualquier respuesta de cards, si está disponible. Nota: Para desasignar (eliminar), especifique el parámetro sin un valor. Tipo: string Ejemplo: card://970582057284129151 |
| media_keys opcional | Asocie contenido multimedia con el Tweet especificando una lista de identificadores separados 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 un valor. Tipo: string Ejemplo: 13_1153584529292270722 |
| nullcast opcional | Indica si se debe crear un Tweet nullcast (o “Promoted-only”). Tipo: boolean Valores posibles: true, false |
| text opcional | El texto de su actualización de estado. Tipo: string Ejemplo: just setting up my twttr |
| name opcional | El nombre del Draft Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: 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 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 |
| draft_tweet_id obligatorio | Una referencia al borrador de Tweet que estás utilizando en la solicitud. Tipo: string Ejemplo: 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
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 obligatorio | El identificador de la cuenta utilizada. Aparece dentro de 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 |
| draft_tweet_id obligatorio | Una 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 siguientes endpoints: POST accounts/:account_id/tweet, POST statuses/update o POST accounts/:account_id/scheduled_tweets.
GET accounts/:account_id/cards/image_conversation
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 vinculada. Aparece dentro de 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_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. Type: string Example: 59woh |
| count opcional | Especifica el número de registros que se intentará obtener por cada solicitud. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor opcional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información. Type: string Example: 8x7v00oow |
| q opcional | Una consulta opcional para acotar las cards por name. Omite este parámetro para obtenerlas todas. Longitud máxima: 80 caracteres. Nota: Realiza una coincidencia de prefijo que no distingue mayúsculas y minúsculas. Type: string Example: night |
| sort_by opcional | Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: created_at-asc |
| with_deleted opcional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true, false |
| with_total_count opcional | Incluye el atributo de respuesta total_count. Nota: Este parámetro y cursor son excluyentes. Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente fijados 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/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 de anunciante. Aparece dentro de la ruta del recurso y, en 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 | Una referencia a la tarjeta de conversación con imagen con la que trabajas en la solicitud. Tipo: string Ejemplo: 59woh |
| with_deleted opcional | Incluye los resultados eliminados en tu solicitud. Tipo: boolean Valor predeterminado: false Posibles valores: 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
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation
Parámetros
| Nombre | Descripción |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 |
| first_cta required | El hashtag del llamado a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: #ShareNow |
| first_cta_tweet required | El texto del Tweet que se utilizará cuando se haga clic en la primera CTA. Type: string Example: I Heart @AdsAPI |
| media_key required | La media key de una imagen que se utilizará en esta tarjeta. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800 px y una relación de aspecto ancho:alto de 1.91:1. Type: string Example: 3_1151345051104991073 |
| name required | El nombre de la tarjeta. Type: string Example: image conversation card |
| thank_you_text required | El texto que se mostrará después de que se haga clic en la CTA. Longitud máxima: 23 caracteres. Type: string Example: Thank you |
| second_cta sometimes required | El hashtag del llamado a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si title no está establecido. Example: #ShareAgain |
| second_cta_tweet sometimes required | El texto del Tweet que se utilizará cuando se haga clic en la segunda CTA. Nota: Obligatorio si second_cta está establecido. Type: string Example: I Heart @AdsAPI Again |
| title sometimes required | El título de la tarjeta, que aparece debajo de la imagen y encima de las CTAs. Longitud máxima: 23 caracteres. Type: string Nota: Obligatorio si second_cta no está establecido. Example: Start a conversation |
| third_cta optional | El hashtag del llamado a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: #ShareMore |
| third_cta_tweet sometimes required | El texto del Tweet que se utilizará cuando se haga clic en la tercera CTA. Type: string Nota: Obligatorio si third_cta está establecido. Example: I Heart @TwitterDev |
| fourth_cta optional | El hashtag del llamado a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: #ShareExtra |
| fourth_cta_tweet sometimes required | El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Type: string Nota: Obligatorio si fourth_cta está establecido. Example: I Heart @TwitterDev Again |
| unlocked_image_media_key optional | 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 Media Library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800 px y una relación de aspecto ancho:alto de 5:2. Type: string Example: 3_883112887618682880 |
| thank_you_url optional | La URL que se mostrará junto con el texto de agradecimiento. Type: string Example: 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
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 imagen de la image conversation card con la que estás operando en la solicitud. Type: string Example: 4i0qg |
| first_cta optional | El hashtag de Call-To-Action (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: #ShareNow |
| first_cta_tweet optional | El texto del Tweet que se utilizará cuando se haga clic en la primera CTA. Type: string Example: I Heart @AdsAPI |
| second_cta optional | El hashtag de Call-To-Action (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si title no está establecido (not set). Example: #ShareAgain |
| second_cta_tweet optional | El texto del Tweet que se utilizará cuando se haga clic en la segunda CTA. Nota: Obligatorio si second_cta está establecido. Type: string Example: I Heart @AdsAPI Again |
| third_cta optional | El hashtag de Call-To-Action (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: #ShareMore |
| third_cta_tweet optional | El texto del Tweet que se utilizará cuando se haga clic en la tercera CTA. Type: string Nota: Obligatorio si third_cta está establecido. Example: I Heart @TwitterDev |
| fourth_cta optional | El hashtag de Call-To-Action (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: #ShareExtra |
| fourth_cta_tweet optional | El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Type: string Nota: Obligatorio si fourth_cta está establecido. Example: I Heart @TwitterDev Again |
| media_key optional | La media key de una imagen que se utilizará en esta tarjeta. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800px y una relación de aspecto ancho:alto de 1.91:1. Type: string Example: 3_1151345051104991073 |
| name optional | El nombre de la tarjeta. Type: string Example: moon card |
| thank_you_text optional | El texto que se mostrará después de hacer clic en la CTA. Longitud máxima: 23 caracteres. Type: string Example: Thank you |
| thank_you_url optional | La URL que se mostrará con el texto de agradecimiento. Type: string Example: https://example.com/thankyou |
| title optional | El título de la tarjeta, que aparece debajo de la imagen y encima de las CTAs. Longitud máxima: 23 caracteres. Type: string Nota: Obligatorio si second_cta no está establecido (not set). Example: Start a conversation |
| unlocked_image_media_key optional | 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 media library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800px y una relación de aspecto ancho:alto de 5:2. Type: string Example: 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 a 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 Image Conversation Card con la que estás trabajando 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 de medios
GET accounts/:account_id/media_library
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 dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| count 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 obtener 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 consulta opcional para acotar el recurso por los campos name, title, file_name y description. Nota: Esto realiza una coincidencia de términos que no distingue 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 de anunciante. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| media_key obligatorio | Una referencia al objeto de la biblioteca de medios con el que se está operando en la solicitud. Tipo: string Ejemplo: 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, este pasa a estar disponible automáticamente como un recurso account_media de tipo PREROLL.
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 utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| media_key required | La media_key del contenido cargado. Se devuelve una media_key en la respuesta de POST media/upload cuando se especifica una media_category. Type: string Example: 3_931236738554519552 |
| description optional | La descripción que aparece debajo del video cuando se publica como un Tweet. Longitud máxima: 200 caracteres. De forma predeterminada, no se muestra en el Tweet. Para mostrar la description del video, usa el parámetro video_description con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: This is the description under the 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 multimedia en la interfaz de Media Library en ads.x.com. Este campo estará vacío cuando file_name no se haya definido. Type: string Example: coffee.jpeg |
| name optional | El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta que aparece debajo de cada recurso multimedia en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando name no se haya definido. Type: string Example: Latte |
| poster_media_key optional | Especifica una imagen de portada para el video usando la media_key de una imagen cargada. Si no se especifica, se usará el primer fotograma. Nota: Solo se puede usar con videos. Type: string Example: 3_890599134483242005 |
| title optional | El título (encabezado) que aparece debajo del video cuando se publica como un Tweet. Longitud máxima: 70 caracteres. De forma predeterminada, no se muestra en el Tweet. Para mostrar el title del video, usa 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
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 dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| media_key required | Una referencia al objeto de la biblioteca de medios con el que estás operando 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. De forma predeterminada, esto no se muestra en el Tweet. Para mostrar la description del video, usa 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 multimedia en la interfaz de Media Library en ads.x.com. Este valor estará vacío cuando file_name no se haya establecido. Type: string Example: coffee.jpeg |
| name optional | El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta que aparece debajo de cada recurso multimedia en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando name no se haya establecido. Type: string Example: Latte |
| poster_media_key optional | Especifica una imagen de póster para el video usando el 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. De forma predeterminada, esto no se muestra en el Tweet. Para mostrar el title del video, usa 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
Respuesta de ejemplo
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key
Parámetros
| Nombre | Descripción |
|---|---|
| account_id required | Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| media_key required | Referencia al objeto de la biblioteca de medios con el que trabajas en la solicitud. Tipo: string Ejemplo: 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
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/poll
Parameters
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| card_ids optional | Limita la respuesta solo a las tarjetas de encuesta deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 57i77 |
| count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: 8x7v00oow |
| q optional | Una consulta opcional para limitar las tarjetas por name. Omite este parámetro para recuperarlas todas. Longitud máxima: 80 caracteres. Nota: Realiza una coincidencia por prefijo sin distinguir mayúsculas y minúsculas. Type: string Example: night |
| sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: created_at-asc |
| with_deleted optional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | Incluye el atributo de respuesta total_count. Nota: Este parámetro y cursor son mutuamente excluyentes. Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos. Type: boolean Default: false Possible values: 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
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| card_id required | Una referencia a la poll card con la que se opera en la solicitud. Tipo: string Ejemplo: 57i8t |
| with_deleted optional | Incluye en la solicitud los resultados eliminados. Tipo: boolean Valor predeterminado: false Valores posibles: 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
PROMOTED_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 required | El identificador de la cuenta utilizada. Aparece dentro de 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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| duration_in_minutes required | La cantidad de tiempo (en minutos) que la encuesta permanecerá abierta. Después de que transcurra 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 añade a un Tweet. Type: int Min, Max: 5, 10080 |
| first_choice required | La primera opción de la encuesta. Longitud máxima: 25 caracteres. Type: string Example: One |
| name required | El nombre de la tarjeta. Type: string Example: poll card |
| second_choice required | La segunda opción de la encuesta. Longitud máxima: 25 caracteres. Type: string Example: Two |
| fourth_choice optional | La cuarta opción de la encuesta. Longitud máxima: 25 caracteres. Nota: La primera, segunda y tercera opciones deben definirse cuando se utilice este parámetro. Type: string Example: Four |
| media_key optional | 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 800px y una relación de aspecto ancho:alto de 1.91:1. |
| third_choice optional | La tercera opción de la encuesta. Longitud máxima: 25 caracteres. Nota: La primera y segunda opciones deben definirse cuando se utilice este parámetro. 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 dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto 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 encuesta con la que se opera en la solicitud. Tipo: string Ejemplo: 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 prerroll
GET accounts/:account_id/preroll_call_to_actions
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions
Parámetros
| Nombre | Descripción |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 |
| line_item_ids optional | Limita la respuesta solo a las CTAs prerroll asociadas con los line items especificados mediante una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ids. Type: string Example: 8v53k |
| count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud distinta. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta la sección Pagination para obtener más información. Type: string Example: 8x7v00oow |
| preroll_call_to_action_ids optional | Limita la respuesta solo a las CTAs prerroll deseadas mediante una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ids. Type: string Example: 8f0 |
| sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulta la sección Sorting para obtener más información. Type: string Example: created_at-asc |
| with_deleted optional | Incluye resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: 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 incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos. Type: boolean Default: false Possible values: 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 required | El identificador de la cuenta utilizada. Aparece dentro de 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 required | Una referencia al llamado a la acción de prerroll con el que realiza la solicitud. Tipo: string Ejemplo: 8f0 |
| with_deleted optional | 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/preroll_call_to_actions/8f0
Ejemplo de respuesta
POST accounts/:account_id/preroll_call_to_actions
PREROLL_VIEWS.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions
Parámetros
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 |
| call_to_action required | El texto de la CTA (llamado a la acción) para el botón que se muestra en el anuncio. Type: enum Possible values: GO_TO, SEE_MORE, SHOP, VISIT_SITE, WATCH_NOW |
| call_to_action_url required | La URL a la que se redirigirá al usuario cuando se haga clic en el botón de CTA. Type: string Example: https://www.x.com |
| line_item_id required | Una referencia al line item con el que trabajas 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 dentro de 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 preroll con el que operas en la solicitud. Tipo: string Ejemplo: 8f0 |
| call_to_action opcional | El texto del CTA para el botón que se muestra dentro del anuncio. Tipo: enum Valores posibles: 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 de CTA. Tipo: string Ejemplo: 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 utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para 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 llamado a la acción (CTA) de prerroll con el que operas 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
URL del 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 dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| count opcional | Especifica el número de registros que se intentará recuperar en cada solicitud. Type: int Default: 100 Min, Max: 1, 200 |
| cursor opcional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: c-j3cn6n40 |
| user_id opcional | Especifica el usuario para el que se recuperarán Tweets programados. De forma predeterminada, se utiliza el usuario promocionable FULL de la cuenta cuando no se establece. 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 required | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y suele ser un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| scheduled_tweet_id required | Una referencia al Tweet programado con el que se está operando en la solicitud. Tipo: string Ejemplo: 917438609065623552 |
Ejemplo de solicitud
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/917438609065623552
Respuesta de ejemplo
POST accounts/:account_id/scheduled_tweets
as_user_id.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets
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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| scheduled_at required | La hora, expresada en formato ISO 8601, a la que el Tweet debe publicarse (o hacerse visible). Nota: los Tweets solo se pueden programar hasta con un año de antelación. Nota: los Tweets solo deben programarse con granularidad de minutos; los segundos se ignorarán. Type: string Example: 2017-12-31T23:59:00Z |
| as_user_id required | El ID de usuario del anunciante en cuyo nombre estás publicando el Tweet. El anunciante debe conceder 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: long Example: 756201191646691328 |
| text sometimes required | El texto de tu actualización de estado. Es obligatorio si no se especifican media_keys. Type: string Example: just setting up my twttr |
| card_uri optional | Asocia una tarjeta (card) con el Tweet usando el valor card_uri de cualquier respuesta de tarjetas (cards), si está disponible. Type: string Example: card://855591459410511943 |
| media_keys optional | 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. Nota: el recurso multimedia debe estar en la Media Library de la cuenta. Type: string Example: 13_1153584529292270722 |
| nullcast optional | Indica si se debe crear un Tweet nullcasted (o “Promoted-only”). Type: boolean Default: true Possible values: true, false |
| name optional | 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
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| scheduled_tweet_id required | Una referencia al Tweet programado con el que estás operando en la solicitud. Type: string Example: 870321875435442177 |
| card_uri optional | Asocia una tarjeta con el Tweet usando el valor card_uri de cualquier respuesta de tarjetas, si está disponible. Note: Para desasignar (eliminar), especifica el parámetro sin un valor. Type: string Example: card://875146925316386347 |
| media_keys optional | 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. Note: El recurso multimedia debe estar en la Media Library de la cuenta. Note: Para desasignar (eliminar), especifica el parámetro sin un valor. Type: string Example: 13_1153584529292270722 |
| nullcast optional | Indica si se debe crear un Tweet de tipo nullcast (o “Promoted-only”). Type: boolean Possible values: true, false |
| scheduled_at optional | La hora, expresada en formato ISO 8601, en la que el Tweet debe publicarse (o pasar a estar activo). Type: string Example: 2017-12-31T23:59:59Z |
| text optional | El texto de tu actualización de estado. Type: string Example: just setting up my twttr |
| name optional | El nombre del Tweet programado. Longitud máxima: 80 caracteres. Type: string Example: 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 a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| scheduled_tweet_id obligatorio | Una referencia al Scheduled Tweet con el que se opera 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
- Permite obtener la vista previa de varios Tweets (hasta 200) en una sola solicitud a la API
- Representación precisa y actualizada del diseño y el estilo del Tweet
- Compatible con todos los formatos y tipos de cards 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 required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| tweet_ids required | Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 identificadores. Nota: Los identificadores deben corresponder al tweet_type especificado. Por ejemplo, si se pasa un ID de Tweet programado y se especifica tweet_type=PUBLISHED, no se devolverá una vista previa para ese ID. Type: long Example: 1122911801354510336,1102836745790316550 |
| tweet_type required | El tipo de Tweet para los tweet_ids especificados. Type: enum Valores posibles: 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
user_id. Puede ser cualquiera de los promotable users de la cuenta.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/tweets
Parámetros
| Nombre | Descripción |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de 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 |
| tweet_type required | El tipo de Tweet para los tweet_ids especificados. Type: enum Possible values: DRAFT, PUBLISHED, SCHEDULED |
| count optional | Especifica la cantidad de registros que se intentarán recuperar por cada solicitud distinta. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: AAAAAFhLRpQLNF-sGBSgAA |
| include_mentions_and_replies optional | Indica si se deben filtrar las menciones y respuestas de la lista de Tweets disponibles. Type: boolean Default: false Possible values: true, false |
| name optional | Una consulta opcional para restringir los Tweets por name. Omite este parámetro para recuperar todos. Longitud máxima: 80 caracteres. Nota: Realiza una coincidencia de prefijos sin distinción entre mayúsculas y minúsculas. Type: string Example: dtc |
| timeline_type optional | Indica si se deben devolver Tweets nullcasted (también conocidos como “Promoted-only”), Tweets orgánicos o ambos. Type: enum Default: NULLCAST Possible values: ALL, NULLCAST, ORGANIC |
| trim_user optional | 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. Type: boolean Default: false Possible values: true, false |
| tweet_ids optional | Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Nota: Los ID deben corresponder con el tweet_type especificado. Por ejemplo, si se pasa el ID de un Tweet programado, entonces el tweet_type debe ser SCHEDULED para que ese Tweet se devuelva en la respuesta. Type: long Example: 1122911801354510336,1102836745790316550 |
| user_id optional | Especifica el usuario al que se limitarán los Tweets. De manera predeterminada, cuando no se establece, 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/tweets?tweet_ids=1166476031668015104&tweet_type=PUBLISHED&trim_user=true
Ejemplo de respuesta
POST accounts/:account_id/tweet
FULL de la cuenta (predeterminado) o para el usuario especificado en el parámetro as_user_id. Se admite tanto la creación de Tweets nullcasted (predeterminada) como orgánicos. Los Tweets nullcasted no aparecen en la cronología pública y no se entregan a los seguidores. Cualquiera de los dos tipos se puede usar en campañas.
Si el usuario autenticado no es el usuario promocionable FULL de esta cuenta, comprueba si tiene permiso para tuitear en nombre de este usuario 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.
Cuando utilices el endpoint upload.x.com para contenido multimedia, pasa el mismo valor de user_id para el parámetro additional_owners que el valor as_user_id que envías a este endpoint.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/tweet
Parámetros
| Name | Description |
|---|---|
| account_id obligatorio | El identificador de la cuenta utilizada. Aparece dentro de 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 con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| as_user_id obligatorio | El ID de usuario del anunciante en cuyo nombre estás publicando el Tweet. El anunciante debe otorgar a tu handle (o handles) acceso 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. 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 tarjeta (card) con el Tweet usando el valor card_uri de cualquier respuesta de tarjetas (cards), si está disponible. Tipo: string Ejemplo: card://853503245793641682 |
| conversation_settings opcional | Elige quién puede responder a este Tweet. Cualquiera que se mencione siempre puede responder. Nota: Este campo no se devolverá en la respuesta de la solicitud POST, pero se devolverá al realizar una solicitud GET. Nota: Este parámetro solo funciona en Ads API v8 y posteriores. Tipo: enum Valor 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 de tipo nullcast (o “Promoted-only”). Nota: Los Tweets orgánicos (nullcast=false) solo se pueden crear para el usuario autenticado. Tipo: boolean Valor predeterminado: true Valores posibles: true, false |
| trim_user opcional | Indica si se debe excluir el objeto user en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto user que se devolverá es el ID de usuario del autor del Tweet. Tipo: boolean Valor predeterminado: false Valores posibles: true, false |
| tweet_mode opcional | Indica si la respuesta debe estar en modo de compatibilidad o en modo extendido. Consulta esto para obtener información adicional. Tipo: string Valores posibles: compat, extended |
| video_cta opcional | La CTA para el video. Tipo: enum Valores posibles: VISIT_SITE, WATCH_NOW |
| video_cta_value opcional | El valor para la CTA correspondiente en el 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 tu servicio con la plataforma de publicidad de X |
| video_title opcional | El título (headline) 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 que pertenece a la cuenta actual.
URL de recurso
https://ads-api.x.com/12/accounts/:account_id/tweets/:tweet_id/name
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 en todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| tweet_id required | Referencia al Tweet con el que se opera en la solicitud. Tipo: long Ejemplo: 994747471329873920 |
| name optional | El nombre del Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: Tweet with name |
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 siguientes endpoints: POST accounts/:account_id/tweet, POST statuses/update o POST accounts/:account_id/scheduled_tweets.
GET accounts/:account_id/cards/video_conversation
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation
Parameters
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| card_ids optional | Limita la respuesta solo a las video conversation cards deseadas, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Type: string Example: 5a86h |
| count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información. Type: string Example: 8x7v00oow |
| q optional | Una consulta opcional para limitar las cards por name. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: Esto realiza una coincidencia de prefijo que no distingue entre mayúsculas y minúsculas. Type: string Example: night sky |
| sort_by optional | Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: created_at-asc |
| with_deleted optional | Incluye los resultados eliminados en la solicitud. Type: boolean Default: false Possible values: 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 incluyen total_count tendrán límites de tasa más bajos, actualmente fijados en 200 por cada 15 minutos. Type: boolean Default: false Possible values: 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
| Name | Description |
|---|---|
| account_id required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| card_id required | Una referencia a la video conversation card con la que estás trabajando en la solicitud. Type: string Example: 4i0ya |
| with_deleted optional | Incluye resultados eliminados en tu 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
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 utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
| first_cta obligatorio | El hashtag del llamado a la acción (CTA) de la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Ejemplo: #APIs |
| first_cta_tweet obligatorio | El texto del Tweet que se usará al hacer clic en el primer CTA. Type: string Example: Ads API |
| media_key obligatorio | La media key de un video que se usará en esta tarjeta. Nota: El video debe estar en la Media Library 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á cuando se haga clic en el CTA. Longitud máxima: 23 caracteres. Type: string Ejemplo: Build it |
| title a veces obligatorio | El título de la tarjeta, que aparece debajo del video y encima de las CTA. Longitud máxima: 23 caracteres. Type: string Nota: Obligatorio si second_cta no está establecido. Ejemplo: Developers |
| second_cta a veces requerido | El hashtag de llamado a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si title no está establecido. Ejemplo: #ShareAgain |
| second_cta_tweet a veces requerido | 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 |
| poster_media_key opcional | La media key de la imagen de portada que se utilizará en esta tarjeta. Si no se especifica, se usará el primer fotograma. Nota: El video debe estar en la Media Library 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 #). Type: string Example: #ShareMore |
| third_cta_tweet a veces es obligatorio | El texto del Tweet que se utilizará cuando se haga clic en el tercer CTA. Type: string Nota: Obligatorio si se ha establecido third_cta. Example: 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 #). Type: string Example: #ShareExtra |
| fourth_cta_tweet a veces obligatorio | El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Tipo: string Nota: Obligatorio si fourth_cta está definido. Ejemplo: I Heart @TwitterDev Again |
| thank_you_url opcional | La URL que se mostrará junto al texto de agradecimiento. Type: string Example: https://example.com/thankyou |
| unlocked_image_media_key opcional | Una 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 vídeo del endpoint GET accounts/:account_id/media_library que se usará 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=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 utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, a excepción de 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 trabajando en la solicitud. Type: string Example: 5a86h |
| first_cta opcional | El hashtag de llamado a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Ejemplo: #APIs |
| first_cta_tweet opcional | El texto del Tweet que se utilizará cuando se haga clic en el primer CTA. Type: string Example: Ads API |
| second_cta opcional | El hashtag de llamado a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si title no está definido. 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 #). Type: string Example: #ShareMore |
| third_cta_tweet opcional | El texto del Tweet que se usará cuando se haga clic en el tercer CTA. Type: string Nota: Obligatorio si se establece third_cta. 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 #). Type: string Example: #ShareExtra |
| fourth_cta_tweet opcional | El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Type: string Nota: Obligatorio si fourth_cta está establecido. Ejemplo: I Heart @TwitterDev Again |
| media_key opcional | La media key de un video que se utilizará en esta tarjeta. Nota: El video debe estar en la Media Library 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. type: string Ejemplo: developers card |
| poster_media_key opcional | La media key de una imagen de portada que se usará en esta tarjeta. Si no se especifica, se usará el primer fotograma. Nota: El video debe estar en la Media Library 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. Type: string Example: Build it |
| thank_you_url opcional | La URL que se mostrará junto con el texto de agradecimiento. Type: string Example: https://example.com/thankyou |
| title opcional | El título de la tarjeta, que aparece debajo del video y encima de los CTAs. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si second_cta no está establecido (not). Ejemplo: Start a conversation |
| unlocked_image_media_key opcional | Una media_key de una imagen que se usará en el escenario de desbloqueo instantáneo. Este campo es 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 vídeo 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 card
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 required | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
| card_id required | Una referencia a la Video Conversation Card con la que se está operando en la solicitud. Tipo: string Ejemplo: 4i0ya |
Ejemplo de solicitud
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/4i0ya