> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Creativos
export const Button = ({href, children}) => {
return
;
};
## Descripción general
Los creativos son entidades que se pueden promocionar en una campaña. Las Publicaciones pueden incluir texto, imágenes, GIF, videos o tarjetas. Las tarjetas pueden incluir imágenes o videos.
Los creativos de imagen, GIF o video se cargan usando ya sea el [POST media/upload](/es/x-api/media/upload-media#post-media-upload), un endpoint de carga simple que solo admite imágenes, o los endpoints POST media/upload (chunked). Estos se pueden agregar a
tarjetas:
* 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
Para obtener más detalles sobre las tarjetas, consulta la página Cards. La página Promoted Video ofrece detalles sobre cómo asociar videos con tarjetas o 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
Las siguientes especificaciones de imagen se aplican a los recursos utilizados en [Cards](/es/x-ads-api/creatives#cards-2). Las imágenes deben ser de 3 MB o menos y tener un ancho mínimo de 800px. Además, admitimos las siguientes relaciones de aspecto (ancho:alto).
* 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
Admitimos los siguientes formatos de imagen: .bmp, .jpeg y .png.
#### Video
Las siguientes especificaciones de video se aplican a los recursos usados en [Cards](/es/x-ads-api/creatives#cards-2). Se admiten las siguientes relaciones de aspecto (ancho:alto).
* 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
Este documento ofrece una breve descripción general del proceso para cargar y promocionar video a través de la Ads API.
La Ads API admite Video Promocionado en [Tweets](/es/x-ads-api/creatives#tweets-2) y en las siguientes tarjetas:
* [Video Website](https://devcommunity.x.com/t/ads-api-version-11/168814)
* [Video App Download](https://devcommunity.x.com/t/ads-api-version-11/168814)
* [Video Conversation](/es/x-ads-api/creatives#video-conversation-cards)
Primero, carga el video usando el endpoint [POST media/upload (chunked)](https://developer.x.com/en/docs/media/upload-media/api-reference/post-media-upload-init.html). Usando el `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
Para crear un Tweet, usa el endpoint [POST accounts/:account\_id/tweet](/es/x-ads-api/creatives#get-accounts-account-id-tweets) junto con el `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
Las cards de Video App Download y Video Conversation admiten la posibilidad de agregar imágenes de póster. Sube una imagen para usar en estas cards utilizando el endpoint [POST media/upload](https://developer.x.com/en/docs/media/upload-media/api-reference/post-media-upload.html).
Crea la card usando uno de los siguientes endpoints:
* [POST accounts/:account\_id/cards/video\_website](https://devcommunity.x.com/t/ads-api-version-11/168814)
* [POST accounts/:account\_id/cards/video\_app\_download](https://devcommunity.x.com/t/ads-api-version-11/168814)
* [POST accounts/:account\_id/cards/video\_conversation](https://devcommunity.x.com/t/ads-api-version-11/168814)
utilizando el `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
Para obtener instrucciones detalladas sobre la carga de vídeo a través de la API, consulta la [Guía de carga de vídeo](https://developer.x.com/en/docs/media/upload-media/uploading-media.html).
Los vídeos también se pueden promocionar como recursos de pre-roll. Consulta la [Guía del objetivo de vistas de vídeo pre-roll](/es/x-ads-api/campaign-management#video-views-preroll-objective) para una explicación detallada.
* (A partir de 2015-10-22) Al cargar vídeos que se utilizarán en contenido promocionado, el parámetro `media_category` debe establecerse con el valor `amplify_video` para todas las solicitudes de comando `INIT` al endpoint [POST media/upload (chunked)](https://developer.x.com/en/docs/media/upload-media/api-reference/post-media-upload-init.html). 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 comando `STATUS` se 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
Los Tweets programados permiten que un anunciante o usuario cree un Tweet que se pueda programar para publicarse en una fecha posterior. Además de poder crear y administrar estos Tweets, la API permite asociarlos a una partida (line item) para promocionarlos en cuanto el Tweet se publique. Esto permite a los anunciantes preparar Tweets nativos y planificar sus creatividades de campaña con antelación a cualquier iniciativa clave. Por ejemplo, preparar un Tweet creativo para que se publique inmediatamente tras el anuncio de un nuevo producto.
El conjunto completo de funcionalidades que ofrecen los endpoints de la API de Tweets programados se enumera a continuació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 `id` del Tweet publicado
#### Endpoints de la API
El conjunto completo de endpoints relacionados con la funcionalidad anterior se enumera a continuación:
#### Gestión de Tweets programados
* [GET accounts/:account\_id/scheduled\_tweets](/es/x-ads-api/creatives#get-accounts-account-id-scheduled-tweets) (obtener una lista de todos los Tweets programados)
* [GET accounts/:account\_id/scheduled\_tweets/:scheduled\_tweet\_id](/es/x-ads-api/creatives#get-accounts-account-id-scheduled-tweets) (buscar un Tweet programado específico mediante su `id`)
* [POST accounts/:account\_id/scheduled\_tweets](/es/x-ads-api/creatives#post-accounts-account-id-scheduled-tweets) (crear un nuevo Tweet programado)
* [PUT accounts/:account\_id/scheduled\_tweets/:scheduled\_tweet\_id](/es/x-ads-api/creatives#example-request-39) (modificar un Tweet programado existente)
* [DELETE accounts/:account\_id/scheduled\_tweets/:scheduled\_tweet\_id](/es/x-ads-api/creatives#example-request-40) (eliminar un Tweet programado mediante su `id`)
* [GET accounts/:account\_id/scheduled\_tweets/preview/:scheduled\_tweet\_id](/es/x-ads-api/creatives#scheduled-tweets-2) (obtener una vista previa de un Tweet programado existente)
#### Tweets promocionados programados
* [GET accounts/:account\_id/scheduled\_promoted\_tweets](/es/x-ads-api/campaign-management#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](/es/x-ads-api/campaign-management#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](/es/x-ads-api/campaign-management#post-accounts-account-id-scheduled-promoted-tweets) (crear un nuevo Tweet promocionado programado)
* [DELETE accounts/:account\_id/scheduled\_promoted\_tweets/:scheduled\_promoted\_tweet\_id](/es/x-ads-api/campaign-management#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](/es/x-ads-api/creatives#scheduled-tweets-2) (ver un Tweet programado existente)
Dado que los Tweets programados son entidades independientes de los Tweets “en vivo”, se ejecutan dos conjuntos diferentes de validaciones al crear o editar estos Tweets. El primer conjunto de reglas de validación se ejecuta durante el paso de creación del Tweet programado, específicamente:
#### 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](https://developer.x.com/content/developer-twitter/en/docs/ads/campaign-management/api-reference/authenticated-user-access#get-accounts-account-id-authenticated-user-access)
* 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 hora `scheduled_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
**Crear un nuevo Tweet programado**
Se puede crear un nuevo Tweet programado usando el endpoint [POST accounts/:account\_id/scheduled\_tweets](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/scheduled-tweets#post-accounts-account-id-scheduled-tweets). Este endpoint tiene los siguientes parámetros obligatorios: la hora en `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".
```
twurl -H 'ads-api.x.com' -X POST "/6/accounts/:account_id/scheduled_tweets" -d 'scheduled_at=2017-12-24T23:59:00Z&text=Happy Holidays!'
```
Se creará el siguiente Tweet programado:
```json theme={null}
{
"request": {
"params": {
"text": "Happy Holidays!",
"scheduled_at": "2017-12-24T23:59:00Z"
}
},
"data": {
"completed_at": null,
"id_str": "917507899668099072",
"text": "Happy Holidays!",
"user_id": "3271358660",
"scheduled_status": "SCHEDULED",
"id": 917507899668099100,
"nullcast": true,
"created_at": "2017-10-09T21:51:44Z",
"scheduled_at": "2017-12-24T23:59:00Z",
"card_uri": null,
"updated_at": "2017-10-09T21:51:44Z",
"tweet_id": null,
"media_keys": []
}
}
```
Una vez que este Tweet programado se publique, el campo `tweet_id` se completará con el ID del Tweet "en vivo".
**Ver un Tweet programado**
El endpoint [GET accounts/:account\_id/tweet\_previews](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/tweet-previews#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.
```
twurl -H ads-api.x.com -X GET "/6/accounts/18ce54bgxky/tweet_previews?tweet_type=SCHEDULED&tweet_ids=917507899668099072
```
```json theme={null}
{
"request": {
"params": {
"tweet_type": "SCHEDULED",
"tweet_ids": [
"917507899668099072"
],
"account_id": "18ce54bgxky"
}
},
"data": [
{
"tweet_id": "1126633863155871744",
"preview": "<\iframe class='tweet-preview' src='https://ton.smf1.x.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAAK1WTW%2FjNhD9Kyyv9dqSZdmOgALJbhJsCyxaIDkUWBUEJY0lNhSpklRSN%2FV%2F71CyZbm297S%2BWJxPzpt5I71T9wbgaELeaW6AOygYxyN9rlryhW9JcEPmUbKIkuiG%2FBjgj8yD8IZOqChoEobz5TKK1ssojOP1KlwtFl7BrDMY4oIW%2FTatlMzB3z7JZ940W%2FJZS1Hwrf0Btc60Kve3oMmGSwsTWgjbSL7tXJjhqgSafA0mYfzHhIJywgmwNHmnFbeV4yU%2Bf0WN3daZlvtDa8Gw2htrdRCZXrlDU92aHIPStA2CKOekMrD5KaWVc02SztIZps%2Bh0rIAg27TXNcpJQYk2ii90VLqt7R3ht%2B4cQoMeVClUIAPd03Th01nvDfx0ClmoJFYk0aouGst82gqROaKskf03KCr7LLvXnXN02K3QTHFaziovYdH0seL5qswitfLZTBq6FGIRfSe9Lm1FTfkY%2BX%2FFcpPAlNRC7eufdFSY1%2BxASh84oo8YitzYXM9IZ%2FuaNcQ1HjMbQc61l0VXDmYlsJVbTYVGq0KwPCi2cf5tQFFnjR2zyDU6YycwX%2Fr3oRzvfKpwTaSZ8NfQUoU%2FUsetanxAV79VElhHbm1oIrSiILcvvgquqSN0Q7y8Uz2TQdjWa5bhZP8IUShEeh8IvIxkVB7SY%2FyKctaIL%2B0kgQrMp8n0SKJ10eWxZ4t%2FBXHUzg4idu6nOnNxsIQ1Yka2D9aDc0sQTNQPJP%2B2sgqvPUrGLERozL68ToNLRELvBj4VuZaOSOy1mmsdAi2dxaWOeyhlRzVl6TYozMnhHIjJLCM5y%2BlwaweHOn96afg%2FuHhnl60ETUvgR1HpJsQntkptrcuO0bOOhuLg1NBPfyH6Swrpw2W9O24rBu8kwH8DuEdns9Kv1hLc5rsxBaTLcN1HIdhHIVRuFov5wtMXH748vO2%2BP0jUzjFXE7%2FbMa3%2BFZl3z1ZxhWyjv2fwlfy9NaY6LhO0lm4WC3WcRSvlqO4UqiXYT7C%2B7vwcT7SWlFAxg3LtMHNfH2ODnZ4kIPVPRo9jnN1r5eDNup%2BIy2y5GxuDrQqYMNb6dje9or44HOyQYTnWs%2FXXoD7%2Ba8WrGO4hwZuK%2B2Qt%2F32tAPhB%2B4xt238qjVQtpIbuuvIP6wbjfAIhStncO3eZ0f9keMHmYHuo%2BCwFoJ%2BDfktdEF0JPfebbxgct30b%2BdhY%2B51u%2FGm2U2IR7rW%2FbJU%2FdcBfpEchHjwoO52%2FwENmVvErwgAAA%3D%3D'>"
}
]
}
```
Arriba se muestra una vista de ejemplo del Tweet programado recién creado
**Asociar un Tweet programado con un elemento de línea**
Si bien los Tweets programados se pueden usar para crear Tweets orgánicos, también permitimos que los socios creen un Tweet “solo promocionado” (`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](https://developer.x.com/content/developer-twitter/en/docs/ads/campaign-management/api-reference/scheduled-promoted-tweets#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.
```
twurl -H 'ads-api.x.com' -X POST "/6/accounts/:account_id/scheduled_promoted_tweets" -d 'line_item_id=a44qc&scheduled_tweet_id=917507899668099072'
```
```json theme={null}
{
"data": {
"line_item_id": "a44qc",
"id": "26576",
"created_at": "2017-10-09T22:24:16Z",
"updated_at": "2017-10-09T22:24:16Z",
"scheduled_tweet_id": "917507899668099072",
"tweet_id": null,
"deleted": false
},
"request": {
"params": {
"line_item_id": "a44qc",
"scheduled_tweet_id": 917507899668099100,
"account_id": "aaaaa"
}
}
}
```
Este endpoint solo crea una asociación entre un determinado Scheduled Tweet y un line item. Una vez que las fechas de vuelo de la campaña/line item estén vigentes, el line item comenzará automáticamente a publicar el Tweet “en vivo” correspondiente. Aunque en este paso sí validamos que el Scheduled Tweet esté en el estado `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?
Una vez que un Tweet programado está a punto de publicarse, o, dicho de otro modo, en el momento `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_id` se añade a las siguientes entidades:
* Tweet programado
* Tweet programado promocionado
* Se crea una nueva entidad de Tweet promocionado
#### Mejores prácticas
Se recomiendan las siguientes mejores prácticas al crear o promocionar Tweets programados:
* 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_time` y `end_time`) se alineen con la hora `scheduled_at` del 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
Los endpoints de Media Library permiten administrar imágenes, GIFs y vídeos para cuentas de X Ads. Los recursos multimedia en la biblioteca se pueden usar en Tweets y para crear cards. También se pueden reutilizar en múltiples [creatives](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/overview), lo que elimina la necesidad de subir el mismo recurso varias veces.
#### Endpoints de la API
* [POST media/upload](https://developer.x.com/content/developer-twitter/en/docs/media/upload-media/api-reference/post-media-upload#post-media-upload) o [POST media/upload (chunked)](https://developer.x.com/content/developer-twitter/en/docs/media/upload-media/api-reference/post-media-upload-init#post-media-upload-init) (subir contenido multimedia)
* [POST accounts/:account\_id/media\_library](https://developer.x.com/x-ads-api/creatives#get-accounts-account-id-media-library#post-accounts-account-id-media-library) (agregar contenido multimedia a la biblioteca multimedia)
#### Agregar a la biblioteca
Agregar contenido multimedia a la biblioteca consta de dos pasos. Primero, carga el recurso usando el endpoint [POST media/upload](https://developer.x.com/content/developer-twitter/en/docs/media/upload-media/api-reference/post-media-upload#post-media-upload) o el conjunto de endpoints [POST media/upload (chunked)](https://developer.x.com/content/developer-twitter/en/docs/media/upload-media/api-reference/post-media-upload-init#post-media-upload-init). (Consulta la guía de [Chunked media upload](https://developer.x.com/content/developer-twitter/en/docs/media/upload-media/uploading-media/chunked-media-upload) para obtener más detalles sobre nuestro proceso de carga multiparte.)
```
twurl -X POST -H upload.x.com "/1.1/media/upload.json?additional_owners=756201191646691328" --file latte.jpeg --file-field "media"
```
```json theme={null}
{
"media_id":966947208837742592,
"media_id_string":"966947208837742592",
"size":74194,
"expires_after_secs":86400,
"image":{
"image_type":"image/jpeg",
"w":800,
"h":418
}
}
```
A continuación, usando el id de medios, agrega el medio a la biblioteca de medios de la cuenta de anuncios mediante el endpoint [POST accounts/:account\_id/media\_library](https://developer.x.com/x-ads-api/creatives#get-accounts-account-id-media-library#post-accounts-account-id-media-library).
```
twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/media_library?file_name=latte.jpeg&media_category=TWEET_IMAGE&media_key=966947208837742592&name=Latte"
```
```json theme={null}
{
"request":{
"params":{
"name":"Latte",
"file_name":"latte.jpeg",
"media_category":"TWEET_IMAGE",
"account_id":"18ce54d4x5t",
"media_key":966947208837742592
}
},
"data":{
"tweeted":false,
"name":"Latte",
"file_name":"latte.jpeg",
"media_url":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
"media_category":"TWEET_IMAGE",
"media_key":"3_966947208837742592",
"created_at":"2018-02-23T08:05:54Z",
"media_status":"TRANSCODE_COMPLETED",
"media_key":"966947208837742592",
"media_type":"IMAGE",
"updated_at":"2018-02-23T08:06:17Z",
"deleted":false
}
}
```
**Nota:** Publicar un Tweet con imágenes, GIF o videos inmediatamente después de la carga también añade esos medios a la biblioteca de medios.
#### Parámetros de la solicitud
Todas las solicitudes POST de Media Library requieren un identificador de medios. Este valor se devuelve durante el proceso de carga. Cuando se usa el media\_id, como en el ejemplo anterior, también se debe especificar una media\_category. Hay cuatro posibles valores de categoría: AMPLIFY\_VIDEO, TWEET\_GIF, TWEET\_IMAGE y TWEET\_VIDEO.
Opcionalmente, se pueden establecer valores de name y file\_name para los objetos en Media Library. Estos atributos ayudan a los usuarios a distinguir entre variantes de medios en la biblioteca.
Para los videos, también es posible establecer un title y una description. Estos valores están pensados para enviarse como los parámetros de solicitud video\_title y video\_description con el endpoint [POST accounts/:account\_id/tweet](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/tweets#post-accounts-account-id-tweet). En el Tweet, este texto aparece debajo del video.
#### Atributos
Media Library presenta formalmente el concepto de media\_key. Este es el identificador único de los objetos en la biblioteca. Las media keys son valores de tipo string con el siguiente formato: 13\_875943225764098048. Estas son totalmente compatibles en todos nuestros endpoints de cards.
Además, la respuesta de Media Library incluye el media\_id, representado como un string. Esto se incluye para los recursos que actualmente no aceptan una media key: [Tweets](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/tweets#post-accounts-account-id-tweet)*, [Vista previa de Tweet](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/tweets#get-accounts-account-id-tweet-preview)* y [Tweets programados](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/scheduled-tweets#post-accounts-account-id-scheduled-tweets). Estamos trabajando para admitir media keys en todas partes.
El atributo aspect\_ratio se devuelve para GIFs y videos. Se puede usar para filtrar medios para su uso en cards que solo aceptan relaciones de aspecto específicas.
\*Estos endpoints admiten el parámetro video\_id, que es una media key.
#### Uso
En esta sección, la siguiente imagen se usará en un Tweet y para crear una tarjeta de sitio web.
```
twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/media_library/3_966947208837742592"
```
```json theme={null}
{
"request":{
"params":{
"account_id":"18ce54d4x5t",
"media_key":"3_966947208837742592"
}
},
"data":{
"tweeted":false,
"name":"Latte",
"file_name":"latte.jpeg",
"media_url":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
"media_category":"TWEET_IMAGE",
"media_key":"3_966947208837742592",
"created_at":"2018-02-23T08:05:54Z",
"media_status":"TRANSCODE_COMPLETED",
"media_key":"966947208837742592",
"media_type":"IMAGE",
"updated_at":"2018-02-23T08:06:17Z",
"deleted":false
}
}
```
**Tweet**
Podemos crear el Tweet haciendo referencia a las imágenes usando `media_keys`.
```
twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweet?text=coffee&media_keys=966947208837742592&as_user_id=756201191646691328&trim_user=true"
```
```json theme={null}
{
"data":{
"created_at":"Fri Feb 23 08:20:05 +0000 2018",
"id":966950781302665218,
"id_str":"966950781302665218",
"text":"coffee https://t.co/T772Hx5GNT",
"truncated":false,
"entities":{
"hashtags":[
],
"symbols":[
],
"user_mentions":[
],
"urls":[
],
"media":[
{
"id":966947208837742592,
"id_str":"966947208837742592",
"indices":[
7,
30
],
"media_url":"http://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
"media_url_https":"https://pbs.twimg.com/media/DWtJXQNUQAAdPZj.jpg",
"url":"https://t.co/T772Hx5GNT",
"display_url":"pic.x.com/T772Hx5GNT",
"expanded_url":"https://x.com/apimctestface/status/966950781302665218/photo/1",
"type":"photo",
"sizes":{
"thumb":{
"w":150,
"h":150,
"resize":"crop"
},
"large":{
"w":800,
"h":418,
"resize":"fit"
},
"medium":{
"w":800,
"h":418,
"resize":"fit"
},
"small":{
"w":680,
"h":355,
"resize":"fit"
}
}
}
]
},
"source":"Ads API Internal Test App",
"in_reply_to_status_id":null,
"in_reply_to_status_id_str":null,
"in_reply_to_user_id":null,
"in_reply_to_user_id_str":null,
"in_reply_to_screen_name":null,
"user":{
"id":756201191646691328,
"id_str":"756201191646691328"
},
"geo":null,
"coordinates":null,
"place":null,
"contributors":[
2417045708
],
"retweet_count":0,
"favorite_count":0,
"favorited":false,
"retweeted":false,
"possibly_sensitive":false,
"scopes":{
"followers":false
},
"lang":"en"
},
"request":{
"params":{
"as_user_id":756201191646691328,
"text":"coffee",
"account_id":"18ce54d4x5t",
"media_keys":[
966947208837742592
],
"trim_user":true
}
}
}
```
**Website Card**
Todos nuestros endpoints de cards admiten media keys. Crearemos la [website card](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/website#post-accounts-account-id-cards-website) utilizando el media\_key de la imagen.
```
twurl -X POST -H ads-api.x.com "/11/accounts/18ce54d4x5t/cards"
```
```json theme={null}
{
"name": "components create cards",
"components": [
{
"type": "MEDIA",
"media_key": "3_1323490622599176192"
},
{
"type": "BUTTON",
"label": {
"type": "ENUM",
"value": "INSTALL"
},
"destination": {
"type": "APP",
"country_code": "US",
"googleplay_app_id": "com.twitter.android"
}
}
]
}
```
A continuación asociamos esta Card a un Tweet mediante su card\_uri.
### Identificación de las Cards
#### Introducción
Las Cards son formatos de anuncio personalizables que usan contenido multimedia y que pueden asociarse con un sitio web, una App o con llamadas a la acción para impulsar determinadas interacciones de los usuarios, como iniciar un Mensaje Directo. Pueden adjuntarse a Tweets, Tweets programados o borradores de Tweets.
Las Cards pueden mencionarse en objetos Tweet de dos maneras: mediante el `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](https://cards.x.com/cards/18ce54d4x5t/68w3s) |
**Nota**: A partir de la versión 3 de la Ads API, solo se genera y devuelve `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
Para los Tweets creados con el valor URI de la card, busca la referencia a la card en el atributo de respuesta card\_uri. El siguiente ejemplo de respuesta usa el endpoint [GET accounts/:account\_id/tweets](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/tweets#get-accounts-account-id-tweets).
```
$ twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweets?trim_user=true&tweet_type=PUBLISHED&tweet_ids=1043551275923591168"
{
"request": {
"params": {
"tweet_ids": [
"1043551275923591168"
],
"tweet_type": "PUBLISHED",
"trim_user": true,
"account_id": "18ce54d4x5t"
}
},
"next_cursor": null,
"data": [
{
"coordinates": null,
"retweeted": false,
"source": "Ads API Internal Test App",
"entities": {
"hashtags": [],
"symbols": [],
"user_mentions": [],
"urls": []
},
"display_text_range": [
0,
15
],
"favorite_count": 0,
"in_reply_to_status_id_str": null,
"geo": null,
"id_str": "1043551275923591168",
"scopes": {
"followers": false
},
"in_reply_to_user_id": null,
"truncated": false,
"retweet_count": 0,
"scheduled_status": null,
"id": 1043551275923591168,
"in_reply_to_status_id": null,
"nullcast": true,
"created_at": "Sat Sep 22 17:23:07 +0000 2018",
"place": null,
"scheduled_at": null,
"tweet_type": "PUBLISHED",
"favorited": false,
"card_uri": "card://1043282691834048513",
"full_text": "Tracking a card",
"lang": "en",
"contributors": [
2417045708
],
"in_reply_to_screen_name": null,
"in_reply_to_user_id_str": null,
"user": {
"id": 756201191646691328,
"id_str": "756201191646691328"
},
"tweet_id": "1043551275923591168"
}
]
}
```
Si utilizas la Standard API, usa include\_card\_uri=true en la solicitud.
Independientemente de qué endpoint se use, el atributo de respuesta card\_uri solo se devolverá si el Tweet se creó usando un URI de tarjeta.
Para los objetos de Tweet programados y borradores, la respuesta siempre incluirá el atributo de respuesta card\_uri.
#### Identificar Tweets con preview\_url
Para los Tweets que incluyen la URL de vista previa como parte del texto del Tweet, la URL se puede encontrar en entities\["urls"]\[i]\["expanded\_url"] (el campo de texto incluye una URL acortada de t.co), donde i es un índice de array (un Tweet puede contener varias URLs).
Para los objetos de Tweet programados o en borrador, la URL de vista previa siempre aparecerá en el campo de texto.
#### Obtención de cards
Para obtener información adicional sobre una card específica, proporcionamos dos endpoints: [GET accounts/:account\_id/cards/all](https://developer.x.com/en/docs/ads/creatives/api-reference/cards-fetch.html#get-accounts-account-id-cards-all) y [GET accounts/:account\_id/cards/all/:card\_id](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/cards-fetch#get-accounts-account-id-cards-all-card-id). El primero permite obtener una card mediante card\_uri y el segundo mediante el ID de la card. El ID de la card se encuentra al final de preview\_url. En el ejemplo anterior, el ID es 68w3s.
### Identificar contenido multimedia
#### Introducción
Los recursos multimedia (imágenes, GIF y videos) se pueden agregar a los Tweets y a las cards. Además, los videos se pueden usar como recursos de pre-roll y las imágenes se pueden promocionar en la [X Audience Platform](https://developer.x.com/en/docs/ads/measurement/overview/twitter-audience-platform). Esta sección describe cómo encontrar referencias a contenido multimedia en estas entidades.
Hay dos tipos de identificadores de contenido multimedia: media ID y media key. A continuación se presentan valores de ejemplo para cada uno.
| **Media ID** | **Media key** |
| :------------------ | :---------------------- |
| 1029825579531807971 | 13\_1029825579531807971 |
La media key es el media ID con un prefijo numérico y un guion bajo.
#### Imágenes
La siguiente tabla muestra los tipos de identificadores disponibles actualmente en la respuesta de cada recurso relacionado con imágenes, así como los nombres de los atributos correspondientes.
| **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` |
Las Image cards y las imágenes de Account Media no incluyen ninguna referencia a ningún identificador de medios. Los Tweets solo incluyen media IDs. Los Scheduled y Draft Tweets incluyen tanto el media ID como la media key. La Media Library también devuelve ambos.
En el caso de los Tweets, los campos id e id\_str en el objeto dentro del array entities\["media"] corresponden al media ID. En los casos en que un Tweet incluya varias imágenes, las referencias a cada media entity solo pueden encontrarse en extended\_entities\["media"].
Además de las referencias a identificadores, a menudo es importante tener acceso a la URL de la imagen.
| **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.
Todas las Image cards incluyen un atributo de respuesta de imagen que contiene la URL de la imagen de X. (En el caso de las image app download cards, el nombre es wide\_app\_image).
Para los Tweets, la ubicación de la media URL depende tanto del tipo de medio como del endpoint que se esté utilizando. Para Tweets con una sola imagen, la URL se puede encontrar en entities\["media"]\[0]\["media\_url"]. Esto es válido tanto para la Ads API como para la Standard API. Sin embargo, cuando los Tweets contienen varias imágenes, las URLs solo se pueden encontrar en extended\_entities\["media"]\[i]\["media\_url"]. Esto solo está disponible en la Standard API.
#### Videos
La siguiente tabla muestra los tipos de identificadores disponibles actualmente en la respuesta de cada recurso relacionado con video, así como el/los nombre(s) de atributo correspondiente(s).
| **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` |
Aunque las video cards (con la excepción de las poll cards con video) incluyen un atributo de respuesta `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 |
Las video cards incluyen los atributos de respuesta `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](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/guides/media-library). 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 a `media 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](https://developer.x.com/content/developer-twitter/en/docs/ads/creatives/api-reference/account-media#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_id` es 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.
**Interacciones con Account Media**
Hay dos casos en los que los recursos multimedia añadidos a la biblioteca se añaden automáticamente al recurso Account Media.
* 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](https://developer.x.com/content/developer-twitter/en/docs/ads/general/overview/enums)), 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
La API de X Ads admite tres tipos de Tweets: publicados, programados y borradores.
#### Tweets nullcast
Los Tweets pueden ser nullcast (también denominados "solo promocionados") u orgánicos. Los Tweets nullcast, una vez publicados, no aparecen en la cronología pública del usuario, aunque son públicos. Los Tweets orgánicos, en cambio, se muestran a los seguidores del usuario y sí aparecen en la cronología pública del usuario.
**Creación de Tweets**
Cada uno de los tres endpoints de creación de Tweets admite un parámetro booleano nullcast que le da al usuario de la API la opción de crear Tweets nullcast u orgánicos. Los Tweets nullcast pueden crearlos el propio usuario o cualquier persona que tenga permiso para crear Tweets en nombre del usuario. Los Tweets orgánicos solo pueden ser creados por el [usuario totalmente promocionable](https://developer.x.com/content/developer-twitter/en/docs/tutorials/ads-api-hierarchy-terminology#promotable-users).
**Actualización de Tweets**
Es posible actualizar la propiedad nullcast para Tweets programados y borradores. En el caso de los Tweets programados, se pueden hacer ediciones hasta la hora scheduled\_at del Tweet. Los borradores de Tweets se pueden editar indefinidamente. Sin embargo, una vez publicados, no es posible cambiar un Tweet de nullcast a orgánico o viceversa.
#### Promocionar Tweets
Solo los Tweets publicados y programados pueden promocionarse. Estos pueden ser nullcast u orgánicos; no hay ninguna restricción. Un anunciante puede promocionar sus propios Tweets o los Tweets de otro usuario siempre que haya obtenido permiso para hacerlo. (Consulta [Promoting another user's Tweets](https://developer.x.com/content/developer-twitter/en/docs/tutorials/promoting-another-users-content) para obtener más información).
Es posible promocionar varios Tweets en una sola campaña. Del mismo modo, un único Tweet puede promocionarse en una o más campañas.
Para promocionar Tweets publicados, usa el endpoint [POST accounts/:account\_id/promoted\_tweets](https://developer.x.com/content/developer-twitter/en/docs/ads/campaign-management/api-reference/promoted-tweets#post-accounts-account-id-promoted-tweets). Esto asocia los Tweets publicados con una línea de pedido. Para promocionar Tweets programados, usa el endpoint [POST accounts/:account\_id/scheduled\_promoted\_tweets](https://developer.x.com/content/developer-twitter/en/docs/ads/campaign-management/api-reference/scheduled-promoted-tweets#post-accounts-account-id-scheduled-promoted-tweets).
#### IDs de Tweet
Los IDs de Tweets publicados, programados y borradores son [numéricos](https://developer.x.com/content/developer-twitter/en/docs/basics/twitter-ids): son números enteros sin signo de 64 bits. Por ejemplo, el ID del siguiente Tweet publicado es 1166476031668015104.
Cuando se promocionan Tweets publicados o programados, se crea una entidad de Tweet promocionado correspondiente. Estas entidades tienen sus propios IDs, que son alfanuméricos y se representan como valores codificados en base 36. Por ejemplo, promocionar el Tweet publicado anterior —es decir, asociarlo a un elemento de línea 6c62d— devuelve la siguiente respuesta de la API.
```
$ twurl -X POST -H ads-api.x.com "/9/accounts/18ce54d4x5t/promoted_tweets?line_item_id=6c62d&tweet_ids=1166476031668015104"
{
"request": {
"params": {
"tweet_ids": [
1166476031668015104
],
"line_item_id": "6c62d",
"account_id": "18ce54d4x5t"
}
},
"data": [
{
"line_item_id": "6c62d",
"id": "3qwlq6",
"entity_status": "ACTIVE",
"created_at": "2019-09-12T21:39:10Z",
"updated_at": "2019-09-12T21:39:10Z",
"approval_status": "ACCEPTED",
"tweet_id": "1166476031668015104",
"deleted": false
}
],
"total_count": 1
}
```
Además del ID de Tweet y del ID del elemento de línea, que se pasaron en la solicitud de creación, la respuesta incluye un campo id con el valor 3qw1q6, que es el ID del Tweet promocionado.
### Carruseles
#### Introducción
La X Ads API permite crear y obtener carruseles de video e imagen. Un carrusel es un tipo de card que puede contener entre 2 y 6 elementos multimedia. La carousel card puede dirigir al usuario a un sitio web o animarlo a instalar una App móvil. Para obtener más información sobre carruseles, sus beneficios, buenas prácticas y preguntas frecuentes, consulta nuestra página [Carousel Ads on X](https://business.x.com/en/advertising/carousels.html).
Un carrusel, como cualquier otro tipo de card, se puede usar en Tweets y esos Tweets luego se pueden promocionar. El flujo de trabajo es el mismo al que ya estás acostumbrado:
1. Cargar los recursos multimedia
2. Crear la card
3. Crear el Tweet
4. Promocionar el Tweet
La única diferencia está en cómo se crea la card. Mientras que otras solicitudes de creación de cards aceptan parámetros de consulta, las solicitudes de creación de carousel card solo aceptan cuerpos JSON en solicitudes POST.
#### Endpoints
La API de Ads admite la creación y obtención de carruseles.
Para crear un carrusel —de cualquier tipo—, usa el endpoint [POST accounts/:account\_id/cards](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/cards#post-accounts-account-id-cards). Para obtener carruseles, usa el endpoint [GET accounts/:account\_id/cards](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/cards#get-accounts-account-id-cards).
#### Cuerpo JSON POST
Los carruseles se crean utilizando dos componentes. El primero especifica los recursos multimedia que se usarán. El segundo especifica información sobre el sitio web o la App.
En concreto, una tarjeta de carrusel se crea usando los siguientes componentes, en este orden:
* Un componente `SWIPEABLE_MEDIA`, que acepta un array de media keys
* *Uno* de los siguientes:
* Un componente `DETAILS` para especificar la información del sitio web
* Un componente `BUTTON` para especificar la información de la App
El componente `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.
```
{
"type": "SWIPEABLE_MEDIA",
"media_keys": [
"13_1089771253848666112",
"13_1191948012077092867"
]
}
```
Como recordatorio, puedes obtener claves de contenido multimedia realizando una solicitud al endpoint [GET accounts/:account\_id/media\_library](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/media-library#get-accounts-account-id-media-library).
La composición del segundo objeto de componente depende de si deseas dirigir a un usuario a un sitio web o animarlo a instalar una app. La siguiente tabla resume las dos opciones. (**Nota**: todas las claves indicadas son obligatorias).
| | **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", ... }` |
Con todo esto, a continuación se muestra un ejemplo del cuerpo de una solicitud POST JSON para un carrusel de sitio web.
```
{
"name": "website carousel",
"components": [
{
"type": "SWIPEABLE_MEDIA",
"media_keys": [
"13_1089771253848666112",
"13_1191948012077092867"
]
},
{
"type": "DETAILS",
"title": "X",
"destination": {
"type": "WEBSITE",
"url": "https://www.x.com"
}
}
]
}
```
Los objetos de destino de App dentro de componentes `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](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/cards#app-destination).
Con todo esto, a continuación se muestra un ejemplo del cuerpo JSON de una solicitud POST de un carrusel de App.
```
{
"name": "carrusel de aplicaciones",
"components": [
{
"type": "SWIPEABLE_MEDIA",
"media_keys": [
"13_1089771253848666112",
"13_1191948012077092867"
]
},
{
"type": "BUTTON",
"label": {
"type": "ENUM",
"value": "INSTALL"
},
"destination": {
"type": "APP",
"country_code": "US",
"googleplay_app_id": "com.twitter.android",
"iphone_app_id": "333903271"
}
}
]
}
```
#### Ejemplo
Esta sección muestra cómo crear una card de carrusel de video para sitios web y cómo usarla en un Tweet. Como se mencionó anteriormente, el flujo de trabajo es el mismo que ya conoces: subir contenido multimedia, crear la card y crear el Tweet. La única diferencia es cómo se crea la card.
**Contenido multimedia**
Para comenzar, sube nuevos recursos multimedia o utiliza los ya existentes. Para obtener más detalles sobre cómo subir nuevos recursos multimedia y agregarlos a la Media Library, consulta nuestra [Guía de Media Library](https://developer.x.com/en/docs/twitter-ads-api/creatives/guides/media-library).
Una vez que tus recursos multimedia estén en la Media Library, recupéralos usando el endpoint [GET accounts/:account\_id/media\_library](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/media-library#get-accounts-account-id-media-library). Usa el parámetro de solicitud `media_type` para limitar los resultados a un tipo de contenido multimedia en particular.
```
$ twurl -H ads-api.x.com "/10/accounts/18ce54d4x5t/media_library?media_type=VIDEO"
```
```
{
"request": {
"params": {
"account_id": "18ce54d4x5t",
"media_type": "VIDEO"
}
},
"next_cursor": null,
"data": [
{
"tweeted": true,
"duration": 5283,
"name": "Sunrise",
"file_name": "sunrise.mp4",
"description": null,
"media_url": "https://video.twimg.com/amplify_video/1089771253848666112/vid/1280x720/tyL-pUBP7GgkS9bl.mp4?tag=9",
"poster_media_key": "3_1089771253848666112",
"media_key": "13_1089771253848666112",
"created_at": "2019-01-28T06:24:48Z",
"media_status": "TRANSCODE_COMPLETED",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/1089771253848666112/img/WOYvToSRZFXUSDzd.jpg",
"title": null,
"media_type": "VIDEO",
"aspect_ratio": "16:9",
"updated_at": "2019-08-23T19:05:33Z",
"deleted": false
},
{
"tweeted": true,
"duration": 15248,
"name": "snow",
"file_name": "snow.mp4",
"description": "Two, three, and to the four",
"media_url": "https://video.twimg.com/amplify_video/1191948012077092867/vid/1280x720/2cOvadcctqqea6Hx.mp4?tag=13",
"poster_media_key": "3_1191948012077092867",
"media_key": "13_1191948012077092867",
"created_at": "2019-11-06T05:18:46Z",
"media_status": "TRANSCODE_COMPLETED",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/1191948012077092867/img/IUbhTRd62SEeIVTf.jpg",
"title": "One",
"media_type": "VIDEO",
"aspect_ratio": "16:9",
"updated_at": "2020-03-27T22:23:18Z",
"deleted": false
}
]
}
```
**Creación de carrusel**
Utiliza el endpoint [POST accounts/:account\_id/cards](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/cards#post-accounts-account-id-cards) para crear tu carrusel. Utiliza las media keys de la solicitud anterior. Recuerda que el orden en que se pasan las media keys determina el orden en que se muestran.
```
$ twurl -A "Content-Type: application/json" -X POST -H ads-api.x.com "/10/accounts/18ce54d4x5t/cards" -d '{"name":"website carousel","components":[{"type": "SWIPEABLE_MEDIA","media_keys":["13_1089771253848666112","13_1191948012077092867"]},{"type": "DETAILS","title": "X","destination":{"type":"WEBSITE", "url":"https://www.x.com"}}]}'
```
```
{
"request": {
"params": {
"account_id": "18ce54d4x5t"
}
},
"data": {
"name": "website carousel",
"components": [
{
"type": "SWIPEABLE_MEDIA",
"media_keys": [
"13_1089771253848666112",
"13_1191948012077092867"
]
},
{
"type": "DETAILS",
"title": "X",
"destination": {
"type": "WEBSITE",
"url": "https://www.x.com/",
"tco_url": "https://t.co/dyTMHWKWZb"
}
}
],
"id": "ars7m",
"created_at": "2020-11-11T07:51:47Z",
"card_uri": "card://1326432421105995776",
"updated_at": "2020-11-11T07:51:47Z",
"deleted": false,
"card_type": "UNIFIED"
}
}
```
Ten en cuenta que, como con otras cards, la respuesta de la card de carrusel incluye un `card_uri`, que se usará para crear un Tweet.
**Tweet**
Utiliza el endpoint [POST accounts/:account\_id/tweet](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/tweets#post-accounts-account-id-tweet) para crear tu Tweet. Utiliza el `card_uri` de la solicitud anterior. (Respuesta truncada para mayor legibilidad.)
```
$ twurl -H ads-api.x.com "/9/accounts/18ce54d4x5t/tweet_previews?tweet_type=PUBLISHED&tweet_ids=1326434098324385792"
```
```
{
"data": {
"created_at": "Wed Nov 11 07:58:27 +0000 2020",
"id": 1326434098324385792,
"id_str": "1326434098324385792",
"text": "Swipe",
"truncated": false,
"entities": {
"hashtags": [],
"symbols": [],
"user_mentions": [],
"urls": []
},
"source": "Ads API Internal Test App",
"in_reply_to_status_id": null,
"in_reply_to_status_id_str": null,
"in_reply_to_user_id": null,
"in_reply_to_user_id_str": null,
"in_reply_to_screen_name": null,
"user": {
"id": 756201191646691300,
"id_str": "756201191646691328",
...
},
"geo": null,
"coordinates": null,
"place": null,
"contributors": [
2417045708
],
"retweet_count": 0,
"favorite_count": 0,
"favorited": false,
"retweeted": false,
"possibly_sensitive": false,
"scopes": {
"followers": false
},
"lang": "en"
},
"request": {
"params": {
"text": "Swipe",
"as_user_id": 756201191646691300,
"card_uri": "card://1326432421105995776",
"account_id": "18ce54d4x5t"
}
}
}
```
**Vistas previas de Tweets**
Usa el endpoint [GET accounts/:account\_id/tweet\_previews](https://developer.x.com/en/docs/twitter-ads-api/creatives/api-reference/tweet-previews#get-accounts-account-id-tweet-previews) para obtener una vista previa de tu Tweet.
### etiquetado-de-metadatos-de-creatividades
#### Introducción
Esta guía está dirigida a socios creativos, agencias y desarrolladores creativos para etiquetar recursos utilizados en campañas de X y así comprender mejor el valor y el rendimiento de cada recurso.
**Nota:** Los recursos multimedia solo deben ser etiquetados por el socio o desarrollador que crea el recurso multimedia. Si el usuario de un recurso multimedia no lo creó, no implemente el etiquetado de metadatos.
Creative Metadata Tagging permite atribuir imágenes y videos creados por socios creativos, independientemente de dónde se cargue el recurso en X o de quién lo cargue. Para crear la conexión entre el recurso creativo y el socio creativo, se utiliza el estándar [XMP](https://exiftool.org/TagNames/XMP.html).
#### Etiquetado de recursos creativos
La siguiente tabla muestra los tipos de identificadores disponibles actualmente en la respuesta de cada recurso relacionado con imágenes, así como el/los nombre(s) de atributo correspondientes. Se necesita una herramienta de etiquetado para etiquetar los recursos creativos. Se recomienda [ExifTool](https://exiftool.org/), una biblioteca de Perl independiente de la plataforma junto con una [aplicación de línea de comandos](https://exiftool.org/exiftool_pod.html) para leer, escribir y editar metadatos. Consulta todos los [tipos de archivos](https://exiftool.org/#supported) compatibles.
Sigue las [instrucciones para instalar ExifTool](https://exiftool.org/install.html) proporcionadas. También hay paquetes de software ofrecidos por [Homebrew](https://formulae.brew.sh/) para simplificar aún más la instalación, proporcionando el [comando de instalación de exiftool](https://formulae.brew.sh/formula/exiftool) para macOS y Linux. Confirma que tu herramienta esté correctamente instalada ejecutando exiftool -ver en la línea de comandos para obtener el número de versión de la herramienta. Obtén más información sobre los parámetros de línea de comandos de ExifTool en la [documentación de ExifTool](https://exiftool.org/).
Los socios creativos pueden asignar etiquetas de metadatos a recursos creativos nuevos o existentes con su app\_id de X a la etiqueta XMP contributor y a la etiqueta date. Los recursos creativos seguirán las restricciones de tamaño existentes al [subir contenido multimedia](https://developer.x.com/en/docs/twitter-api/v1/media/upload-media/overview).
**Nota:** El uso que hace X de la etiqueta XMP contributor garantiza que los metadatos capturen valores exclusivamente para campañas en X.
`exiftool -contributor="" -creative_file.jpg`
`exiftool -date="" -creative_file.jpg`
La app\_id se puede encontrar en la [Consola de desarrollador](https://developer.x.com/en/portal/dashboard) en Projects & Apps. Ejemplo: 16489123
El siguiente ejemplo agrega app\_id como la etiqueta contributor y date como la etiqueta date para una imagen:
```
app_id:858382169
```
```
date:2022-03-13
```
```
creative_file: eiffel_tower.jpg
```
```
exiftool -contributor=858382169 eiffel_tower.jpg
```
```
1 archivo de imagen actualizado
```
```
exiftool -date=2022-03-13 eiffel_tower.jpg
```
```
1 archivo de imagen actualizado
```
Comprueba que la imagen esté etiquetada correctamente:
`exiftool -xmp:all -G1 `
Ejemplo:
`exiftool -xmp:all -G1 eiffel_tower.jpg`
```
[XMP] XMP Toolkit : Image::ExifTool 12.30
```
```
[XMP] Contributor : 858382169
```
```
[XMP] Date : 2022:03:13
```
#### ¿Preguntas?
Si deseas confirmar que tu etiquetado y atribución se han realizado correctamente, envía activos de muestra que hayan sido etiquetados a [adsapi-program@x.com](mailto:adsapi-program@x.com) para que un representante de X pueda revisarlos.
## Referencia de la API
### Contenido multimedia de la cuenta
#### GET accounts/:account\_id/account\_media
Obtén detalles de algunos o de todos los medios de cuenta asociados a la cuenta actual.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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](https://developer.x.com/x-ads-api/fundamentals/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 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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
```
{
"request": {
"params": {
"account_media_id": "2pnfd",
"account_id": "18ce54d4x5t"
}
},
"data": {
"video_id": null,
"media_url": "https://pbs.twimg.com/ad_img/890749735862026242/Up07zMym?format=jpg&name=orig",
"creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
"id": "2pnfd",
"created_at": "2017-07-28T01:44:41Z",
"updated_at": "2017-07-28T01:44:41Z",
"deleted": false
}
}
```
Elimina el objeto de medios de cuenta especificado que pertenece a la cuenta actual.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
**Nota**: Para asociar una tarjeta con un Tweet, utiliza el parámetro `card_uri` con cualquiera de los endpoints [POST accounts/:account\_id/tweet](https://developer.x.com/en/docs/ads/creatives/api-reference/tweets#post-accounts-account-id-tweet), [POST statuses/update](https://developer.x.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update#post-statuses-update), [POST accounts/:account\_id/scheduled\_tweets](https://developer.x.com/en/docs/ads/creatives/api-reference/scheduled-tweets#post-accounts-account-id-scheduled-tweets) o [POST accounts/:account\_id/draft\_tweets](https://developer.x.com/en/docs/ads/creatives/api-reference/draft-tweets#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.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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](https://devcommunity.x.com/t/new-cards-endpoints-and-carousel-ads/145782/6) 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](https://developer.x.com/x-ads-api/fundamentals/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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Crea una nueva tarjeta asociada a la cuenta especificada.
Las solicitudes de creación de tarjetas solo aceptan cuerpos POST en formato JSON. El `Content-Type` debe establecerse en `application/json`.
Consulta nuestra [Guía de carruseles](https://developer.x.com/en/docs/twitter-ads-api/creatives/guides/carousels) para ver un ejemplo de uso detallado.
El cuerpo JSON de la solicitud POST debe incluir un campo `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": "some name",
"components": [
{
"type": "TYPE_ENUM",
"key": "value"
}
]
}
```
Información adicional sobre los componentes a continuación.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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
Cada componente debe incluir un campo `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 imagen
* `SWIPEABLE_MEDIA`: entre 2 y 6 videos o imágenes
* Descripción:
* `DETAILS`
* `BUTTON`
Cada componente tiene un conjunto de campos obligatorios (además de la clave `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 |
A continuación se muestra un ejemplo de un componente `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.)
```
{
"components": [
{
"type": "BUTTON",
"label": {
...
},
"destination": {
...
}
}
]
}
```
El orden en el que se especifican los objetos de componente define el orden de arriba a abajo en el que se renderizarán. Las Cards deben crearse usando un componente basado en contenido multimedia y un componente `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`.
```
{
"components": [
{
"type": "BUTTON",
"label": {
"type": "ENUM",
"value": "INSTALL"
},
"destination": {
...
}
}
]
}
```
**Destino**
Los destinos son a dónde los anunciantes quieren llevar a los usuarios. Siempre son obligatorios dentro de los componentes `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` |
**Destino de App**
| 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](https://en.wikipedia.org/wiki/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 |
El cuerpo JSON de la solicitud POST debe incluir los parámetros que se van a actualizar. La solicitud **reemplazará** cada campo con los parámetros especificados en el payload. Los componentes se representan como objetos y describen los atributos orientados al anunciante de la card.
El siguiente ejemplo muestra la estructura general del payload (pero incluye datos no funcionales).
```
{
"name": "some name",
"components": [
{
"type": "TYPE_ENUM",
"key": "value"
}
]
}
```
Información adicional sobre los componentes y diapositivas en **POST accounts/:account\_id/cards**.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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
Este ejemplo actualiza el nombre y elimina una de las media\_keys del campo components del ejemplo anterior.
`PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264`
```
{
"name": "changed name",
"components": [
{
"type": "SWIPEABLE_MEDIA",
"media_keys": [
"3_1075096386931052545"
]
},
{
"type": "BUTTON",
"label": {
"type": "ENUM",
"value": "OPEN"
},
"destination": {
"type": "APP",
"country_code": "US",
"googleplay_app_id": "com.twitter.android",
"googleplay_deep_link": "twitter://user?screen_name=apimctestface"
}
}
]
}
```
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Recuperar detalles de algunos o todos los borradores de Tweets asociados a la cuenta actual.
#### 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Crea un borrador de Tweet para el usuario completamente promocionable de la cuenta (valor predeterminado) o para el usuario especificado en el parámetro `as_user_id`.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://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](https://developer.x.com/en/docs/ads/creatives/api-reference/media-library#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
```
{
"request": {
"params": {
"text": "Just setting up my X.",
"as_user_id": "756201191646691328"
}
},
"data": {
"name": null,
"text": "Just setting up my X.",
"user_id": "756201191646691328",
"id": "994747471329873920",
"nullcast": true,
"created_at": "2018-05-11T01:14:13Z",
"card_uri": null,
"updated_at": "2018-05-11T01:14:13Z",
"media_keys": []
}
}
```
Actualiza el borrador de Tweet especificado que pertenece a la cuenta actual.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/en/docs/ads/creatives/api-reference/media-library#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
```
{
"request": {
"params": {
"draft_tweet_id": 994747471329873920,
"text": "just setting up my twttr"
}
},
"data": {
"name": null,
"text": "just setting up my twttr",
"user_id": "756201191646691328",
"id": "994747471329873920",
"nullcast": true,
"created_at": "2018-05-11T01:14:13Z",
"card_uri": null,
"updated_at": "2018-05-11T01:16:59Z",
"media_keys": []
}
}
```
Eliminar permanentemente el borrador de Tweet especificado que pertenece a la cuenta actual.
**Nota**: Recomendamos **encarecidamente** eliminar los borradores una vez que se haya creado un Tweet o un Tweet programado utilizando sus metadatos.
**Nota**: Esta es una eliminación permanente. Como resultado, no es posible recuperar borradores de Tweet eliminados.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
#### POST accounts/:account\_id/draft\_tweets/preview/:draft\_tweet\_id
Obtén una vista previa de un borrador de Tweet en un dispositivo móvil.
Una solicitud exitosa envía una notificación a cada dispositivo en el que el usuario autenticado haya iniciado sesión. Al hacer clic en la notificación, se abre una timeline que permite al usuario ver e interactuar con el borrador de Tweet, para probar la reproducción automática, el volumen, la pantalla completa, el acoplamiento de la tarjeta de sitio web de video y otros comportamientos.
**Nota**: Las vistas previas en el dispositivo solo son visibles para el usuario que recibe la notificación.
**Nota**: Las notificaciones solo se envían a las apps oficiales de X.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
```
{
"request": {
"params": {
"account_id": "18ce54d4x5t",
"draft_tweet_id": "996132315829948416"
}
},
"message": "See @apimctestface's notifications in the X app to preview your Tweet."
}
```
### Tarjetas de conversación con imagen
**Nota**: Para asociar una tarjeta con un Tweet, usa el parámetro `card_uri` con cualquiera de los siguientes endpoints: [POST accounts/:account\_id/tweet](https://developer.x.com/en/docs/ads/creatives/api-reference/tweets#post-accounts-account-id-tweet), [POST statuses/update](https://developer.x.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update#post-statuses-update) o [POST accounts/:account\_id/scheduled\_tweets](https://developer.x.com/en/docs/ads/creatives/api-reference/scheduled-tweets#post-accounts-account-id-scheduled-tweets).
#### GET accounts/:account\_id/cards/image\_conversation
Obtiene los detalles de algunas o todas las tarjetas de conversación con imagen asociadas a la cuenta actual.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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](https://developer.x.com/x-ads-api/fundamentals/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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
#### POST accounts/:account\_id/cards/image\_conversation
Crea una nueva tarjeta de conversación con imagen relacionada con la cuenta especificada.
Consulta [Uploading Media](https://developer.x.com/rest/public/uploading-media) para obtener información útil sobre la carga de imágenes en nuestros endpoints.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/en/docs/ads/creatives/api-reference/media-library#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/en/docs/ads/creatives/api-reference/media-library#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` |
```
{
"data": {
"name": "moon card",
"id": "59woh",
"created_at": "2018-01-27T04:58:42Z",
"card_uri": "card://923498485702009837",
"updated_at": "2018-01-29T21:04:39Z",
"deleted": false,
"card_type": "IMAGE_CONVERSATION"
},
"request": {
"params": {
"account_id": "18ce54d4x5t",
"card_type": "IMAGE_CONVERSATION",
"card_id": "59woh",
"name": "moon card"
}
}
}
```
Elimina de forma permanente la tarjeta de conversación con imagen especificada que pertenece a la cuenta actual.
**Nota**: Se trata de un borrado definitivo, por lo que no es posible recuperar las tarjetas eliminadas.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
```
{
"request": {
"params": {
"account_id": "18ce54d4x5t",
"media_key": "13_909110614026444802"
}
},
"data": {
"tweeted": true,
"duration": 39973,
"name": null,
"file_name": "buildings https://t.co/xFdzrHM5QG",
"description": null,
"media_url": "https://video.twimg.com/amplify_video/909110614026444802/vid/1280x720/mfahmfkKVjjk1nGm.mp4",
"media_category": "AMPLIFY_VIDEO",
"poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/909110614026444802/img/QZUNoaiCia0UFNrw.jpg",
"poster_media_key": "3_909110614026444802",
"media_key": "13_909110614026444802",
"created_at": "2017-09-16T17:43:55Z",
"media_status": "TRANSCODE_COMPLETED",
"title": "buildings",
"media_type": "VIDEO",
"aspect_ratio": "16:9",
"updated_at": "2017-09-27T13:04:00Z",
"deleted": false
}
}
```
Asocia un objeto multimedia con la cuenta actual. Para obtener más detalles, consulta nuestra [guía de Media Library](https://developer.x.com/en/docs/ads/creatives/guides/media-library).
**Nota**: Cuando agregas un vídeo con la categoría de multimedia `AMPLIFY_VIDEO` a la Media Library, este pasa a estar disponible automáticamente como un recurso [account\_media](https://developer.x.com/en/docs/ads/creatives/api-reference/account-media#get-accounts-account-id-account-media) de tipo `PREROLL`.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/en/docs/ads/creatives/api-reference/tweets#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](https://developer.x.com/en/docs/ads/creatives/api-reference/tweets#post-accounts-account-id-tweet). **Nota**: Solo se puede usar con videos. Type: string Example: `Video title` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/en/docs/ads/creatives/api-reference/tweets#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](https://developer.x.com/en/docs/ads/creatives/api-reference/tweets#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
```
{
"request": {
"params": {
"account_id": "18ce54d4x5t",
"media_key": "16_844800354743074820",
"title": "cat GIF",
"description": "in space"
}
},
"data": {
"tweeted": true,
"duration": null,
"name": null,
"file_name": null,
"description": "in space",
"media_url": "https://video.twimg.com/tweet_video/C7lVclqVwAQqTCZ.mp4",
"media_category": "TWEET_GIF",
"poster_media_url": "https://pbs.twimg.com/tweet_video_thumb/C7lVclqVwAQqTCZ.jpg",
"poster_media_key": "3_844800354743074820",
"media_key": "16_844800354743074820",
"created_at": "2017-10-20T09:51:54Z",
"media_status": "TRANSCODE_COMPLETED",
"title": "cat GIF",
"media_type": "GIF",
"aspect_ratio": "125:79",
"updated_at": "2017-10-23T06:37:56Z",
"deleted": false
}
}
```
Elimina el objeto especificado de la biblioteca multimedia de la cuenta actual.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Obtén los detalles de algunas o todas las tarjetas de encuesta asociadas a la cuenta actual.
#### URL del recurso
`https://ads-api.x.com/12/accounts/:account_id/cards/poll`
#### 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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](https://developer.x.com/x-ads-api/fundamentals/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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Crea una nueva tarjeta de encuesta asociada a la cuenta especificada. Este endpoint admite crear tarjetas de encuesta con una imagen, un video o sin contenido multimedia. Las encuestas con contenido multimedia se conocen como Media Forward Polls.
**Nota**: El producto Media Forward Polls está en beta y requiere la función de cuenta `PROMOTED_MEDIA_POLLS`.
**Nota**: No es posible actualizar (PUT) las tarjetas de encuesta.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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](https://developer.x.com/x-ads-api/fundamentals/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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/x-ads-api/introduction) 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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Crea un Tweet programado para el usuario promocionable completo de la cuenta (valor predeterminado) o para el usuario especificado en el parámetro `as_user_id`.
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://en.wikipedia.org/wiki/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](https://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](https://developer.x.com/en/docs/ads/creatives/api-reference/media-library#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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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](https://developer.x.com/en/docs/ads/creatives/api-reference/media-library#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](https://en.wikipedia.org/wiki/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` |
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |
Vista previa de Tweets publicados, programados o en borrador.
* 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
| 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](https://developer.x.com/en/docs/ads/campaign-management/api-reference/accounts#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` |