Creativos

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, 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. 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. 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 y en las siguientes tarjetas:

Primero, carga el video usando el endpoint POST media/upload (chunked). 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 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. Crea la card usando uno de los siguientes endpoints:

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. 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 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). 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:

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
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. 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:

{
  "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 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

{
  "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. 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'

{
  "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, lo que elimina la necesidad de subir el mismo recurso varias veces.

Endpoints de la API

POST media/upload o POST media/upload (chunked) (subir contenido multimedia)
POST accounts/:account_id/media_library (agregar contenido multimedia a la biblioteca multimedia)

Agregar a la biblioteca

Agregar contenido multimedia a la biblioteca consta de dos pasos. Primero, carga el recurso usando el endpoint POST media/upload o el conjunto de endpoints POST media/upload (chunked). (Consulta la guía de 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"

{
   "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.

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"

{
   "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. 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, Vista previa de Tweet y Tweets programados. 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"

{
   "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"

{
   "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 utilizando el media_key de la imagen.

twurl -X POST -H ads-api.x.com "/11/accounts/18ce54d4x5t/cards"

{
  "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

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.

$ 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 y 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. 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. 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. 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), 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. 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 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. 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.

IDs de Tweet

Los IDs de Tweets publicados, programados y borradores son numéricos: 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. 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:

Cargar los recursos multimedia
Crear la card
Crear el Tweet
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. Para obtener carruseles, usa el endpoint 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. 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. 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. Una vez que tus recursos multimedia estén en la Media Library, recupéralos usando el endpoint 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 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 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 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.

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, una biblioteca de Perl independiente de la plataforma junto con una aplicación de línea de comandos para leer, escribir y editar metadatos. Consulta todos los tipos de archivos compatibles. Sigue las instrucciones para instalar ExifTool proporcionadas. También hay paquetes de software ofrecidos por Homebrew para simplificar aún más la instalación, proporcionando el comando de instalación de 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. 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. 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="<YOUR APP ID>" -creative_file.jpg exiftool -date="<date>" -creative_file.jpg La app_id se puede encontrar en la Consola de desarrollador en Projects & Apps. Ejemplo: 16489123 El siguiente ejemplo agrega app_id como la etiqueta contributor y date como la etiqueta date para una imagen:

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 <filename> 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 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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/account_media

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
account_media_ids opcional	Limita la respuesta a los medios de cuenta deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Type: string Example: `3wpx`
count opcional	Especifica el número de registros que se intentará recuperar por cada solicitud. Type: int Default: `200` Min, Max: `1`, `1000`
creative_types opcional	Limita la respuesta a los medios de cuenta que coincidan con los tipos creativos especificados. Se puede especificar más de un tipo creativo separando los valores del enum con comas. Type: enum Possible values: `BANNER`, `BANNER_TABLET`, `INTERSTITIAL`, `INTERSTITIAL_LANDSCAPE`, `INTERSTITIAL_LANDSCAPE_TABLET`, `INTERSTITIAL_TABLET`, `MEDIUM_RECTANGLE`, `PREROLL`, `VAST_PREROLL`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para obtener más información. Type: string Example: `8x7v00oow`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para obtener más información. Type: string Example: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de tasa más bajos, actualmente establecidos en 200 cada 15 minutos. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media?account_media_ids=3wpx

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_media_ids": [
        "3wpx"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_id": "13_771791717175468032",
      "media_url": null,
      "creative_type": "PREROLL",
      "id": "3wpx",
      "created_at": "2016-09-02T19:27:52Z",
      "updated_at": "2016-09-02T19:27:52Z",
      "deleted": false
    }
  ]
}

Obtiene un objeto de contenido multimedia de cuenta específico asociado a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
account_media_id obligatorio	Una referencia al medio de la cuenta con el que está operando en la solicitud. Tipo: string Ejemplo: `2pnfd`
with_deleted opcional	Incluye los resultados eliminados en su solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd

Ejemplo de respuesta

{
  "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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/account_media/:account_media_id

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio en todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
account_media_id required	Una referencia al contenido multimedia de la cuenta con el que se opera en la solicitud. Tipo: string Ejemplo: `2pnfd`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/account_media/2pnfd

Ejemplo de respuesta

{
  "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-08-25T17:16:26Z",
    "deleted": true
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "account_media_id": "2pnfd"
    }
  }
}

Tarjetas

Nota: Para asociar una tarjeta con un Tweet, utiliza el parámetro card_uri con cualquiera de los endpoints POST accounts/:account_id/tweet, POST statuses/update, POST accounts/:account_id/scheduled_tweets o POST accounts/:account_id/draft_tweets. Obtén los detalles de algunas o todas las tarjetas asociadas a la cuenta actual. Nota: Esto solo devuelve tarjetas que se hayan creado mediante el endpoint POST accounts/:account_id/cards. Las tarjetas creadas mediante otros endpoints no se devuelven.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_types optional	Restringe la respuesta únicamente a los tipos de tarjeta deseados especificando una lista separada por comas de valores de enumeración (enum). Type: enum Possible values: `IMAGE_APP`, `IMAGE_CAROUSEL_APP`, `IMAGE_CAROUSEL_WEBSITE`, `IMAGE_MULTI_DEST_CAROUSEL_WEBSITE`, `IMAGE_WEBSITE`, `MIXED_MEDIA_MULTI_DEST_CAROUSEL_WEBSITE`, `MIXED_MEDIA_SINGLE_DEST_CAROUSEL_APP`, `MIXED_MEDIA_SINGLE_DEST_CAROUSEL_WEBSITE`, `VIDEO_APP`, `VIDEO_CAROUSEL_APP`, `VIDEO_CAROUSEL_WEBSITE`, `VIDEO_MULTI_DEST_CAROUSEL_WEBSITE`, `VIDEO_WEBSITE`
card_id optional	Restringe la respuesta únicamente a las tarjetas deseadas especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 card IDs. Type: string Example: `1044294149527166979,1044301099031658496`
card_uris optional	Restringe la respuesta únicamente a las tarjetas deseadas especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 valores de card URI. Type: string Example: `card://1044294149527166979,card://1044301099031658496`
count optional	Especifica el número de registros que se intentará recuperar por cada solicitud distinta. Type: int Default: `100` Min, Max: `1`, `200`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`
include_legacy_cards optional	Incluye tarjetas de sitio web y de App heredadas en la respuesta. Las tarjetas heredadas son aquellas cuya URL de recurso tiene el siguiente formato: accounts/:account_id/cards/:card_type. Consulta esta publicación del foro para desarrolladores para obtener más contexto. Type: boolean Default: `false` Possible values: `true`, `false`
q optional	Una consulta opcional para limitar las tarjetas por `name`. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: realiza una coincidencia de prefijo que no distingue entre mayúsculas y minúsculas. Type: string Example: `dtc`
sort_by optional	Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Type: string Example: `created_at-asc`
with_deleted optional	Incluye resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards?count=1

Ejemplo de respuesta

{
  "request": {
    "params": {
      "count": 1,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": "8wzvldqtc",
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "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"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-28T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

Recuperar los detalles de una sola tarjeta asociada a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/:card_id

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id required	El id de las tarjetas. Tipo: string Ejemplo: `1044294149527166979`
with_deleted optional	Incluye también los resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "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"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-28T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

POST accounts/:account_id/cards

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 para ver un ejemplo de uso detallado.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards

Parámetros

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. 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 del país donde se vende la app. Type: string Example: `US`
googleplay_app_id sometimes required	El nombre del paquete de la aplicación en Google Play. Nota: Se requiere al menos uno de los siguientes: `ios_app_store_identifier` o `googleplay_app_id`. Type: string Example: `com.twitter.android`
ios_app_store_identifier sometimes required	El identificador de la App Store de iOS. Nota: Se requiere al menos uno de los siguientes: `ios_app_store_identifier` o `googleplay_app_id`. Type: string Example: `333903271`
googleplay_deep_link optional	Un deep link a la app de Android que se está promocionando. Nota: Solo se puede usar si se ha proporcionado un `googleplay_app_id`. Type: string
ios_deep_link optional	Un deep link a la app de iOS que se está promocionando. Nota: Solo se puede usar si se ha proporcionado un `ios_app_store_identifier`. Type: string

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards

{
  "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"
      }
    }
  ]
}

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "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"
        }
      }
    ],
    "created_at": "2020-11-11T05:42:25Z",
    "card_uri": "card://1326399865065238531",
    "id": "1321554298900107264",
    "updated_at": "2020-11-11T05:42:25Z",
    "deleted": false,
    "card_type": "IMAGE_APP"
  }
}

Actualiza la tarjeta especificada asociada a la cuenta actual. Las solicitudes de edición de tarjetas solo aceptan cuerpos de solicitudes POST en JSON. El Content-Type debe establecerse en application/json.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/1321554298900107264

Parámetros

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. 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"
      }
    }
  ]
}

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "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"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-29T20:47:52Z",
      "deleted": false,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

Elimina la tarjeta especificada de la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	El id de la card que se va a eliminar. Tipo: string Ejemplo: `1044294149527166979`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_id": "1321554298900107264"
    }
  },
  "data": [
    {
      "name": "deep link",
      "components": [
        {
          "type": "SWIPEABLE_MEDIA",
          "media_keys": [
            "3_1073727809120419840",
            "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"
          }
        }
      ],
      "created_at": "2020-10-28T20:47:52Z",
      "card_uri": "card://1321554298900107264",
      "id": "1321554298900107264",
      "updated_at": "2020-10-29T20:47:52Z",
      "deleted": true,
      "card_type": "IMAGE_CAROUSEL_APP"
    }
  ]
}

Obtención de Cards

Recupera varias Cards, mediante sus card_uri, asociadas a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/all

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_uris required	Limita la respuesta únicamente a las cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 valores de URI de card. Type: string Example: `card://1044294149527166979,card://1044301099031658496`
with_deleted optional	Incluye los resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/all?card_uris=card://1044294149527166979,card://1044301099031658496

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_uris": [
        "card://1044294149527166979",
        "card://1044301099031658496"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "name": "X App",
      "googleplay_app_id": "com.twitter.android",
      "image_display_height": "836",
      "country_code": "US",
      "id": "692xn",
      "wide_app_image": "https://pbs.twimg.com/media/Dc263l9VwAAAeEH.jpg",
      "created_at": "2018-09-24T18:35:01Z",
      "image_display_width": "1600",
      "card_uri": "card://1044294149527166979",
      "updated_at": "2018-09-24T18:35:01Z",
      "app_cta": "INSTALL",
      "deleted": false,
      "card_type": "IMAGE_APP_DOWNLOAD"
    },
    {
      "video_poster_height": "9",
      "name": "Developer Platform",
      "website_shortened_url": "https://t.co/zadeUSVD18",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/991374284135137280.vmap",
      "content_duration_seconds": "24",
      "video_owner_id": "756201191646691328",
      "video_content_id": "13_991374284135137280",
      "website_display_url": "developer.x.com",
      "id": "6933h",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/991374284135137280/pl/sQrBsE9mFvNep9Cx.m3u8?tag=2",
      "website_dest_url": "https://developer.x.com",
      "created_at": "2018-09-24T19:02:38Z",
      "card_uri": "card://1044301099031658496",
      "title": "Developer Platform",
      "website_url": "https://developer.x.com",
      "updated_at": "2018-09-24T19:02:38Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/991374284135137280/img/YbbGQHvWRjoFgrLz.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_WEBSITE"
    }
  ]
}

Obtén una tarjeta específica, con card_id, asociada a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/all/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Una referencia a la card con la que se opera en la solicitud. Tipo: string Ejemplo: `508pf`
with_deleted opcional	Incluye los resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/all/508pf

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_id": "508pf",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "video website card",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/867520357225418752.vmap",
    "content_duration_seconds": "21",
    "video_owner_id": "756201191646691328",
    "video_content_id": "13_867520357225418752",
    "website_display_url": "developer.x.com",
    "id": "508pf",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/867520357225418752/pl/TPHeH5ZlHFCa2TeJ.m3u8",
    "website_dest_url": "https://developer.x.com/en/docs/ads/creatives/api-reference/video-website#post-accounts-account-id-cards-video-website",
    "created_at": "2017-11-10T09:00:35Z",
    "card_uri": "card://928910245920829440",
    "title": "VWC",
    "website_url": "https://t.co/F81hp59pUF",
    "updated_at": "2018-01-05T05:43:31Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/867520357225418752/img/E3pnXM0sCKnRsFih.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_WEBSITE"
  }
}

Tweets en borrador

GET accounts/:account_id/draft_tweets

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. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
count optional	Especifica el número de registros que se intentará recuperar por cada solicitud. Type: int Default: `100` Min, Max: `1`, `200`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: `c-jh1g0ryb`
user_id optional	Especifica el usuario para el que se recuperarán Tweets en borrador. De manera predeterminada, cuando no se especifica, se usa el usuario promocionable `FULL` de la cuenta. Type: string Example: `756201191646691328`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?count=1

Ejemplo de respuesta

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "name" null,
      "text": "hello, world",
      "user_id": "756201191646691328",
      "id": "994791681219231744",
      "nullcast": true,
      "created_at": "2018-05-11T04:09:53Z",
      "card_uri": null,
      "updated_at": "2018-05-11T04:09:53Z",
      "media_keys": []
    }
  ],
  "next_cursor": "c-jh1g0ryb"
}

Recupera un borrador de Tweet específico asociado a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
draft_tweet_id obligatorio	Una referencia al Tweet en borrador con el que estás trabajando en la solicitud. Tipo: string Ejemplo: `994788364334325760`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994788364334325760

Ejemplo de respuesta

{
  "request": {
    "params": {
      "draft_tweet_id": "994788364334325760"
    }
  },
  "data": {
    "name": null,
    "text": "#TwitterDev",
    "user_id": "756201191646691328",
    "id": "994788364334325760",
    "nullcast": true,
    "created_at": "2018-05-11T03:56:42Z",
    "card_uri": "card://958225772740714496",
    "updated_at": "2018-05-11T03:56:42Z",
    "media_keys": []
  }
}

POST accounts/:account_id/draft_tweets

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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/draft_tweets

Parámetros

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
as_user_id obligatorio	id de usuario del anunciante en cuyo nombre se publica el Tweet. El anunciante debe otorgar acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso permite llamar a la API utilizando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: string Ejemplo: `756201191646691328`
text a veces obligatorio	Texto de la actualización de estado. Es obligatorio si no se especifican `media_keys`. Tipo: string Ejemplo: `Just setting up my X.`
card_uri opcional	Asocia una tarjeta (card) con el Tweet usando el valor `card_uri` de cualquier respuesta de cards, si está disponible. Tipo: string Ejemplo: `card://960880280705392541`
media_keys opcional	Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Se pueden incluir hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Tipo: string Ejemplo: `13_1153584529292270722`
nullcast opcional	Indica si se debe crear un Tweet nullcast (o “Promoted-only”, solo promocionado). Tipo: boolean Valor predeterminado: `true` Valores posibles: `true`, `false`
name opcional	Nombre del borrador de Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `Tweet with name`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets?as_user_id=756201191646691328&text=Just setting up my X.

Ejemplo de respuesta

{
  "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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
draft_tweet_id obligatorio	Una referencia al Draft Tweet con el que está trabajando en la solicitud. Tipo: string Ejemplo: `994747471329873920`
card_uri opcional	Asocie una card con el Tweet usando el valor de `card_uri` de cualquier respuesta de cards, si está disponible. Nota: Para desasignar (eliminar), especifique el parámetro sin un valor. Tipo: string Ejemplo: `card://970582057284129151`
media_keys opcional	Asocie contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Incluya hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Nota: Para desasignar (eliminar), especifique el parámetro sin un valor. Tipo: string Ejemplo: `13_1153584529292270722`
nullcast opcional	Indica si se debe crear un Tweet nullcast (o “Promoted-only”). Tipo: boolean Valores posibles: `true`, `false`
text opcional	El texto de su actualización de estado. Tipo: string Ejemplo: `just setting up my twttr`
name opcional	El nombre del Draft Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `Tweet with name`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994747471329873920?text=just setting up my twttr

Ejemplo de respuesta

{
  "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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/draft_tweets/:draft_tweet_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
draft_tweet_id obligatorio	Una referencia al borrador de Tweet que estás utilizando en la solicitud. Tipo: string Ejemplo: `994787835663155200`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/994787835663155200

Ejemplo de respuesta

{
  "request": {
    "params": {
      "draft_tweet_id": "994787835663155200"
    }
  },
  "data": {
    "name": null,
    "text": "hello, world",
    "user_id": "756201191646691328",
    "id": "994787835663155200",
    "nullcast": true,
    "status": "DELETED",
    "created_at": "2018-05-11T03:54:36Z",
    "card_uri": null,
    "updated_at": "2018-05-11T04:07:31Z",
    "media_keys": []
  }
}

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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/draft_tweets/preview/:draft_tweet_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
draft_tweet_id obligatorio	Una referencia al Draft Tweet con el que se opera en la solicitud. Tipo: string Ejemplo: `996132315829948416`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/draft_tweets/preview/996132315829948416

Ejemplo de respuesta

{
  "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, POST statuses/update o 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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta vinculada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_ids opcional	Limita la respuesta únicamente a las Image Conversation Cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `59woh`
count opcional	Especifica el número de registros que se intentará obtener por cada solicitud. Type: int Default: `200` Min, Max: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información. Type: string Example: `8x7v00oow`
q opcional	Una consulta opcional para acotar las cards por `name`. Omite este parámetro para obtenerlas todas. Longitud máxima: 80 caracteres. Nota: Realiza una coincidencia de prefijo que no distingue mayúsculas y minúsculas. Type: string Example: `night`
sort_by opcional	Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyen `total_count` tendrán límites de tasa más bajos, actualmente fijados en 200 por 15 minutos. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation?card_ids=59woh

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_ids": [
        "59woh"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "image conversation card",
      "first_cta": "#moon",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "thanks",
      "id": "59woh",
      "first_cta_tweet": "stars",
      "media_key": "3_957113581522141184",
      "created_at": "2018-01-27T04:58:42Z",
      "image_display_width": "1280",
      "card_uri": "card://923498485702009837",
      "title": "Full moon",
      "updated_at": "2018-01-27T04:58:42Z",
      "deleted": false,
      "card_type": "IMAGE_CONVERSATION"
    }
  ]
}

Obtén una tarjeta de conversación con imagen específica asociada a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta de anunciante. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Una referencia a la tarjeta de conversación con imagen con la que trabajas en la solicitud. Tipo: string Ejemplo: `59woh`
with_deleted opcional	Incluye los resultados eliminados en tu solicitud. Tipo: boolean Valor predeterminado: `false` Posibles valores: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/59woh

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_id": "59woh",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "image conversation card",
    "first_cta": "#moon",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "thanks",
    "id": "59woh",
    "first_cta_tweet": "stars",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Full moon",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  }
}

POST accounts/:account_id/cards/image_conversation

Crea una nueva tarjeta de conversación con imagen relacionada con la cuenta especificada. Consulta Uploading Media para obtener información útil sobre la carga de imágenes en nuestros endpoints.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
first_cta required	El hashtag del llamado a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareNow`
first_cta_tweet required	El texto del Tweet que se utilizará cuando se haga clic en la primera CTA. Type: string Example: `I Heart @AdsAPI`
media_key required	La media key de una imagen que se utilizará en esta tarjeta. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800 px y una relación de aspecto ancho:alto de 1.91:1. Type: string Example: `3_1151345051104991073`
name required	El nombre de la tarjeta. Type: string Example: `image conversation card`
thank_you_text required	El texto que se mostrará después de que se haga clic en la CTA. Longitud máxima: 23 caracteres. Type: string Example: `Thank you`
second_cta sometimes required	El hashtag del llamado a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si `title` no está establecido. Example: `#ShareAgain`
second_cta_tweet sometimes required	El texto del Tweet que se utilizará cuando se haga clic en la segunda CTA. Nota: Obligatorio si `second_cta` está establecido. Type: string Example: `I Heart @AdsAPI Again`
title sometimes required	El título de la tarjeta, que aparece debajo de la imagen y encima de las CTAs. Longitud máxima: 23 caracteres. Type: string Nota: Obligatorio si `second_cta` no está establecido. Example: `Start a conversation`
third_cta optional	El hashtag del llamado a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareMore`
third_cta_tweet sometimes required	El texto del Tweet que se utilizará cuando se haga clic en la tercera CTA. Type: string Nota: Obligatorio si `third_cta` está establecido. Example: `I Heart @TwitterDev`
fourth_cta optional	El hashtag del llamado a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareExtra`
fourth_cta_tweet sometimes required	El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Type: string Nota: Obligatorio si `fourth_cta` está establecido. Example: `I Heart @TwitterDev Again`
unlocked_image_media_key optional	Un `media_key` de una imagen que se utilizará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800 px y una relación de aspecto ancho:alto de 5:2. Type: string Example: `3_883112887618682880`
thank_you_url optional	La URL que se mostrará junto con el texto de agradecimiento. Type: string Example: `https://example.com/thankyou`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation?media_key=3_957113581522141184&name=image conversation card&first_cta=#moon&first_cta_tweet=stars&thank_you_text=thanks&title=Full moon

Ejemplo de respuesta

{
  "data": {
    "name": "image conversation card",
    "first_cta": "#moon",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "thanks",
    "id": "59woh",
    "first_cta_tweet": "stars",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Full moon",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "name": "image conversation card",
      "first_cta": "#moon",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "thanks",
      "media_key": "3_957113581522141184",
      "account_id": "18ce54d4x5t",
      "first_cta_tweet": "stars",
      "image_display_width": "1280",
      "title": "Full moon",
      "card_type": "IMAGE_CONVERSATION"
    }
  }
}

Actualiza la tarjeta de conversación con imagen indicada de la cuenta actual. Consulta la sección Uploading Media para obtener información útil sobre cómo subir imágenes a nuestros endpoints.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_id required	Una referencia a la imagen de la image conversation card con la que estás operando en la solicitud. Type: string Example: `4i0qg`
first_cta optional	El hashtag de Call-To-Action (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareNow`
first_cta_tweet optional	El texto del Tweet que se utilizará cuando se haga clic en la primera CTA. Type: string Example: `I Heart @AdsAPI`
second_cta optional	El hashtag de Call-To-Action (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si `title` no está establecido (`not` set). Example: `#ShareAgain`
second_cta_tweet optional	El texto del Tweet que se utilizará cuando se haga clic en la segunda CTA. Nota: Obligatorio si `second_cta` está establecido. Type: string Example: `I Heart @AdsAPI Again`
third_cta optional	El hashtag de Call-To-Action (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareMore`
third_cta_tweet optional	El texto del Tweet que se utilizará cuando se haga clic en la tercera CTA. Type: string Nota: Obligatorio si `third_cta` está establecido. Example: `I Heart @TwitterDev`
fourth_cta optional	El hashtag de Call-To-Action (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareExtra`
fourth_cta_tweet optional	El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Type: string Nota: Obligatorio si `fourth_cta` está establecido. Example: `I Heart @TwitterDev Again`
media_key optional	La media key de una imagen que se utilizará en esta tarjeta. Nota: La imagen debe estar en la Media Library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800px y una relación de aspecto ancho:alto de 1.91:1. Type: string Example: `3_1151345051104991073`
name optional	El nombre de la tarjeta. Type: string Example: `moon card`
thank_you_text optional	El texto que se mostrará después de hacer clic en la CTA. Longitud máxima: 23 caracteres. Type: string Example: `Thank you`
thank_you_url optional	La URL que se mostrará con el texto de agradecimiento. Type: string Example: `https://example.com/thankyou`
title optional	El título de la tarjeta, que aparece debajo de la imagen y encima de las CTAs. Longitud máxima: 23 caracteres. Type: string Nota: Obligatorio si `second_cta` no está establecido (`not` set). Example: `Start a conversation`
unlocked_image_media_key optional	Un `media_key` de una imagen que se utilizará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la media library de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800px y una relación de aspecto ancho:alto de 5:2. Type: string Example: `3_883112887618682880`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/59woh?name=moon card

Ejemplo de respuesta

{
  "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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/image_conversation/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
card_id obligatorio	Una referencia a la Image Conversation Card con la que estás trabajando en la solicitud. Type: string Example: `4i0qe`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/image_conversation/4i0qe

Ejemplo de respuesta

{
  "data": {
    "name": "image conversation card",
    "id": "4i0qe",
    "created_at": "2017-07-07T00:03:01Z",
    "updated_at": "2017-08-23T13:26:23Z",
    "deleted": true,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0qe",
      "card_type": "image_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}

Biblioteca de medios

GET accounts/:account_id/media_library

Obtiene los detalles de algunos o todos los objetos de la biblioteca multimedia asociados a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/media_library

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
count optional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: `20` Min, Max: `1`, `50`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: `c-1`
media_type optional	Limita la respuesta al tipo de medio deseado. Type: enum Possible values: `GIF`, `IMAGE`, `VIDEO`
q optional	Una consulta opcional para acotar el recurso por los campos `name`, `title`, `file_name` y `description`. Nota: Esto realiza una coincidencia de términos que no distingue entre mayúsculas y minúsculas. Type: string Min, Max length: `1`, `255`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?count=1

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "count": 1
    }
  },
  "data": [
    {
      "tweeted": true,
      "name": null,
      "file_name": "coffee https://t.co/4tcPU9XUon",
      "media_url": "https://pbs.twimg.com/media/DJvnJf_UEAAXnzC.jpg",
      "media_category": "TWEET_IMAGE",
      "media_key": "3_908573900237180928",
      "created_at": "2017-09-15T06:11:12Z",
      "media_status": "TRANSCODE_COMPLETED",
      "media_type": "IMAGE",
      "updated_at": "2017-11-16T06:00:01Z",
      "deleted": false
    }
  ],
  "next_cursor": "c-1"
}

Obtiene un objeto específico de la biblioteca multimedia asociado a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta de anunciante. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
media_key obligatorio	Una referencia al objeto de la biblioteca de medios con el que se está operando en la solicitud. Tipo: string Ejemplo: `13_909110614026444802`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/13_909110614026444802

Ejemplo de respuesta

{
  "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. 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 de tipo PREROLL.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/media_library

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
media_key required	La `media_key` del contenido cargado. Se devuelve una `media_key` en la respuesta de POST media/upload cuando se especifica una `media_category`. Type: string Example: `3_931236738554519552`
description optional	La descripción que aparece debajo del video cuando se publica como un Tweet. Longitud máxima: 200 caracteres. De forma predeterminada, no se muestra en el Tweet. Para mostrar la `description` del video, usa el parámetro `video_description` con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: `This is the description under the video.`
file_name optional	El nombre de archivo del objeto de la biblioteca de medios. Longitud máxima: 255. El nombre de archivo se puede ver en el detalle de medios de cada recurso multimedia en la interfaz de Media Library en ads.x.com. Este campo estará vacío cuando `file_name` no se haya definido. Type: string Example: `coffee.jpeg`
name optional	El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta que aparece debajo de cada recurso multimedia en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando `name` no se haya definido. Type: string Example: `Latte`
poster_media_key optional	Especifica una imagen de portada para el video usando la `media_key` de una imagen cargada. Si no se especifica, se usará el primer fotograma. Nota: Solo se puede usar con videos. Type: string Example: `3_890599134483242005`
title optional	El título (encabezado) que aparece debajo del video cuando se publica como un Tweet. Longitud máxima: 70 caracteres. De forma predeterminada, no se muestra en el Tweet. Para mostrar el `title` del video, usa el parámetro `video_title` con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: `Video title`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library?media_key=3_931236738554519552

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "3_931236738554519552"
    }
  },
  "data": {
    "tweeted": false,
    "name": null,
    "file_name": null,
    "media_url": "https://pbs.twimg.com/media/DOxq4TtV4AAlvh_.jpg",
    "media_category": "TWEET_IMAGE",
    "media_key": "3_931236738554519552",
    "created_at": "2017-11-16T19:05:14Z",
    "media_status": "TRANSCODE_COMPLETED",
    "media_type": "IMAGE",
    "updated_at": "2017-11-16T19:05:23Z",
    "deleted": false
  }
}

Actualiza el objeto especificado de la biblioteca multimedia que pertenece a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
media_key required	Una referencia al objeto de la biblioteca de medios con el que estás operando en la solicitud. Type: string Example: `16_844800354743074820`
description optional	La descripción que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 200 caracteres. De forma predeterminada, esto no se muestra en el Tweet. Para mostrar la `description` del video, usa el parámetro `video_description` con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: `Esta es la descripción debajo del video.`
file_name optional	El nombre de archivo del objeto de la biblioteca de medios. Longitud máxima: 255. El nombre de archivo se puede ver en el detalle de medios de cada recurso multimedia en la interfaz de Media Library en ads.x.com. Este valor estará vacío cuando `file_name` no se haya establecido. Type: string Example: `coffee.jpeg`
name optional	El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta que aparece debajo de cada recurso multimedia en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando `name` no se haya establecido. Type: string Example: `Latte`
poster_media_key optional	Especifica una imagen de póster para el video usando el `media_key` de una imagen cargada. Nota: Solo se puede usar con videos. Type: string Example: `3_885003359340375465`
title optional	El título (encabezado) que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 70 caracteres. De forma predeterminada, esto no se muestra en el Tweet. Para mostrar el `title` del video, usa el parámetro `video_title` con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Type: string Example: `Video title`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/16_844800354743074820?title=cat GIF&description=in space

Respuesta de ejemplo

{
  "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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/media_library/:media_key

Parámetros

Nombre	Descripción
account_id required	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
media_key required	Referencia al objeto de la biblioteca de medios con el que trabajas en la solicitud. Tipo: string Ejemplo: `7_860318603387600896`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_library/7_860318603387600896

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "7_860318603387600896"
    }
  },
  "data": {
    "tweeted": true,
    "duration": 14330,
    "name": "mountains-on-ads.x.com",
    "file_name": "mountains.mp4",
    "description": "",
    "media_url": "https://video.twimg.com/ext_tw_video/860318603387600896/pu/vid/1280x720/xI3DbvWKxdvICsFW.mp4",
    "media_category": "TWEET_VIDEO",
    "poster_media_url": "https://pbs.twimg.com/media/C_B3bTRVYAAFBFt.jpg",
    "poster_media_key": "3_860318839740915712",
    "media_key": "7_860318603387600896",
    "created_at": "2017-05-05T02:21:53Z",
    "media_status": "TRANSCODE_COMPLETED",
    "title": "uploaded on ads.x.com",
    "media_type": "VIDEO",
    "aspect_ratio": "16:9",
    "updated_at": "2017-05-05T02:26:58Z",
    "deleted": true
  }
}

Tarjetas de encuesta

GET accounts/:account_id/cards/poll

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. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_ids optional	Limita la respuesta solo a las tarjetas de encuesta deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `57i77`
count optional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: `8x7v00oow`
q optional	Una consulta opcional para limitar las tarjetas por `name`. Omite este parámetro para recuperarlas todas. Longitud máxima: 80 caracteres. Nota: Realiza una coincidencia por prefijo sin distinguir mayúsculas y minúsculas. Type: string Example: `night`
sort_by optional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: `created_at-asc`
with_deleted optional	Incluye resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count optional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son mutuamente excluyentes. Nota: Las solicitudes que incluyen `total_count` tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll?card_ids=57i77

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_ids": [
        "57i77"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "video_poster_height": "9",
      "name": "best coast poll",
      "start_time": "2018-01-09T04:51:34Z",
      "first_choice": "East",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
      "content_duration_seconds": "8",
      "second_choice": "West",
      "end_time": "2018-01-16T04:51:34Z",
      "id": "57i77",
      "video_width": "16",
      "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
      "created_at": "2018-01-09T04:51:34Z",
      "duration_in_minutes": "10080",
      "card_uri": "card://950590850777497601",
      "updated_at": "2018-01-09T04:51:34Z",
      "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
      "video_poster_width": "16",
      "deleted": false,
      "card_type": "VIDEO_POLLS"
    }
  ]
}

Obtiene una tarjeta de encuesta específica asociada a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_id

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id required	Una referencia a la poll card con la que se opera en la solicitud. Tipo: string Ejemplo: `57i8t`
with_deleted optional	Incluye en la solicitud los resultados eliminados. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll/57i8t

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_id": "57i8t",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "text only poll",
    "start_time": "2018-01-09T05:03:05Z",
    "first_choice": "Morning",
    "second_choice": "Evening",
    "end_time": "2018-01-11T05:03:05Z",
    "id": "57i8t",
    "created_at": "2018-01-09T05:03:05Z",
    "duration_in_minutes": "2880",
    "card_uri": "card://950593749658189824",
    "updated_at": "2018-01-09T05:03:05Z",
    "deleted": false,
    "card_type": "TEXT_POLLS"
  }
}

POST accounts/:account_id/cards/poll

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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/poll

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
duration_in_minutes required	La cantidad de tiempo (en minutos) que la encuesta permanecerá abierta. Después de que transcurra el `duration_in_minutes` especificado, la encuesta se cerrará y ya no se aceptarán votos. Esto corresponde a `end_time` en la respuesta. Nota: Esto comienza en cuanto se crea la tarjeta y no cuando se añade a un Tweet. Type: int Min, Max: `5`, `10080`
first_choice required	La primera opción de la encuesta. Longitud máxima: 25 caracteres. Type: string Example: `One`
name required	El nombre de la tarjeta. Type: string Example: `poll card`
second_choice required	La segunda opción de la encuesta. Longitud máxima: 25 caracteres. Type: string Example: `Two`
fourth_choice optional	La cuarta opción de la encuesta. Longitud máxima: 25 caracteres. Nota: La primera, segunda y tercera opciones deben definirse cuando se utilice este parámetro. Type: string Example: `Four`
media_key optional	El `media_key` de una imagen o video de la biblioteca de medios que se usará en esta tarjeta. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para este medio. Nota: La imagen o el video deben estar en la biblioteca de medios de la cuenta. Nota: Se requiere un ancho mínimo de imagen de 800px y una relación de aspecto ancho:alto de 1.91:1.
third_choice optional	La tercera opción de la encuesta. Longitud máxima: 25 caracteres. Nota: La primera y segunda opciones deben definirse cuando se utilice este parámetro. Type: string Example: `Three`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll?duration_in_minutes=10080&first_choice=East&second_choice=West&media_key=13_950589518557540353&name=best coast poll

Ejemplo de respuesta

{
  "request": {
    "params": {
      "first_choice": "East",
      "name": "best coast poll",
      "second_choice": "West",
      "media_key": "13_950589518557540353",
      "duration_in_minutes": 10080
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "best coast poll",
    "start_time": "2018-01-09T04:51:34Z",
    "first_choice": "East",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
    "content_duration_seconds": "8",
    "second_choice": "West",
    "end_time": "2018-01-16T04:51:34Z",
    "id": "57i77",
    "video_width": "16",
    "video_hls_url": "https://video.twimg.com/amplify_video/950589518557540353/vid/1280x720/BRkAhPxFoBREIaFA.mp4",
    "created_at": "2018-01-09T04:51:34Z",
    "duration_in_minutes": "10080",
    "card_uri": "card://950590850777497601",
    "updated_at": "2018-01-09T04:51:34Z",
    "video_poster_url": "https://pbs.twimg.com/amplify_video_thumb/950589518557540353/img/nZ1vX_MXYqmvbsXP.jpg",
    "video_poster_width": "16",
    "deleted": false,
    "card_type": "VIDEO_POLLS"
  }
}

Eliminar permanentemente la tarjeta de encuesta especificada de la cuenta actual. Nota: Esta es una eliminación definitiva. Por lo tanto, no es posible recuperar las tarjetas eliminadas.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/poll/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Una referencia a la tarjeta de encuesta con la que se opera en la solicitud. Tipo: string Ejemplo: `57i9t`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/poll/57i9t

Ejemplo de respuesta

{
  "data": {
    "name": "poll with image",
    "start_time": "2018-01-09T05:10:51Z",
    "id": "57i9t",
    "created_at": "2018-01-09T05:10:51Z",
    "updated_at": "2018-01-09T05:11:04Z",
    "deleted": true,
    "card_type": "IMAGE_POLLS"
  },
  "request": {
    "params": {
      "card_id": "57i9t",
      "card_type": "poll",
      "account_id": "18ce54d4x5t"
    }
  }
}

Llamadas a la acción de prerroll

GET accounts/:account_id/preroll_call_to_actions

Recupera los detalles de algunas o todas las llamadas a la acción (CTAs) de preroll asociadas a los line items de la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
line_item_ids optional	Limita la respuesta solo a las CTAs prerroll asociadas con los line items especificados mediante una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ids. Type: string Example: `8v53k`
count optional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud distinta. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta la sección Pagination para obtener más información. Type: string Example: `8x7v00oow`
preroll_call_to_action_ids optional	Limita la respuesta solo a las CTAs prerroll deseadas mediante una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ids. Type: string Example: `8f0`
sort_by optional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta la sección Sorting para obtener más información. Type: string Example: `created_at-asc`
with_deleted optional	Incluye resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count optional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyen `total_count` tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_ids=8v53k

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "line_item_ids": [
        "8v53k"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8v53k",
      "call_to_action_url": "https://www.x.com",
      "call_to_action": "VISIT_SITE",
      "id": "8f0",
      "created_at": "2017-07-07T19:28:40Z",
      "updated_at": "2017-07-07T19:28:40Z",
      "deleted": false
    }
  ]
}

Recuperar una llamada a la acción (CTA) específica asociada a esta cuenta.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
preroll_call_to_action_id required	Una referencia al llamado a la acción de prerroll con el que realiza la solicitud. Tipo: string Ejemplo: `8f0`
with_deleted optional	Incluya resultados eliminados en su solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0

Ejemplo de respuesta

{
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  }
}

POST accounts/:account_id/preroll_call_to_actions

Configura el Llamado a la acción (CTA) opcional para un line item de tipo PREROLL_VIEWS.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
call_to_action required	El texto de la CTA (llamado a la acción) para el botón que se muestra en el anuncio. Type: enum Possible values: `GO_TO`, `SEE_MORE`, `SHOP`, `VISIT_SITE`, `WATCH_NOW`
call_to_action_url required	La URL a la que se redirigirá al usuario cuando se haga clic en el botón de CTA. Type: string Example: `https://www.x.com`
line_item_id required	Una referencia al line item con el que trabajas en la solicitud. Type: string Example: `8v53k`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions?line_item_id=8v53k&call_to_action=VISIT_SITE&call_to_action_url=https://www.x.com

Ejemplo de respuesta

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-07-07T19:28:40Z",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "8v53k",
      "call_to_action": "VISIT_SITE",
      "call_to_action_url": "https://www.x.com",
      "account_id": "18ce54d4x5t"
    }
  }
}

Actualiza el llamado a la acción (CTA) opcional de una partida de línea PREROLL_VIEWS.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
preroll_call_to_action_id obligatorio	Una referencia al CTA de preroll con el que operas en la solicitud. Tipo: string Ejemplo: `8f0`
call_to_action opcional	El texto del CTA para el botón que se muestra dentro del anuncio. Tipo: enum Valores posibles: `GO_TO`, `SEE_MORE`, `SHOP`, `VISIT_SITE`, `WATCH_NOW`
call_to_action_url opcional	La URL a la que se redirige al usuario cuando se hace clic en el botón de CTA. Tipo: string Ejemplo: `https://www.x.com`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0?call_to_action=WATCH_NOW

Ejemplo de respuesta

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "WATCH_NOW",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-09-09T05:51:26Z",
    "deleted": false
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "call_to_action": "WATCH_NOW",
      "account_id": "18ce54d4x5t"
    }
  }
}

Elimina la llamada a la acción (CTA) de prerroll especificada de la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/preroll_call_to_actions/:preroll_call_to_action_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
preroll_call_to_action_id obligatorio	Una referencia al llamado a la acción (CTA) de prerroll con el que operas en la solicitud. Tipo: string Ejemplo: `8f0`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/preroll_call_to_actions/8f0

Ejemplo de respuesta

{
  "data": {
    "line_item_id": "8v53k",
    "call_to_action_url": "https://www.x.com",
    "call_to_action": "VISIT_SITE",
    "id": "8f0",
    "created_at": "2017-07-07T19:28:40Z",
    "updated_at": "2017-08-30T06:08:21Z",
    "deleted": true
  },
  "request": {
    "params": {
      "preroll_call_to_action_id": "8f0",
      "account_id": "18ce54d4x5t"
    }
  }
}

Tweets programados

GET accounts/:account_id/scheduled_tweets

Obtén los detalles de algunos o todos los Tweets programados asociados a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
count opcional	Especifica el número de registros que se intentará recuperar en cada solicitud. Type: int Default: `100` Min, Max: `1`, `200`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: `c-j3cn6n40`
user_id opcional	Especifica el usuario para el que se recuperarán Tweets programados. De forma predeterminada, se utiliza el usuario promocionable `FULL` de la cuenta cuando no se establece. Type: long Example: `756201191646691328`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?count=1

Ejemplo de respuesta

{
  "request": {
    "params": {
      "count": 1
    }
  },
  "data": [
    {
      "name": "test name",
      "completed_at": "2017-06-18T22:00:05Z",
      "text": "where you want to be",
      "user_id": "756201191646691328",
      "scheduled_status": "SUCCESS",
      "id": "875828692081037312",
      "nullcast": true,
      "created_at": "2017-06-16T21:33:27Z",
      "scheduled_at": "2017-06-18T22:00:00Z",
      "card_uri": null,
      "updated_at": "2017-06-19T18:02:20Z",
      "tweet_id": "876560168963645440",
      "media_keys": []
    }
  ],
  "next_cursor": "c-j41uw400"
}

Recuperar un Tweet programado específico asociado a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y suele ser un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_tweet_id required	Una referencia al Tweet programado con el que se está operando en la solicitud. Tipo: string Ejemplo: `917438609065623552`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/917438609065623552

Respuesta de ejemplo

{
  "request": {
    "params": {
      "scheduled_tweet_id": "917438609065623552"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": "917438609065623552",
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

POST accounts/:account_id/scheduled_tweets

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.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
scheduled_at required	La hora, expresada en formato ISO 8601, a la que el Tweet debe publicarse (o hacerse visible). Nota: los Tweets solo se pueden programar hasta con un año de antelación. Nota: los Tweets solo deben programarse con granularidad de minutos; los segundos se ignorarán. Type: string Example: `2017-12-31T23:59:00Z`
as_user_id required	El ID de usuario del anunciante en cuyo nombre estás publicando el Tweet. El anunciante debe conceder acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso te permite llamar a la API usando los tokens OAuth de tu propio handle en lugar de los del anunciante. Type: long Example: `756201191646691328`
text sometimes required	El texto de tu actualización de estado. Es obligatorio si no se especifican `media_keys`. Type: string Example: `just setting up my twttr`
card_uri optional	Asocia una tarjeta (card) con el Tweet usando el valor `card_uri` de cualquier respuesta de tarjetas (cards), si está disponible. Type: string Example: `card://855591459410511943`
media_keys optional	Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: el recurso multimedia debe estar en la Media Library de la cuenta. Type: string Example: `13_1153584529292270722`
nullcast optional	Indica si se debe crear un Tweet nullcasted (o “Promoted-only”). Type: boolean Default: `true` Possible values: `true`, `false`
name optional	El nombre del Tweet programado. Longitud máxima: 80 caracteres. Type: string Example: `Tweet with name`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets?as_user_id=756201191646691328&media_keys=3_917438348871983104&scheduled_at=2018-01-01

Ejemplo de respuesta

{
  "request": {
    "params": {
      "media_keys": [
        "3_917438348871983104"
      ],
      "scheduled_at": "2018-01-01T00:00:00Z",
      "as_user_id": 756201191646691328
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "text": "",
    "user_id": "756201191646691328",
    "scheduled_status": "SCHEDULED",
    "id": "917438609065623552",
    "nullcast": true,
    "created_at": "2017-10-09T17:16:24Z",
    "scheduled_at": "2018-01-01T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-10-09T17:16:24Z",
    "tweet_id": null,
    "media_keys": [
      "3_917438348871983104"
    ]
  }
}

Actualiza el Tweet programado especificado de la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
scheduled_tweet_id required	Una referencia al Tweet programado con el que estás operando en la solicitud. Type: string Example: `870321875435442177`
card_uri optional	Asocia una tarjeta con el Tweet usando el valor `card_uri` de cualquier respuesta de tarjetas, si está disponible. Note: Para desasignar (eliminar), especifica el parámetro sin un valor. Type: string Example: `card://875146925316386347`
media_keys optional	Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Note: El recurso multimedia debe estar en la Media Library de la cuenta. Note: Para desasignar (eliminar), especifica el parámetro sin un valor. Type: string Example: `13_1153584529292270722`
nullcast optional	Indica si se debe crear un Tweet de tipo nullcast (o “Promoted-only”). Type: boolean Possible values: `true`, `false`
scheduled_at optional	La hora, expresada en formato ISO 8601, en la que el Tweet debe publicarse (o pasar a estar activo). Type: string Example: `2017-12-31T23:59:59Z`
text optional	El texto de tu actualización de estado. Type: string Example: `just setting up my twttr`
name optional	El nombre del Tweet programado. Longitud máxima: 80 caracteres. Type: string Example: `Tweet with name`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875057751231037440?text=winter solstice

Ejemplo de respuesta

{
  "request": {
    "params": {
      "scheduled_tweet_id": "875057751231037440",
      "text": "winter solstice"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "SCHEDULED",
    "text": "winter solstice",
    "user_id": "756201191646691328",
    "id": "875057751231037440",
    "nullcast": true,
    "created_at": "2017-06-14T18:30:00Z",
    "scheduled_at": "2017-12-21T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T18:30:00Z",
    "tweet_id": null,
    "media_keys": []
  }
}

Elimina de forma permanente el Tweet programado especificado de la cuenta actual. Nota: Se trata de una eliminación definitiva. Como resultado, no es posible recuperar los Tweets programados eliminados.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_tweet_id obligatorio	Una referencia al Scheduled Tweet con el que se opera en la solicitud. Tipo: string Ejemplo: `870321875435442177`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_tweets/875064008595787776

Ejemplo de respuesta

{
  "request": {
    "params": {
      "scheduled_tweet_id": 875064008595787776
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "DELETED",
    "text": "hello, world",
    "user_id": "756201191646691328",
    "id": "875064008595787776",
    "nullcast": true,
    "created_at": "2017-06-14T18:54:52Z",
    "scheduled_at": "2017-06-15T00:00:00Z",
    "card_uri": null,
    "updated_at": "2017-06-14T19:01:16Z",
    "tweet_id": null,
    "media_keys": []
  }
}

Vistas previas de Tweets

GET accounts/:account_id/tweet_previews

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

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/tweet_previews

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
tweet_ids required	Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 identificadores. Nota: Los identificadores deben corresponder al `tweet_type` especificado. Por ejemplo, si se pasa un ID de Tweet programado y se especifica `tweet_type=PUBLISHED`, no se devolverá una vista previa para ese ID. Type: long Example: `1122911801354510336,1102836745790316550`
tweet_type required	El tipo de Tweet para los `tweet_ids` especificados. Type: enum Valores posibles: `DRAFT`, `PUBLISHED`, `SCHEDULED`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet_previews?tweet_ids=1122911801354510336,1102836745790316550&tweet_type=PUBLISHED

Ejemplo de respuesta

{
  "request": {
    "params": {
      "tweet_ids": [
        "1122911801354510336",
        "1102836745790316550"
      ],
      "tweet_type": "PUBLISHED",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "tweet_id": "1122911801354510336",
      "preview": "<iframe class='tweet-preview' src='https://ton.twimg.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAANVYW2%2FbNhT%2BKwJf59iiZDuSgWLI0suyrUXbZBuGaiAoibbZUKRGUk7TIP99h6Jsy4mdC5CX%2BiUiz%2F0cfueQuUH2ijGLZsENKjSjlpWEwhK9VzI4qXUQpQE%2BnuF4FofBTyH8gijEKRogXqIZxlGUYpyEOJ6MJziM46kjEGM1qNhDBbl5IwSx7JszsuIlU8EVyw23DGhWN7JwPqDZnArDBqjkphb0uhUgmsoFQ7Mv4QDH%2Fw4Qk5Zbzgya3aAlNUtLF%2FD9BSjmusqV6BaNYZpUjlnJ9Zb2xFtgVY0uQCnKmjCMCxosNZu%2FytDS2trMslE2oqU5ojUf2ituLdPDQlUZCjQTwCXVXAmhrjIvzi48T3BSmuBUVbUC214x6PEsLnWSaFYLiEpBqqhtDHHZlJCZA0Sf0fsMbWz7ZTvSIUkD1WaSSFqxNdlJuFw6fceTKdQZp3g6nk5THEdJr7D3iRCU14ROPp4F74sLZuycFi7YHUMIElkVdksVCuoNhQHSOZXBWyhxwU2hBsHpCWoLtfauZKCJ1x3zmbQqcHq4XARUlgHYNSBQa2VZ0T9BvkBMG1KoRsKpO8KwqTmT5c6W4MYd%2Fm7H29xBxMWyCX5rRBDhACezyXQWJVtEtCebruAwwUne0dvYgqj53LCNVssrRr4ruUn8ginCJM1Fz%2B0V03zOexv%2BLOzqFgAI8IxJsF4oaTXPG6sg1LvauCEWUmsEBfK%2BXcjqPSHI5ZwLRnJaXC40WHXZEU4ehe0P7eXhFV0w0lauRZEHUW4cgKpFC59Ry2OykV2yavMXZ6N8MawhpIf1khabnXbzUuotrO%2BFvjeWetfYDi8YA3TE4yTGx%2BNJMgnTJJpko9cXvxefT%2BtzIpWuqBh%2BrftePBTZixvLqZTQGbYxPWjHc3tDdzCfjfAYvqbROMY9%2FYLLy8PnxEDHz6kmudIlePEoHyzEYa52KhykAlrunZ%2FtYGFz2ghLOuZD%2B3ekfDPhDnUeun4D2up%2FDTQjYti2eUhlAcG%2BvZkN9jcoJPa6dh1RukZw2zaBTdtRkB0uofVs5GAIFmxL30J9vadZO8jX3SH07ch1oz1bW4x3Yn3UK2N4DkMCYoGxzFfb6KEv137cbppqRwP%2FC6pLR%2BoafTRJpnEaHuPpDFJZKdLOerKd9f4AOqn2%2FOFwPI5DHKZpGOPpJBmnrqU6cpuouxh0hCNHOALCETdHJas1a%2B8OQy5XVMAQG6CcS8jjgsC68Y539olZKm2ZhN7eKr5BXTXOLz6ffXjnxhZkeC25AxQLAMlG32nJ%2Fjz%2F6zVOXO1cQaDypGy0b6WGwVZpnqA4GjsF7o4DcLjipV0%2BQQjGzVZobZyXT5GMSQroPR5HyRiuZfAVJWFP2ZLxxdI%2BQVHqhFZUcnv9xBSWbMUEHCDdv0k5LeualA5Bzy3HQa1dQOpKdlekR5Xuudb0EiPMs31rj3y%2Fq9KqFnx%2B7bGQje5XAhqvyEbmk%2F7FvEmrt6sPrE5Pvw2ruEl%2Bhuvtq8h5BLde17AedeT1OjXBR%2Bg4cxgG%2FWy%2FdKJBkNHqxXO0qmi9L1NDR%2BiZ9zPUwLzr2z97f%2FLujbtxt9TO%2Bg16ZPjtuEDssqny%2FcUCiWz0T56%2F%2B%2FTr6u%2FPX9Xbhf7jezdvOyxjYBygNayOI1hQ0c2I2zvu%2F7COE0H1j%2Bz%2Btx8wgHY0Pnt49aDbPs14zsglu%2B4mcatvo7xedw2w0P%2BGTsAL1pv18No9qTlqHy3Gv89w7LBJmxLeWTu8cBkom6J9xcF8bopLtonJGd6%2BaG4HAWpvDv5VJv2%2FDIKbzSYsrG7Y7e3%2FCm%2FIC8QQAAA%3D'>"
    },
    {
      "tweet_id": "1102836745790316550",
      "preview": "<iframe class='tweet-preview' src='https://ton.twimg.com/ads-manager/tweet-preview/index.html?data=H4sIAAAAAAAAAO1YbW%2FbNhD%2BK4K%2Bzo3eZdlAMQQttqZrt6FNEXRVIVASJTOhSIWkHDeB%2F%2FuOomXLb%2BuHdQWGzV8s3T13vCOPz539ZKsHjJU9t57sQmCkcJkheLWvO2y9RcJyI8udzkN%2F7ofWDy58LN%2F1ZvbEJqU99zzXT4J4GkbTmRt4cRS5WpFJJcDFCS3YVR2lmcIrvcgNWmJpLZRq5Tx1UkddFDx16mUU8Lv4UhQAV6JjhQ7LnleISjyxSyJbir70PjKBWI3t%2BSd3En2e2JgpogiW9vzJXiC5UKiG50%2BgkV%2BanNPNSyexyBoN5mwQiUHZ4JIgeHwyGbpumLjh1PcDfxZ6XpSE4wyPtXpnWEkKHcSneOLPBpcZLAEmOtk%2B1zaXF%2BqBNDXk3KSOTkY9ZEtSYp6pRdfkqXPCPdh1qQNWYPFz%2BfHls7v7y6s3dZm%2Fci9u29oeLZb1%2B7pZUv6ja%2B5SO3uOw6kZaEsKHYhSWJhQ9rB41SJWQiUe%2BR2boJY0hcJSVajAqSMVUp2EBI6rLnX6FEGnC%2BpLi3UEC644vEryaOqlz18%2FPMCp6zpebL4F1hgwKQRv7bXZ4a4ZoL5rsPE0GmErojRUNojSDTJODDBIgmMgRULX8cblBjn13UMkQCu4pZ3og16vP6%2F1dincb9e4%2FP8v4%2F9EGfeSf2UZm%2BMirOIaj2SLC03nwMlQcV480RVXdr2AZQ2hlEhdx9MYnC2RIIgp2dd3ThSgwHUSQBKgLTiDCwE1Mdqi1Gna8MQR98pzxfQXZQT61IlDdxXEcC7Rm1fsHl96H8sau%2Fer1xew2I%2FQfJ4HsCmjCP0o%2Fr4Rwo6svAQivLvqXn14mRD%2FD%2BnWuX91NkJv%2Bp1D1GWyghJJnbD56HePt%2FjXG%2FJbVd3cHsR4EBFqW0qKvjxSZ%2FWsaXH94d2bbxhdS1Nn5r17CF7cTMurt6%2Ffh7fJRRN0yRDT5wMyntioLIkOCNHM8NdQ3sDLVAetGQTLQpBWw4wANzkuS5RrAEw7MOE0nGFFHo2on3oM0UveiUK7STvXDQpkLQSunqejXFEp9wjJtgSmgGC84pTyh9SY4muDsS5LaXyBqdH0xJ8J3FKYsHhm6CjTPYTB4HZGafrIMaAftE7bblTnLGGPMGYZQw0e1NpC76X2N41iGEO9mReHcTzzAj8ZtbNjJSRlPNmXv19Zb4vrDd1q4hwvZO%2BRMWgpNxUGqveIWT%2FBuFkQWfCJ9eJyKDUT3f6xXjHFLe2HsNqCJmDBuhIMWsEV8NxomjXngoXMCt4xGIqfeSAUBDr6ngjoT8%2FmG4lZc39gX3TW645avmd5yTyK536yG9hjPXijJdQPgajGfjtVZLyqJN56VaTB2SOU4CCogacx09W4C3uJBanISGBqYd83heEcIsPMNnwiSN4pDqkeeiMyA%2F5hkiJQn5LqHnBoBHtZEYqzHBV3tYBV9e5QbW%2B7%2Fcc%2BiSENqvHhFIP2J4oeA01YLXCz%2FfZSJ68vWlZ%2Fxe%2BJgeUbuFdkSwY7%2FclcDqajPSwsBrcjCJPAg8kiidxZ4kep8%2FL6l%2BLdi%2FZ9xriAVr8Zh45W%2Bfoo9vcXyxFjwAyHJH5mHYM2Cx3ceWD2EJ5iPwy8kX9K2N35OpHQE3IkspyLEqL4Kg5e6HlU%2Fwv1rBZuy1H97H7k4gp1VGUb8Dn5gZUhE6Jvnbm6RgC0et8BGWUS78iDcQU32NCb3N797S0c2izTRLDuSWBLOxx2hzCgnq0dzMQF3ul3V32QCdz%2FzzCwg2voSLPRCdHujm%2FMxreeS0lyaBKQi4Rmu9xlD7zcmiF4S6pD%2Bxxz0Xpi6TNouOFTZv6LsJ62QnjRfXi9%2FhONbe6QHREAAA%3D%3D'>"
    }
  ]
}

Tweets

GET accounts/:account_id/tweets

Obtén los detalles de Tweets para el usuario promocionable completo de la cuenta (predeterminado) o para el usuario especificado en el parámetro user_id. Puede ser cualquiera de los promotable users de la cuenta.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/tweets

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
tweet_type required	El tipo de Tweet para los `tweet_ids` especificados. Type: enum Possible values: `DRAFT`, `PUBLISHED`, `SCHEDULED`
count optional	Especifica la cantidad de registros que se intentarán recuperar por cada solicitud distinta. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información. Type: string Example: `AAAAAFhLRpQLNF-sGBSgAA`
include_mentions_and_replies optional	Indica si se deben filtrar las menciones y respuestas de la lista de Tweets disponibles. Type: boolean Default: `false` Possible values: `true`, `false`
name optional	Una consulta opcional para restringir los Tweets por `name`. Omite este parámetro para recuperar todos. Longitud máxima: 80 caracteres. Nota: Realiza una coincidencia de prefijos sin distinción entre mayúsculas y minúsculas. Type: string Example: `dtc`
timeline_type optional	Indica si se deben devolver Tweets nullcasted (también conocidos como “Promoted-only”), Tweets orgánicos o ambos. Type: enum Default: `NULLCAST` Possible values: `ALL`, `NULLCAST`, `ORGANIC`
trim_user optional	Indica si se debe excluir el objeto de usuario en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto de usuario que se devolverá es el ID de usuario del autor del Tweet. Type: boolean Default: `false` Possible values: `true`, `false`
tweet_ids optional	Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Nota: Los ID deben corresponder con el `tweet_type` especificado. Por ejemplo, si se pasa el ID de un Tweet programado, entonces el `tweet_type` debe ser `SCHEDULED` para que ese Tweet se devuelva en la respuesta. Type: long Example: `1122911801354510336,1102836745790316550`
user_id optional	Especifica el usuario al que se limitarán los Tweets. De manera predeterminada, cuando no se establece, se usa el usuario promocionable `FULL` de la cuenta. Type: long Example: `756201191646691328`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets?tweet_ids=1166476031668015104&tweet_type=PUBLISHED&trim_user=true

Ejemplo de respuesta

{
  "request": {
    "params": {
      "tweet_ids": [
        "1166476031668015104"
      ],
      "tweet_type": "PUBLISHED",
      "trim_user": true,
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "coordinates": null,
      "retweeted": false,
      "name": null,
      "source": "<a href="https://ads-api.x.com" rel="nofollow">Ads API Internal Test App</a>",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        9
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "1166476031668015104",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "id": 1166476031668015104,
      "in_reply_to_status_id": null,
      "conversation_settings": "EVERYONE",
      "nullcast": true,
      "created_at": "Tue Aug 27 22:22:12 +0000 2019",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "hello, v6",
      "lang": "es",
      "contributors": [
        2417045708
      ],
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "id": 756201191646691328,
        "id_str": "756201191646691328"
      },
      "tweet_id": "1166476031668015104"
    }
  ]
}

POST accounts/:account_id/tweet

Crea un Tweet para el usuario promocionable FULL de la cuenta (predeterminado) o para el usuario especificado en el parámetro as_user_id. Se admite tanto la creación de Tweets nullcasted (predeterminada) como orgánicos. Los Tweets nullcasted no aparecen en la cronología pública y no se entregan a los seguidores. Cualquiera de los dos tipos se puede usar en campañas. Si el usuario autenticado no es el usuario promocionable FULL de esta cuenta, comprueba si tiene permiso para tuitear en nombre de este usuario realizando una solicitud al endpoint GET accounts/:account_id/authenticated_user_access. Un permiso de TWEET_COMPOSER indica que el usuario puede usar este endpoint para crear Tweets nullcasted en nombre del usuario promocionable FULL. Cuando utilices el endpoint upload.x.com para contenido multimedia, pasa el mismo valor de user_id para el parámetro additional_owners que el valor as_user_id que envías a este endpoint.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/tweet

Parámetros

Name	Description
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
as_user_id obligatorio	El ID de usuario del anunciante en cuyo nombre estás publicando el Tweet. El anunciante debe otorgar a tu handle (o handles) acceso a su cuenta de anuncios a través de ads.x.com. Este permiso te permite llamar a la API utilizando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: long Ejemplo: `756201191646691328`
text a veces obligatorio	El texto de tu actualización de estado. Obligatorio si no se especifican `media_keys`. Tipo: string Ejemplo: `hello, world`
card_uri opcional	Asocia una tarjeta (card) con el Tweet usando el valor `card_uri` de cualquier respuesta de tarjetas (cards), si está disponible. Tipo: string Ejemplo: `card://853503245793641682`
conversation_settings opcional	Elige quién puede responder a este Tweet. Cualquiera que se mencione siempre puede responder. Nota: Este campo no se devolverá en la respuesta de la solicitud POST, pero se devolverá al realizar una solicitud GET. Nota: Este parámetro solo funciona en Ads API v8 y posteriores. Tipo: enum Valor predeterminado: `EVERYONE` Valores posibles: `EVERYONE`, `FOLLOWING`, `MENTIONED_USERS`
media_keys opcional	Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Tipo: string Ejemplo: `13_1153584529292270722`
name opcional	El nombre del Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `Tweet with name`
nullcast opcional	Indica si se debe crear un Tweet de tipo nullcast (o “Promoted-only”). Nota: Los Tweets orgánicos (`nullcast=false`) solo se pueden crear para el usuario autenticado. Tipo: boolean Valor predeterminado: `true` Valores posibles: `true`, `false`
trim_user opcional	Indica si se debe excluir el objeto user en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto user que se devolverá es el ID de usuario del autor del Tweet. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`
tweet_mode opcional	Indica si la respuesta debe estar en modo de compatibilidad o en modo extendido. Consulta esto para obtener información adicional. Tipo: string Valores posibles: `compat`, `extended`
video_cta opcional	La CTA para el video. Tipo: enum Valores posibles: `VISIT_SITE`, `WATCH_NOW`
video_cta_value opcional	El valor para la CTA correspondiente en el video. Tipo: string Ejemplo: `https://dev.x.com`
video_description opcional	La descripción que aparece debajo del video. Longitud máxima: 200 caracteres. Tipo: string Ejemplo: `Integra tu servicio con la plataforma de publicidad de X`
video_title opcional	El título (headline) que aparece debajo del video. Longitud máxima: 70 caracteres. Tipo: string Ejemplo: `X Ads API`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tweet?text=hello, world&as_user_id=756201191646691328&trim_user=true

Ejemplo de respuesta

{
  "data": {
    "created_at": "Sat Jun 24 05:08:30 +0000 2017",
    "id": 878479925472251906,
    "id_str": "878479925472251906",
    "text": "hello, world",
    "name": null,
    "truncated": false,
    "entities": {
      "hashtags": [],
      "symbols": [],
      "user_mentions": [],
      "urls": []
    },
    "source": "<a href='"https://ads-api.x.com"' rel='"nofollow"'>Ads API Internal Test App</a>",
    "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": null,
    "retweet_count": 0,
    "favorite_count": 0,
    "favorited": false,
    "retweeted": false,
    "scopes": {
      "followers": false
    },
    "lang": "en"
  },
  "request": {
    "params": {
      "text": "hello, world",
      "trim_user": true,
      "as_user_id": 756201191646691328,
      "account_id": "18ce54d4x5t"
    }
  }
}

Actualiza el name del Tweet especificado que pertenece a la cuenta actual.

URL de recurso

https://ads-api.x.com/12/accounts/:account_id/tweets/:tweet_id/name

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio en todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
tweet_id required	Referencia al Tweet con el que se opera en la solicitud. Tipo: long Ejemplo: `994747471329873920`
name optional	El nombre del Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `Tweet with name`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tweets/994747471329873920/name?name=new Tweet name

Ejemplo de respuesta

{
  "request": {
    "params": {
      "tweet_id": 994747471329873920,
      "name": "new Tweet name",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
      "coordinates": null,
      "retweeted": false,
      "name": "new Tweet name",
      "conversation_settings": "EVERYONE",
      "source": "<a href="https://ads-api.x.com" rel="nofollow">Ads API Internal Test App</a>",
      "entities": {
        "hashtags": [],
        "symbols": [],
        "user_mentions": [],
        "urls": []
      },
      "display_text_range": [
        0,
        5
      ],
      "favorite_count": 0,
      "in_reply_to_status_id_str": null,
      "geo": null,
      "id_str": "994747471329873920",
      "scopes": {
        "followers": false
      },
      "in_reply_to_user_id": null,
      "truncated": false,
      "retweet_count": 0,
      "scheduled_status": null,
      "id": 994747471329873920,
      "in_reply_to_status_id": null,
      "nullcast": true,
      "created_at": "Wed Jan 01 00:00:00 +0000 2020",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "hello",
      "lang": "en",
      "contributors": null,
      "in_reply_to_screen_name": null,
      "in_reply_to_user_id_str": null,
      "user": {
        "utc_offset": null,
        "name": "Tushar Bhushan",
        "friends_count": 1065,
        "screen_name": "imit8me",
        "location": "San Francisco, CA",
        "protected": false,
        "url": "https://tushdante.github.io",
        "profile_image_url": "http://pbs.twimg.com/profile_images/618551153131786241/g-MIydXB_normal.jpg",
        "profile_background_color": "C0DEED",
        "profile_use_background_image": true,
        "is_translator": false,
        "geo_enabled": true,
        "description": "Open Sorcerer / Partner Engineer @twitter / Space Traveller | Former evangelist @sendgrid @keen_io",
        "profile_link_color": "1DA1F2",
        "id_str": "3271358660",
        "listed_count": 31,
        "default_profile_image": false,
        "followers_count": 407,
        "profile_image_url_https": "https://pbs.twimg.com/profile_images/618551153131786241/g-MIydXB_normal.jpg",
        "profile_sidebar_border_color": "C0DEED",
        "profile_background_image_url": "http://abs.twimg.com/images/themes/theme1/bg.png",
        "favourites_count": 5993,
        "following": null,
        "default_profile": true,
        "withheld_in_countries": [],
        "id": 3271358660,
        "profile_background_tile": false,
        "contributors_enabled": false,
        "follow_request_sent": null,
        "created_at": "Tue Jul 07 22:34:58 +0000 2015",
        "profile_sidebar_fill_color": "DDEEF6",
        "translator_type": "regular",
        "lang": null,
        "profile_text_color": "333333",
        "notifications": null,
        "verified": false,
        "time_zone": null,
        "profile_banner_url": "https://pbs.twimg.com/profile_banners/3271358660/1474853576",
        "statuses_count": 500,
        "profile_background_image_url_https": "https://abs.twimg.com/images/themes/theme1/bg.png",
        "is_translation_enabled": false
      },
      "tweet_id": "994747471329873920"
    }
}

Tarjetas de conversación en video

GET accounts/:account_id/cards/video_conversation

Obtiene detalles de algunas o todas las Video Conversation Cards asociadas a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation

Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_ids optional	Limita la respuesta solo a las video conversation cards deseadas, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID. Type: string Example: `5a86h`
count optional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información. Type: string Example: `8x7v00oow`
q optional	Una consulta opcional para limitar las cards por `name`. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: Esto realiza una coincidencia de prefijo que no distingue entre mayúsculas y minúsculas. Type: string Example: `night sky`
sort_by optional	Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información. Type: string Example: `created_at-asc`
with_deleted optional	Incluye los resultados eliminados en la solicitud. Type: boolean Default: `false` Possible values: `true`, `false`
with_total_count optional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyen `total_count` tendrán límites de tasa más bajos, actualmente fijados en 200 por cada 15 minutos. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?card_ids=5a86h

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_ids": [
        "5a86h"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "video conversation card",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Build it",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "id": "5a86h",
      "video_width": "16",
      "first_cta_tweet": "Ads API",
      "created_at": "2018-01-30T17:53:04Z",
      "card_uri": "card://958397665015775232",
      "title": "Developers",
      "updated_at": "2018-01-30T17:53:04Z",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "deleted": false,
      "card_type": "VIDEO_CONVERSATION"
    }
  ]
}

Recuperar una tarjeta de conversación de video específica asociada a la cuenta actual.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id

Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto para GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
card_id required	Una referencia a la video conversation card con la que estás trabajando en la solicitud. Type: string Example: `4i0ya`
with_deleted optional	Incluye resultados eliminados en tu solicitud. Type: boolean Default: `false` Possible values: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/5a86h

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_id": "5a86h",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "video conversation card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  }
}

POST accounts/:account_id/cards/video_conversation

Crea una nueva tarjeta de conversación en vídeo asociada a la cuenta especificada. Consulta Uploading Media para obtener información útil sobre cómo cargar archivos multimedia en nuestros endpoints.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
first_cta obligatorio	El hashtag del llamado a la acción (CTA) de la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Ejemplo: `#APIs`
first_cta_tweet obligatorio	El texto del Tweet que se usará al hacer clic en el primer CTA. Type: string Example: `Ads API`
media_key obligatorio	La media key de un video que se usará en esta tarjeta. Nota: El video debe estar en la Media Library de la cuenta. Nota: Se requiere una relación de aspecto de 16:9. Tipo: string Ejemplo: `13_1168079965037467209`
name obligatorio	El nombre de la tarjeta. Tipo: string Ejemplo: `video conversation card`
thank_you_text obligatorio	El texto que se mostrará cuando se haga clic en el CTA. Longitud máxima: 23 caracteres. Type: string Ejemplo: `Build it`
title a veces obligatorio	El título de la tarjeta, que aparece debajo del video y encima de las CTA. Longitud máxima: 23 caracteres. Type: string Nota: Obligatorio si `second_cta` `no` está establecido. Ejemplo: `Developers`
second_cta a veces requerido	El hashtag de llamado a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si `title` no está establecido. Ejemplo: `#ShareAgain`
second_cta_tweet a veces requerido	El texto del Tweet que se utilizará cuando se haga clic en el segundo CTA. Nota: Obligatorio si `second_cta` está establecido. Tipo: string Ejemplo: `I Heart @AdsAPI Again`
poster_media_key opcional	La media key de la imagen de portada que se utilizará en esta tarjeta. Si no se especifica, se usará el primer fotograma. Nota: El video debe estar en la Media Library de la cuenta. Tipo: long Ejemplo: `3_882726458191298561`
third_cta opcional	El hashtag de llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareMore`
third_cta_tweet a veces es obligatorio	El texto del Tweet que se utilizará cuando se haga clic en el tercer CTA. Type: string Nota: Obligatorio si se ha establecido `third_cta`. Example: `I Heart @TwitterDev`
fourth_cta opcional	El hashtag de llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareExtra`
fourth_cta_tweet a veces obligatorio	El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Tipo: string Nota: Obligatorio si `fourth_cta` está definido. Ejemplo: `I Heart @TwitterDev Again`
thank_you_url opcional	La URL que se mostrará junto al texto de agradecimiento. Type: string Example: `https://example.com/thankyou`
unlocked_image_media_key opcional	Una `media_key` de una imagen que se utilizará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la biblioteca de medios de la cuenta. Tipo: string Ejemplo: `3_883112887618682880`
unlocked_video_media_key opcional	El identificador de un vídeo del endpoint GET accounts/:account_id/media_library que se usará en el escenario de desbloqueo instantáneo. Tipo: string Ejemplo: `13_867520357225418752`

Ejemplo de solicitud

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation?first_cta=#APIs&first_cta_tweet=Ads API&name=video conversation card&thank_you_text=Build it&title=Developers&media_key=13_958388276489895936

Ejemplo de respuesta

{
  "data": {
    "name": "video conversation card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T17:53:04Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "video_poster_height": "9",
      "name": "video conversation card",
      "first_cta": "#APIs",
      "video_height": "9",
      "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
      "thank_you_text": "Build it",
      "video_owner_id": "756201191646691328",
      "media_key": "13_958388276489895936",
      "account_id": "18ce54d4x5t",
      "video_width": "16",
      "first_cta_tweet": "Ads API",
      "title": "Developers",
      "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
      "video_poster_width": "16",
      "card_type": "VIDEO_CONVERSATION"
    }
  }
}

Actualiza la tarjeta de conversación de vídeo especificada de la cuenta actual. Consulta Uploading Media para obtener información útil sobre cómo subir imágenes en nuestros endpoints.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, a excepción de GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Una referencia a la tarjeta de conversación de video con la que estás trabajando en la solicitud. Type: string Example: `5a86h`
first_cta opcional	El hashtag de llamado a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Ejemplo: `#APIs`
first_cta_tweet opcional	El texto del Tweet que se utilizará cuando se haga clic en el primer CTA. Type: string Example: `Ads API`
second_cta opcional	El hashtag de llamado a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Nota: Obligatorio si `title` `no` está definido. Ejemplo: `#ShareAgain`
second_cta_tweet opcional	El texto del Tweet que se utilizará cuando se haga clic en el segundo CTA. Nota: Obligatorio si `second_cta` está establecido. Tipo: string Ejemplo: `I Heart @AdsAPI Again`
third_cta opcional	El hashtag de llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareMore`
third_cta_tweet opcional	El texto del Tweet que se usará cuando se haga clic en el tercer CTA. Type: string Nota: Obligatorio si se establece `third_cta`. Ejemplo: `I Heart @TwitterDev`
fourth_cta opcional	El hashtag de llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Type: string Example: `#ShareExtra`
fourth_cta_tweet opcional	El texto del Tweet que se utilizará cuando se haga clic en la cuarta CTA. Type: string Nota: Obligatorio si `fourth_cta` está establecido. Ejemplo: `I Heart @TwitterDev Again`
media_key opcional	La media key de un video que se utilizará en esta tarjeta. Nota: El video debe estar en la Media Library de la cuenta. Nota: Se requiere una relación de aspecto de 16:9. Tipo: string Ejemplo: `13_1168079965037467209`
name opcional	El nombre de la tarjeta. type: string Ejemplo: `developers card`
poster_media_key opcional	La media key de una imagen de portada que se usará en esta tarjeta. Si no se especifica, se usará el primer fotograma. Nota: El video debe estar en la Media Library de la cuenta. Tipo: long Ejemplo: `3_882726458191298561`
thank_you_text opcional	El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Type: string Example: `Build it`
thank_you_url opcional	La URL que se mostrará junto con el texto de agradecimiento. Type: string Example: `https://example.com/thankyou`
title opcional	El título de la tarjeta, que aparece debajo del video y encima de los CTAs. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si `second_cta` no está establecido (`not`). Ejemplo: `Start a conversation`
unlocked_image_media_key opcional	Una `media_key` de una imagen que se usará en el escenario de desbloqueo instantáneo. Este campo es de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la biblioteca de medios de la cuenta. Tipo: string Ejemplo: `3_883112887618682880`
unlocked_video_media_key opcional	El identificador de un vídeo del endpoint GET accounts/:account_id/media_library que se utilizará en el escenario de desbloqueo instantáneo. Tipo: string Ejemplo: `13_867520357225418752`

Ejemplo de solicitud

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/5a86h?name=developers card

Ejemplo de respuesta

{
  "data": {
    "name": "developers card",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Build it",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "Ads API",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Developers",
    "updated_at": "2018-01-30T18:02:15Z",
    "poster_media_url": "https://pbs.twimg.com/amplify_video_thumb/958388276489895936/img/W-OL5rZ_MZ19A7Pa.jpg",
    "deleted": false,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "card_type": "VIDEO_CONVERSATION",
      "card_id": "5a86h",
      "name": "developers card"
    }
  }
}

Elimina de manera permanente la tarjeta de conversación en video especificada que pertenece a la cuenta actual. Nota: Se trata de una eliminación permanente. Como resultado, no es posible recuperar las tarjetas eliminadas.

URL del recurso

https://ads-api.x.com/12/accounts/:account_id/cards/video_conversation/:card_id

Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id required	Una referencia a la Video Conversation Card con la que se está operando en la solicitud. Tipo: string Ejemplo: `4i0ya`

Ejemplo de solicitud

DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/video_conversation/4i0ya

Respuesta de ejemplo

{
  "data": {
    "name": "video conversation card",
    "id": "4i0ya",
    "created_at": "2017-07-07T01:36:39Z",
    "updated_at": "2017-08-23T13:29:13Z",
    "deleted": true,
    "card_type": "VIDEO_CONVERSATION"
  },
  "request": {
    "params": {
      "card_id": "4i0ya",
      "card_type": "video_conversation",
      "account_id": "18ce54d4x5t"
    }
  }
}

​Descripción general

​Cards

​Imagen

​Video

​Video Promocionado

​Video promocionado en Tweets

​Video promocionado en Cards

​Información general

​Guías

​Tweets programados

​Introducción

​Endpoints de la API

​Gestión de Tweets programados

​Tweets promocionados programados

​Vista de Tweet programado

​Creación de Tweet programado:

​El Tweet programado se publica:

​Flujo de trabajo

​¿Qué sucede cuando un Tweet programado se publica?

​Mejores prácticas

​Biblioteca multimedia

​Introducción

​Endpoints de la API

​Agregar a la biblioteca

​Parámetros de la solicitud

​Atributos

​Uso

​Identificación de las Cards

​Introducción

​Identificación de Tweets con card_uri

​Identificar Tweets con preview_url

​Obtención de cards

​Identificar contenido multimedia

​Introducción

​Imágenes

​Videos

​Media Library

​Tweets

​Introducción

​Tweets nullcast

​Promocionar Tweets

​IDs de Tweet

​Carruseles

​Introducción

​Endpoints

​Cuerpo JSON POST

​Ejemplo

​etiquetado-de-metadatos-de-creatividades

​Introducción

​Etiquetado de recursos creativos

​¿Preguntas?

​Referencia de la API

​Contenido multimedia de la cuenta

​GET accounts/:account_id/account_media

​URL del recurso

​Parámetros

​Ejemplo de solicitud

​Ejemplo de respuesta

​URL del recurso

​Parámetros

​Ejemplo de solicitud

​Ejemplo de respuesta

​URL del recurso

​Parámetros

​Ejemplo de solicitud

​Ejemplo de respuesta

​Tarjetas

​URL del recurso

​Parámetros

​Ejemplo de solicitud

​Ejemplo de respuesta

​URL del recurso

​Parámetros

​Ejemplo de solicitud

​Ejemplo de respuesta

​POST accounts/:account_id/cards

​URL del recurso

​Parámetros

​Componentes

​Ejemplo de solicitud

Descripción general

Cards

Imagen

Video

Video Promocionado

Video promocionado en Tweets

Video promocionado en Cards

Información general

Guías

Tweets programados

Introducción

Endpoints de la API

Gestión de Tweets programados

Tweets promocionados programados

Vista de Tweet programado

Creación de Tweet programado:

El Tweet programado se publica:

Flujo de trabajo

¿Qué sucede cuando un Tweet programado se publica?

Mejores prácticas

Biblioteca multimedia

Introducción

Endpoints de la API

Agregar a la biblioteca

Parámetros de la solicitud

Atributos

Uso

Identificación de las Cards

Introducción

Identificación de Tweets con card_uri

Identificar Tweets con preview_url

Obtención de cards

Identificar contenido multimedia

Introducción

Imágenes

Videos

Media Library

Tweets

Introducción

Tweets nullcast

Promocionar Tweets

IDs de Tweet

Carruseles

Introducción

Endpoints

Cuerpo JSON POST

Ejemplo

etiquetado-de-metadatos-de-creatividades

Introducción

Etiquetado de recursos creativos

¿Preguntas?

Referencia de la API

Contenido multimedia de la cuenta

GET accounts/:account_id/account_media

URL del recurso

Parámetros

Ejemplo de solicitud

Ejemplo de respuesta

URL del recurso

Parámetros

Ejemplo de solicitud

Ejemplo de respuesta

URL del recurso

Parámetros

Ejemplo de solicitud

Ejemplo de respuesta

Tarjetas

URL del recurso

Parámetros

Ejemplo de solicitud

Ejemplo de respuesta

URL del recurso

Parámetros

Ejemplo de solicitud

Ejemplo de respuesta

POST accounts/:account_id/cards

URL del recurso

Parámetros

Componentes

Ejemplo de solicitud