Creativos

Descripción general

Los creativos son cualquier entidad que pueda promocionarse en una campaña. Los Posts 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 POST media/upload, un endpoint de carga simple que solo admite imágenes, o los endpoints POST media/upload (en fragmentos). Estos se pueden añadir a tarjetas:

POST accounts/:account_id/cards Tweets:
POST accounts/:account_id/tweets - Para añadir tarjetas a los Tweets, use el parámetro card_uri. Tweets programados:
POST accounts/:account_id/scheduled_tweets

Para obtener más detalles sobre las tarjetas, consulte la página Cards. La página Promoted Video proporciona detalles sobre cómo asociar videos con tarjetas o Tweets.

Tarjetas

La Ads API admite varios tipos de tarjetas que pueden utilizarse en Tweets, y 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 usados en Cards. Las imágenes deben tener un tamaño de 3 MB o menos y un ancho mínimo de 800 px. 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. Admitimos 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 del proceso para subir y promocionar videos mediante la Ads API. La Ads API admite video promocionado en Tweets y en las siguientes tarjetas:

Primero, sube el video usando el endpoint POST media/upload (chunked). Con el media_id, asocia el video a una cuenta de anuncios mediante el endpoint POST accounts/:account_id/videos. El id del video, a veces denominado media_key, se usará en solicitudes posteriores. Es una cadena que comienza con un entero, seguida de un guion bajo y que termina con un valor largo. Por ejemplo: 13_875943225764098048.

Video promocionado en Tweets

Para crear un Tweet, utiliza 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 una llamada a la acción (CTA). Estos valores son visibles para los usuarios.

Video promocionado en Cards

Las Video App Download y Video Conversation cards permiten agregar una imagen de póster. Sube una imagen para usarla en estas cards mediante el endpoint POST media/upload. Crea la card usando uno de los siguientes endpoints:

usando el id del video y, opcionalmente, el media_id de la imagen (para la imagen de póster). Por último, 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 subida de vídeos mediante la API, consulta la Guía de subida de vídeo. Los vídeos también pueden promocionarse como activos de pre-roll. Consulta la Guía del objetivo de visualizaciones de vídeo en pre-roll para una explicación detallada.

(A partir de 2015-10-22) Al subir vídeos para usar en contenido promocionado, el parámetro media_category debe establecerse con el valor amplify_video para todas las solicitudes del comando INIT al endpoint POST media/upload (chunked). Usar este 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 puede usarse para comprobar la finalización del procesamiento asíncrono tras la subida del vídeo.
La duración máxima actualmente permitida para vídeos promocionados es de 10 minutos con un tamaño de archivo de 500 MB o menos.
El vídeo subido debe ser mp4 o mov.
El vídeo subido generalmente se procesa rápido, pero los tiempos de procesamiento pueden variar según la duración del vídeo y el tamaño del archivo.
Las imágenes de póster subidas deben estar en formato png o jpg. No hay requisitos de relación de aspecto ni de tamaño, pero la imagen del póster se ajustará para adaptarse al reproductor de vídeo.

Guías

Tweets programados

Introducción

Los Tweets programados permiten a un anunciante o usuario crear un Tweet que puede programarse para publicarse en una fecha posterior. Además de crear y gestionar estos Tweets, la API permite asociarlos con un elemento de línea para promocionarlos una vez que el Tweet esté publicado. Esto permite a los anunciantes preparar Tweets nativos y planificar con antelación los creativos de sus campañas antes de cualquier iniciativa clave. Por ejemplo, preparar un creativo de Tweet para que se publique inmediatamente tras el anuncio de un nuevo producto. El conjunto completo de funcionalidades que proporcionan los endpoints de la API de Tweets programados se enumera a continuación:

Crear, modificar y ver nuevos Tweets programados
Asociar un Tweet programado con un elemento de línea
Consultar y gestionar Tweets programados existentes
Una vez que un Tweet programado esté publicado, recuperar el id del Tweet publicado

Puntos de conexión de la API

A continuación se muestra el conjunto completo de puntos de conexión relacionados con la funcionalidad mencionada:

Dado que los Scheduled Tweets son entidades separadas de los Tweets “en vivo”, se ejecutan dos conjuntos distintos 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 Scheduled Tweet, específicamente:

Creación de Tweet programado:

Valida que el usuario autenticado tenga acceso para crear Tweets orgánicos para un @handle dado. Los privilegios para crear Tweets “Promoted-Only” requieren que el usuario autenticado sea un usuario de la cuenta con permisos del compositor de Tweets.
Valida que no haya más de 30 Tweets programados para crearse dentro de una ventana de 15 minutos respecto a la hora scheduled_at. Un mensaje de error SCHEDULED_TWEET_LIMIT_EXCEEDED indica que se han programado demasiados Tweets dentro del mismo intervalo futuro de 15 minutos. Los anunciantes deberán eliminar un Tweet programado existente o mover la hora scheduled_at más temprano o más tarde.

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 a la vez una imagen y 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 requiere los siguientes parámetros: la hora scheduled_at, junto con el text del Tweet si el Tweet no incluye entidades multimedia. Además, este endpoint ofrece algunas opciones adicionales que le permiten crear un Tweet programado en nombre de otro @handle mediante el parámetro as_user_id, así como añadir una tarjeta (card_uri) y cualquier elemento multimedia (media_ids). Tenga en cuenta que un Tweet solo puede contener entidades del mismo tipo, es decir, video, GIF o imagen. El parámetro nullcast controla si el Tweet es “solo promocionado” o no. Todos los Tweets programados recién creados son “solo promocionados” (nullcast=true) de forma predeterminada. Si nullcast=false, entonces se crea un Tweet programado orgánico. Una vez creado correctamente un Tweet programado, la respuesta contendrá un campo id, que se refiere al identificador único del propio Tweet programado. Además de este campo, también se devuelve otro campo llamado tweet_id. Este campo es null inicialmente; sin embargo, una vez que el Tweet se publique, este campo se completará con el ID 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=¡Felices fiestas!'

Esto creará el siguiente Tweet programado:

{
  "request": {
    "params": {
      "text": "¡Felices Fiestas!",
      "scheduled_at": "2017-12-24T23:59:00Z"
    }
  },
  "data": {
    "completed_at": null,
    "id_str": "917507899668099072",
    "text": "¡Felices Fiestas!",
    "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 Luego se puede usar el endpoint GET accounts/:account_id/tweet_previews con el id del Tweet programado del paso anterior para generar una vista previa del Tweet. La respuesta de la API contendrá una URL de iframe lista para usar para renderizar una vista previa del Tweet programado. El CSS y las imágenes pertinentes se servirán directamente a través de 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'>"
    }
  ]
}

Se muestra arriba una vista de ejemplo del nuevo Scheduled Tweet creado Asociar un Scheduled Tweet con un line item Si bien los Scheduled Tweets pueden usarse para crear Organic Tweets, también permitimos que los socios creen un Tweet “Promoted-Only” (nullcast=true), cualquiera de los cuales puede asociarse con un line item. Para facilitar esto, también proporcionamos el endpoint POST accounts/:account_id/scheduled_promoted_tweets. Este endpoint solo permite asociar un único Promoted Scheduled Tweet a un line item en una sola llamada a la API. Para asociar varios Scheduled Tweets al mismo line item, se requieren varias llamadas a la API. Tenga en cuenta que no es posible modificar un Scheduled Promoted Tweet 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 Tweet Programado y un elemento de línea. Una vez que las fechas de vuelo de la campaña/elemento de línea sean actuales, el elemento de línea comenzará automáticamente a distribuir el Tweet “en vivo” correspondiente. Si bien en este paso validamos que el Tweet Programado esté en el estado SCHEDULED y que sea válido para el objetivo indicado, no se realizan otras validaciones. Cualquier regla de validación restante que aplique al elemento de línea y al Tweet Programado se ejecutará cuando el Tweet pase a “en vivo”. Para garantizar que no haya problemas con la entrega de la campaña, se recomienda que el Tweet Programado tenga el campo scheduled_at en un horario anterior a las fechas de vuelo de la campaña/elemento de línea. Por ejemplo, si el Tweet Programado está configurado para salir en vivo después de la fecha de inicio de la campaña (y solo hay un Tweet asociado a un único elemento de línea), la campaña estará ACTIVE; sin embargo, dado que el Tweet Programado aún no está en vivo, no habrá recursos creativos disponibles para su entrega. Gestión de Tweets Programados Los conjuntos restantes de endpoints permiten a los usuarios de la API gestionar todos sus Tweets Programados y Tweets Promocionados Programados. Estas API pueden usarse para devolver una lista de todos los Tweets Programados, opcionalmente filtrada por un estado determinado, así como para buscar un Tweet Programado 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 “activo”; sin embargo, esto puede tener 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 incluir una Imagen, un Video o un Gif, y no una combinación de los tres)
Asegúrate de que las fechas del período de la campaña (es decir, start_time y end_time) estén alineadas con la hora scheduled_at del Tweet programado
No programes Tweets para más de un año en el futuro (365 días)
Actualmente no hay vista previa disponible para los Tweets programados (es decir, la posibilidad de previsualizar Tweets programados antes de crearlos)

Biblioteca de medios

Introducción

Los endpoints de la Biblioteca de medios permiten gestionar imágenes, GIF y videos para cuentas de X Ads. Los recursos multimedia de la biblioteca se pueden usar en Tweets y para crear tarjetas. También se pueden reutilizar en múltiples creatives, eliminando la necesidad de cargar el mismo recurso varias veces.

Endpoints de la API

POST media/upload o POST media/upload (en fragmentos) (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 es un proceso en dos pasos. Primero, sube el recurso usando el endpoint POST media/upload o el conjunto de endpoints POST media/upload (chunked). Consulta la guía Carga de contenido multimedia en partes para obtener detalles sobre nuestro proceso de carga de varias partes.

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, con el id del contenido multimedia, agrega el contenido multimedia a la biblioteca 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 imágenes, GIF o videos directamente después de subirlos también añade ese contenido multimedia a la biblioteca.

Parámetros de la solicitud

Todas las solicitudes POST de Media Library requieren un identificador de medios. Este valor se devuelve durante la etapa de carga. Al usar 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 los valores name y file_name para objetos en la Media Library. Estos atributos ayudan a los usuarios a distinguir entre variantes de medios en la biblioteca. Para videos, también es posible establecer un título y una descripción. 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

La Media Library introduce formalmente el concepto de media_key. Este es el identificador único de los objetos en la biblioteca. Las media keys son valores de cadena con el siguiente formato: 13_875943225764098048. Están totalmente admitidas en todos nuestros endpoints de cards. Además, la respuesta de Media Library incluye el media_id, representado como una cadena. 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 GIF y videos. Puede usarse 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 utilizará 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 mediante 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
      }
   }
}

Tarjeta de sitio web Todos nuestros endpoints de tarjetas admiten media keys. Crearemos la tarjeta de sitio web haciendo referencia a la media_key de la imagen.

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

{
  "name": "crear tarjetas de componentes",
  "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"
      }
    }
  ]
}

Luego asociamos esta tarjeta a un Tweet mediante su card_uri.

Identificación de Cards

Introducción

Las Cards son formatos de anuncios personalizables que utilizan contenido multimedia y pueden asociarse a un sitio web, una App o a llamadas a la acción para impulsar determinadas interacciones de los usuarios, como iniciar un Mensaje Directo. Pueden añadirse a Tweets, Tweets programados o Tweets en borrador. Las Cards pueden referenciarse en objetos de Tweet de dos maneras: mediante la card_uri de la Card o mediante su preview_url. A continuación se presentan valores de ejemplo para cada una.

card_uri	preview_url
card://1043282691834048513	https://cards.x.com/cards/18ce54d4x5t/68w3s

Nota: A partir de la versión 3 del Ads API, solo se genera y devuelve la card_uri en la respuesta de cards para las Cards recién creadas. Nota: A partir de la versión 5 del Ads API, la preview_url en la respuesta de cards ya no se devuelve. El tipo de referencia en la respuesta del objeto Tweet dependerá de cómo se creó el Tweet. En otras palabras, si el Tweet se creó usando el parámetro de solicitud card_uri, el valor de la URI de la Card aparecerá en la respuesta. Si, por el contrario, la 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 tarjeta, busque la referencia a la tarjeta en el atributo de respuesta card_uri. El siguiente ejemplo de respuesta utiliza el endpoint GET accounts/:account_id/tweets.

$ 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": "App de Prueba Interna de la API de Anuncios",
      "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": "Rastreando una tarjeta",
      "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 API Standard, usa include_card_uri=true en la solicitud. Independientemente del endpoint utilizado, el atributo de respuesta card_uri solo se mostrará si el Tweet se creó mediante un card URI. Para los objetos de Tweet programados y en borrador, la respuesta siempre incluirá el atributo de respuesta card_uri.

Identificación de Tweets con preview_url

Para los Tweets creados al incluir la URL de vista previa como parte del texto del Tweet, la URL se encuentra en entities[“urls”][i][“expanded_url”] (el campo text incluye una URL abreviada de t.co), donde i es un índice de arreglo (un Tweet puede contener varias URL). En los objetos de Tweet programados y en borrador, la URL de vista previa siempre aparecerá en el campo text.

Obtención de cards

Para recuperar información adicional sobre una card específica, ofrecemos dos endpoints: GET accounts/:account_id/cards/all y GET accounts/:account_id/cards/all/:card_id. El primero permite obtener una card por card_uri y el segundo por el id de la card. El id de la card se encuentra al final del preview_url. En el ejemplo anterior, el id es 68w3s.

Identificación de contenido multimedia

Introducción

Se puede añadir contenido multimedia —imágenes, GIF y videos— a los Tweets y a las tarjetas. Además, los videos pueden usarse como recursos de pre-roll y las imágenes pueden promocionarse en la X Audience Platform. Esta sección describe cómo encontrar referencias de contenido multimedia en estas entidades. Hay dos tipos de identificadores de contenido multimedia: IDs y claves. A continuación se muestran valores de ejemplo para cada uno.

ID de contenido multimedia	Clave de contenido multimedia
1029825579531807971	13_1029825579531807971

La clave de contenido multimedia es el ID más un prefijo numérico y un guion bajo.

Imágenes

La siguiente tabla muestra los tipos de identificadores actualmente disponibles en la respuesta de cada recurso relacionado con imágenes, así como los nombres de atributo correspondientes.

Recurso	Identificador	Atributo(s)
Tarjetas de imagen	Ninguno
Tweet	Ambos	`entities["media"]["id_str"]` `entities["media"]["media_key"]`
Tweet programado	Ambos	`media_ids` y `media_keys`
Borrador de Tweet	Ambos	`media_ids` y `media_keys`
Medios de la cuenta	Ninguno
Biblioteca de medios	Ambos	`media_id` y `media_key`

Las tarjetas de imagen y las imágenes de Medios de la cuenta no incluyen ninguna referencia a identificadores de medios. Los Tweets solo incluyen ids de medios. Los Tweets programados y los borradores de Tweet incluyen tanto el id de medios como la clave de medios. La Biblioteca de medios también devuelve ambos. Para los Tweets, los campos id e id_str en el objeto dentro del array entities[“media”] corresponden al id de medios. En los casos en que un Tweet incluya varias imágenes, las referencias a cada entidad de medios solo se pueden encontrar en extended_entities[“media”]. Además de las referencias a identificadores, a menudo es importante tener acceso a la URL de la imagen.

Recurso	Atributo(s)	Formato
Tarjetas de imagen	`image`	.jpg
Tweet*	`entities["media"][0]["media_url"]` o `extended_entities["media"][i]["media_url"]`	.jpg
Tweet programado	Ninguno
Borrador de Tweet	Ninguno
Medios de la cuenta	`media_url`	.jpg
Biblioteca de medios	`media_url`	.jpg

*La ubicación de esta URL depende de si el Tweet contiene una sola imagen o varias imágenes. Todas las tarjetas de imagen incluyen un atributo de respuesta image que contiene la URL de la imagen de X. (Para las tarjetas de descarga de App de imagen, el nombre es wide_app_image). Para los Tweets, la ubicación de la URL del medio depende tanto del tipo de medio como del endpoint que se esté utilizando. Para los Tweets con una sola imagen, la URL se puede encontrar en entities[“media”][0][“media_url”]. Esto es válido tanto para el Ads API como para el Standard API. Sin embargo, cuando los Tweets contienen varias imágenes, las URL solo se pueden encontrar en extended_entities[“media”][i][“media_url”]. Esto solo está disponible en el Standard API.

Videos

La siguiente tabla muestra los tipos de identificadores disponibles actualmente en la respuesta de cada recurso relacionado con video, así como los nombres de atributo correspondientes.

Recurso	Identificador	Atributo(s)
Tarjetas de video	Puede ser cualquiera	`video_content_id`
Tarjetas de encuesta con video	Ninguno
Tweet	Ambos	`entities["media"]["id_str"]` `entities["media"]["media_key"]`
Tweet programado	Ambos	`media_ids` y `media_keys`
Borrador de Tweet	Ambos	`media_ids` y `media_keys`
Contenido multimedia de la cuenta	Media key	`video_id`
Biblioteca de contenido multimedia	Ambos	`media_id` y `media_key`

Si bien las tarjetas de video (con la excepción de las tarjetas de encuesta con video) incluyen un atributo de respuesta video_content_id, existe inconsistencia en el tipo de valor devuelto. En algunos casos, es un media ID; en otros, es una media key. A continuación se muestra información sobre cómo acceder a la URL del video.

Recurso	Atributo(s)	Formato
Tarjetas de video	`video_url` y `video_hls_url`	.vmap .m3u8
Tweet con video	`extended_entities["media"][i]["video_info"]["variants"][j]["url"]`	.mp4
Tweet programado	Ninguno
Borrador de Tweet	Ninguno
Contenido multimedia de la cuenta	Ninguno
Biblioteca de contenido multimedia	`media_url`	.mp4

Las tarjetas de video incluyen los atributos de respuesta video_url y video_hls_url con URLs .vmap y .m3u8, respectivamente.

Biblioteca de medios

A veces es necesario obtener información adicional sobre un recurso multimedia. Un caso de uso, para tarjetas de video, es recuperar la URL mp4 en lugar de la vmap. Esto está disponible en la Biblioteca de medios. Para conocer los detalles sobre la información disponible, consulta nuestra Guía de la Biblioteca de medios. La mayoría de los recursos que pertenecen al usuario PROMOCIONABLE COMPLETO de la cuenta de anuncios se pueden encontrar en la biblioteca. No obstante, hay algunas excepciones. Obtención de medios Como se indicó anteriormente, las tarjetas de imagen no contienen referencias ni a media IDs ni a media keys. Por lo tanto, no es posible obtener sus recursos a través de la Biblioteca de medios. Esto también aplica a las imágenes de Account Media. Las tarjetas de video requieren que el recurso de video forme parte de la Biblioteca de medios (o del recurso Videos anterior) antes de crearlas. Por lo tanto, estos recursos siempre serán recuperables en la Biblioteca de medios. Esto también aplica a los recursos PREROLL de Account Media. Por último, los medios en los Tweets siempre están garantizados en la Biblioteca de medios. La siguiente tabla resume qué recursos son recuperables en la Biblioteca de medios, teniendo en cuenta si la respuesta del recurso incluye un identificador para usar en la búsqueda.

Recurso	En la Biblioteca de medios
Tarjetas de imagen	No
Tarjetas de video	Sí*
Tweets (cualquier medio)**	Sí
Tweets programados	Sí
Tweets en borrador	Sí
Imágenes de Account Media	No
Videos de Account Media (`PREROLL`)	Sí

Para tarjetas en las que video_content_id es una media key. Cuando el valor es un media ID, el recurso sigue existiendo en la Biblioteca de medios, pero recuperarlo implica anteponerle un prefijo numérico y un guion bajo. ** Los Tweets solo devuelven media IDs. Si bien el recurso está garantizado en la Biblioteca de medios, obtenerlo implica anteponerle un prefijo numérico y un guion bajo.

Interacciones con Account Media Hay dos casos en los que los recursos multimedia agregados a la biblioteca se añaden automáticamente al recurso Account Media.

Cuando se agrega un recurso AMPLIFY_VIDEO a la Biblioteca de medios, se añade automáticamente como un recurso de Account Media con el tipo creativo PREROLL.
Cuando se añaden a la Biblioteca de medios 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 tipo creativo (p. ej., INTERSTITIAL) depende de las dimensiones de la imagen.

Tweets

Introducción

La X Ads API admite tres tipos de Tweets: publicados, programados y borradores.

Tweets nullcasted

Los Tweets pueden ser nullcasted (también llamados «solo promocionados») u orgánicos. Los Tweets nullcasted, una vez publicados, no aparecen en la cronología pública del usuario, aunque son públicos. Los Tweets orgánicos, por otro lado, 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 nullcasted u orgánicos. Los Tweets nullcasted pueden ser creados por el usuario o por cualquier persona que tenga permiso para crear Tweets en su nombre. Los Tweets orgánicos solo pueden ser creados por el full promotable user. Actualización de Tweets Es posible actualizar la propiedad nullcast para Tweets programados y borradores. En el caso de los Tweets programados, se pueden realizar ediciones hasta la hora scheduled_at del Tweet. Los Tweets en borrador se pueden editar indefinidamente. Sin embargo, una vez publicados, no es posible cambiar un Tweet de nullcasted a orgánico o viceversa.

Promocionar Tweets

Solo se pueden promocionar Tweets publicados y programados. Estos pueden ser nullcast u orgánicos; no hay restricciones. Un anunciante puede promocionar sus propios Tweets o los de otro usuario, siempre que haya obtenido permiso para hacerlo. (Consulta: Promocionar los Tweets de otro usuario para obtener más información). Se pueden 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 Tweets publicados con un line item. Para promocionar Tweets programados, usa el endpoint POST accounts/:account_id/scheduled_promoted_tweets.

IDs de Tweet

Los IDs de Tweets publicados, programados y en borrador son numéricos: son 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 la entidad correspondiente de Tweet promocionado. 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 line item 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 del Tweet y el ID del elemento de línea, que se enviaron en la solicitud de creación, la respuesta incluye un campo id con el valor 3qw1q6, que corresponde al ID del Tweet promocionado.

Carruseles

Introducción

La X Ads API admite la creación y recuperación de carruseles de video e imagen. El carrusel es un tipo de tarjeta que puede contener entre 2 y 6 recursos multimedia. La tarjeta de carrusel puede dirigir a un usuario a un sitio web o invitarlo a instalar una App móvil. Para obtener más información sobre los carruseles, sus beneficios, mejores prácticas y preguntas frecuentes, consulta nuestra página Carousel Ads on X. Un carrusel, como cualquier otro tipo de tarjeta, puede usarse en Tweets y esos Tweets luego pueden promocionarse. El flujo de trabajo es el mismo al que ya estás acostumbrado:

Subir multimedia
Crear la tarjeta
Crear el Tweet
Promocionar el Tweet

La única diferencia está en cómo se crea la tarjeta. Mientras que otras solicitudes de creación de tarjetas aceptan parámetros de consulta, las solicitudes de creación de tarjetas de carrusel solo aceptan cuerpos de POST en JSON.

Endpoints

La Ads API permite crear y obtener 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 de la solicitud JSON (POST)

Los carruseles se crean con dos componentes. El primero especifica los recursos multimedia que se utilizarán. El segundo especifica información sobre el sitio web o la App. Específicamente, una tarjeta de carrusel se crea usando los siguientes componentes, en este orden:

Un componente SWIPEABLE_MEDIA, que acepta un array de claves de medios
Uno de los siguientes:
Un componente DETAILS para especificar información del sitio web
Un componente BUTTON para especificar información de la App

El componente SWIPEABLE_MEDIA debe incluir un array media_keys, donde puedes especificar entre 2 y 6 imágenes o videos. El orden en que se pasan las claves de medios determina el orden en que se representarán.

{
  "type": "SWIPEABLE_MEDIA",
  "media_keys": [
    "13_1089771253848666112",
    "13_1191948012077092867"
  ]
}

Como recordatorio, puedes obtener claves de medios haciendo una solicitud al endpoint GET accounts/:account_id/media_library. La composición del segundo objeto del componente depende de si deseas dirigir al usuario a un sitio web o incentivar la instalación de una App. La siguiente tabla resume ambas opciones. (Nota: todas las claves listadas son obligatorias).

	Sitio web	App
Especificar el tipo de componente	`"type": "DETAILS"`	`"type": "BUTTON"`
Título/Etiqueta	`"title": "X"`	`"label": { "type": "ENUM", "value": "INSTALL" }`
Destino	`"destination": { "type": "WEBSITE", "url": "https://www.x.com" }`	`"destination": { "type": "APP", ... }`

Con todo esto, a continuación se muestra un ejemplo del cuerpo JSON para un POST de carrusel de sitio web.

{
  "name": "carrusel de sitio web",
  "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 enlaces profundos (deep links). Para una descripción de estos fields, consulta la documentación de referencia. Con todo esto, a continuación se muestra un ejemplo del cuerpo JSON para una solicitud POST de carrusel de App.

{
  "name": "carrusel de App",
  "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 tarjeta de carrusel de sitio web con video y cómo usarla en un Tweet. Como se mencionó arriba, el flujo de trabajo es el mismo al que ya estás acostumbrado: cargar medios, crear la tarjeta, crear el Tweet. La única diferencia es cómo se crea la tarjeta. Medios Para empezar, carga nuevos recursos multimedia o utiliza los existentes. Para obtener detalles sobre cómo cargar nuevos recursos multimedia y agregarlos a la Biblioteca de medios, consulta nuestra Guía de la Biblioteca de medios. Una vez que tus recursos multimedia estén en la Biblioteca de medios, recupéralos mediante el endpoint GET accounts/:account_id/media_library. Usa el parámetro de solicitud media_type para acotar los resultados a un tipo de medio 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 Usa el endpoint POST accounts/:account_id/cards para crear tu carrusel. Usa las claves de medios de la solicitud anterior. Recuerda que el orden en que se envían las claves de medios determina el orden en que se representan.

$ 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": "carrusel web",
    "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 tarjetas, la respuesta de la tarjeta de carrusel incluye un card_uri, que se utilizará al crear un Tweet. Tweet Usa el endpoint POST accounts/:account_id/tweet para crear tu Tweet. Usa el card_uri de la solicitud anterior. (Respuesta truncada para mejorar la 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 Tweet Usa el endpoint GET accounts/:account_id/tweet_previews para ver tu Tweet.

etiquetado-de-metadatos-de-creativos

Introducción

Esta guía está dirigida a socios creativos, agencias y desarrolladores creativos para etiquetar los recursos utilizados en campañas de X y comprender mejor el valor y el rendimiento de cada recurso. Nota: Los recursos multimedia solo deben etiquetarse por el socio o desarrollador que los crea. Si el usuario del recurso multimedia no lo creó, no implemente el etiquetado de metadatos. El Etiquetado de Metadatos Creativos atribuye 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 establecer 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 los nombres de atributos correspondientes. Se necesita una herramienta de etiquetado para marcar 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 archivo compatibles. Sigue las instrucciones para instalar ExifTool. También hay paquetes de software ofrecidos por Homebrew que simplifican la instalación proporcionando el comando de instalación de exiftool para macOS y Linux. Verifica que la herramienta esté correctamente instalada ejecutando exiftool -ver en la línea de comandos para obtener el número de versión. Obtén más información sobre los parámetros 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 X app_id en la etiqueta XMP contributor y la etiqueta date. Los recursos creativos cumplirán las restricciones de tamaño existentes al cargar contenido multimedia. Nota: El uso por parte de 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 El app_id se puede encontrar en el Portal de desarrolladores 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

Verifica que tu imagen esté correctamente etiquetada: exiftool -xmp:all -G1 <filename> Ejemplo: exiftool -xmp:all -G1 eiffel_tower.jpg

[XMP]        XMP Toolkit            : Image::ExifTool 12.30

[XMP]        Contributor            : 858382169

[XMP]        Fecha                  : 2022:03:13

¿Preguntas?

Si desea confirmar que su etiquetado y atribución se realizaron correctamente, envíe activos de ejemplo con etiquetas a adsapi-program@x.com para que un representante de X los revise.

Referencia de API

Contenido multimedia de la cuenta

GET accounts/:account_id/account_media

Recupera los detalles de algunos o todos los archivos multimedia de la cuenta asociados con la cuenta actual.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
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 IDs. Tipo: string Ejemplo: `3wpx`
count opcional	Especifica la cantidad de registros que se intentará recuperar por solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
creative_types opcional	Limita la respuesta a los medios de la cuenta que coincidan con los tipos creativos especificados. Se puede indicar más de un tipo creativo separando por comas los valores del enum. Tipo: enum Valores posibles: `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 Pagination para más información. Tipo: string Ejemplo: `8x7v00oow`
sort_by opcional	Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye los resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de frecuencia más bajos, actualmente establecidos en 200 por cada 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `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
    }
  ]
}

Recupera un objeto de medios 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 en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
account_media_id obligatorio	Una referencia al medio de cuenta con el que se opera en la solicitud. Tipo: string Ejemplo: `2pnfd`
with_deleted opcional	Incluye 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 multimedia de la 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 obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
account_media_id obligatorio	Una referencia al recurso 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, usa 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 detalles de algunas o de todas las tarjetas asociadas a la cuenta actual. Nota: Esto solo devuelve tarjetas creadas con 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

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_types opcional	Restringe la respuesta a los tipos de tarjeta deseados especificando una lista separada por comas de valores de enum. Tipo: enum Valores posibles: `IMAGE_APP`, `IMAGE_CAROUSEL_APP`, `IMAGE_CAROUSEL_WEBSITE`, `IMAGE_MULTI_DEST_CAROUSEL_WEBSITE`, `IMAGE_WEBSITE`, `MIXED_MEDIA_MULTI_DEST_CAROUSEL_WEBSITE`, `MIXED_MEDIA_SINGLE_DEST_CAROUSEL_APP`, `MIXED_MEDIA_SINGLE_DEST_CAROUSEL_WEBSITE`, `VIDEO_APP`, `VIDEO_CAROUSEL_APP`, `VIDEO_CAROUSEL_WEBSITE`, `VIDEO_MULTI_DEST_CAROUSEL_WEBSITE`, `VIDEO_WEBSITE`
card_id opcional	Restringe la respuesta a las tarjetas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id de tarjeta. Tipo: string Ejemplo: `1044294149527166979,1044301099031658496`
card_uris opcional	Restringe la respuesta a las tarjetas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 valores de URI de tarjeta. Tipo: string Ejemplo: `card://1044294149527166979,card://1044301099031658496`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `100` Mín., máx.: `1`, `200`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
include_legacy_cards opcional	Incluye tarjetas de sitio web y de App heredadas en la respuesta. Las tarjetas heredadas son aquellas cuyo URL de recurso tiene el siguiente formato: accounts/:account_id/cards/:card_type. Consulta esta publicación del foro de desarrolladores para obtener más contexto. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
q opcional	Consulta opcional para filtrar tarjetas por `name`. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: realiza coincidencia de prefijo sin distinguir mayúsculas de minúsculas. Tipo: string Ejemplo: `dtc`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

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

Recupera 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 obligatorio	Identificador de la cuenta apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	id de las cards. Tipo: string Ejemplo: `1044294149527166979`
with_deleted opcional	Incluye 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/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 con la cuenta especificada. Las solicitudes para crear tarjetas solo aceptan cuerpos de solicitud 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 del POST debe incluir un name de la tarjeta y un arreglo de components. Los componentes se representan como objetos y describen los atributos de la tarjeta orientados al anunciante. El siguiente ejemplo muestra la estructura general del payload (pero incluye información que no es funcional).

{
  "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 en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
name required	El nombre de la tarjeta. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `component based card`
components sometimes required	Describe los componentes que se usarán para crear la tarjeta. Información adicional a continuación. No se puede especificar junto con `slides`. Nota: El orden de los componentes es importante. Tipo: array of objects
slides sometimes required	Usa este array of arrays para crear carruseles de múltiples destinos. Describe cada tarjeta como un conjunto de componentes. Cada slide debe ser una representación completa de una tarjeta. No se puede especificar junto con `components`. Nota: El orden de cada slide es importante. Tipo: array of arrays

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: video o imagen individual
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.

`type` del componente	Campo	Tipo de valor
`MEDIA`	`media_key`	string
`SWIPEABLE_MEDIA`	`media_keys`	array of strings
`DETAILS`	`title` `destination`	string object
`BUTTON`	`label` `destination`	object object

A continuación se muestra un ejemplo de un componente BUTTON en el contexto del arreglo components (omitiendo intencionalmente la clave name). (Los puntos suspensivos indican lugares donde sería necesario especificar más información.)

{
  "components": [
    {
      "type": "BUTTON",
      "label": {
        ...
      },
      "destination": {
        ...
      }
    }
  ]
}

El orden en que se especifican los objetos de componente define el orden de arriba hacia abajo en que se representarán. Las tarjetas deben crearse usando un componente basado en medios y, además, un componente DETAILS o BUTTON. Los componentes basados en descripción se renderizan debajo del contenido multimedia y tienen destinos asociados, ya sean URL o apps móviles. Etiqueta Las etiquetas definen el texto que se muestra en los botones y, por lo tanto, solo aplican al componente BUTTON. Los objetos de etiqueta tienen dos claves obligatorias: type y value. El type debe establecerse en ENUM y el value puede ser uno de: BOOK, CONNECT, INSTALL, OPEN, ORDER, PLAY o SHOP. Basándose en 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 donde 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 pueden usarse con componentes DETAILS y los destinos de app solo pueden usarse con componentes BUTTON. Destino de sitio web

Nombre	Descripción
type required	El tipo de destino, que determina su esquema. Tipo: enum Valores posibles: `WEBSITE`
url required	La URL del sitio web a la que se redirigirá al usuario. Tipo: string Ejemplo: `https://devcommunity.x.com/c/advertiser-api`

Destino de App

Nombre	Descripción
type required	El tipo de destino, que determina su esquema. Tipo: enum Valores posibles: `APP`
country_code required	El código de dos letras ISO 3166-1 alfa-2 del país donde se comercializa la app. Tipo: string Ejemplo: `US`
googleplay_app_id sometimes required	El nombre del paquete de la aplicación en Google Play. Nota: Se requiere al menos uno de los siguientes: `ios_app_store_identifier` o `googleplay_app_id`. Tipo: string Ejemplo: `com.twitter.android`
ios_app_store_identifier sometimes required	El identificador de la App Store de iOS. Nota: Se requiere al menos uno de los siguientes: `ios_app_store_identifier` o `googleplay_app_id`. Tipo: string Ejemplo: `333903271`
googleplay_deep_link optional	Un deep link dentro de la app de Android que estás promocionando. Nota: Solo puede usarse si se ha proporcionado un `googleplay_app_id`. Tipo: string
ios_deep_link optional	Un deep link dentro de la app de iOS que estás promocionando. Nota: Solo puede usarse si se ha proporcionado un `ios_app_store_identifier`. Tipo: string

Ejemplo de solicitud

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

{
  "name": "componentes crear tarjetas",
  "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": "crear tarjetas de componentes",
    "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 el elemento especificado asociado a la cuenta actual. Las solicitudes de edición de tarjetas solo aceptan cuerpos de solicitud 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 actualizarán. La solicitud reemplazará cada campo con los parámetros especificados en el payload. Los componentes se representan como objetos y describen los atributos de la tarjeta de cara al anunciante. El siguiente ejemplo muestra la estructura general del payload (pero incluye información no funcional).

{
  "name": "algún nombre",
  "components": [
    {
      "type": "TYPE_ENUM",
      "clave": "valor"
    }
  ]
}

Información adicional sobre componentes y diapositivas en POST accounts/:account_id/cards.

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
name optional	El nombre de la tarjeta. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `component based card`
components optional	Describe los componentes que se usarán para actualizar la tarjeta. Información adicional a continuación. No se puede especificar junto con `slides`. Nota: el orden de los componentes es importante. Tipo: array of objects
slides optional	Use este array de arrays para actualizar los carruseles de destinos múltiples (Multi-Destination Carousels). Describe cada tarjeta como un conjunto de componentes. Cada diapositiva debe ser una representación completa de una tarjeta. No se puede especificar junto con `components`. Nota: el orden de cada diapositiva es importante. Tipo: array of arrays

Ejemplo de solicitud

Este ejemplo actualiza el nombre y, además, elimina una de las media_keys del campo components del ejemplo anterior. PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/cards/1321554298900107264

{
  "name": "nombre modificado",
  "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 que pertenece 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 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 X Ads 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 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, por card_uri, asociadas a la cuenta actual.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id requerido	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_uris requerido	Limita la respuesta a las tarjetas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 valores de URI de tarjeta. Tipo: string Ejemplo: `card://1044294149527166979,card://1044301099031658496`
with_deleted opcional	Incluye resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_uris": [
        "card://1044294149527166979",
        "card://1044301099031658496"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    {
      "name": "App de X",
      "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": "Plataforma de Desarrolladores",
      "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": "Plataforma de Desarrolladores",
      "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"
    }
  ]
}

Recupera una tarjeta específica, mediante 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	Identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Referencia a la card con la que 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": "tarjeta de video para sitio web",
    "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

Recupera los detalles de algunos o todos los Draft Tweets asociados a la cuenta actual.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id 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`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `100` Mín., máx.: `1`, `200`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `c-jh1g0ryb`
user_id opcional	Especifica el usuario para el que se recuperarán los Draft Tweets. De forma predeterminada, usa el usuario promocionable `FULL` de la cuenta cuando no se especifica. Tipo: string Ejemplo: `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": "hola, mundo",
      "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 Ads API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
draft_tweet_id obligatorio	Una referencia al Draft Tweet con el que opera 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 Tweet en borrador para el usuario totalmente promocionable de la cuenta (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	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`
as_user_id obligatorio	El ID de usuario del anunciante en cuyo nombre publicas el Tweet. El anunciante debe otorgar acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso te permite invocar la API usando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: string Ejemplo: `756201191646691328`
text a veces obligatorio	El texto de tu actualización de estado. Obligatorio si no se especifica `media_keys`. Tipo: string Ejemplo: `Just setting up my X.`
card_uri opcional	Asocia una Card con el Tweet usando el valor `card_uri` de cualquier respuesta de cards, si está disponible. Tipo: string Ejemplo: `card://960880280705392541`
media_keys opcional	Asocia multimedia con el Tweet especificando una lista de identificadores separada por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Tipo: string Ejemplo: `13_1153584529292270722`
nullcast opcional	Indica si se debe crear un Tweet nullcasted (o “Promoted-only”). Tipo: boolean Predeterminado: `true` Valores posibles: `true`, `false`
name opcional	El nombre del Draft 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": "Configurando mi X.",
      "as_user_id": "756201191646691328"
    }
  },
  "data": {
    "name": null,
    "text": "Configurando mi 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 Draft 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 realiza la solicitud. Tipo: string Ejemplo: `994747471329873920`
card_uri opcional	Asocia una card con el Tweet usando el valor `card_uri` de cualquier respuesta de cards, si está disponible. Nota: Para desasignar (eliminar), especifique el parámetro sin valor. Tipo: string Ejemplo: `card://970582057284129151`
media_keys opcional	Asocia contenido multimedia con el Tweet especificando una lista de identificadores separada por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Nota: Para desasignar (eliminar), especifique el parámetro sin 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 la 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": "solo configurando mi twttr"
    }
  },
  "data": {
    "name": null,
    "text": "solo configurando mi 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": []
  }
}

Elimina de forma permanente el Draft Tweet especificado perteneciente a la cuenta actual. Nota: Recomendamos encarecidamente eliminar los borradores una vez que se haya creado un Tweet o un Tweet programado utilizando su metadata. Nota: Esta es una eliminación definitiva. Por lo tanto, no es posible recuperar los Draft Tweets 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 asociada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
draft_tweet_id obligatorio	Una referencia al Draft Tweet con el que se opera 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": "hola, mundo",
    "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

Vista previa de un Draft Tweet en un dispositivo móvil. Una solicitud correcta envía una notificación a cada dispositivo en el que el usuario autenticado haya iniciado sesión. Al hacer clic en la notificación, se abre una línea del tiempo que permite al usuario ver e interactuar con el Draft Tweet, y probar la reproducción automática, el volumen, la pantalla completa, el acoplamiento de la video website card 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 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 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": "Consulta las notificaciones de @apimctestface en la app de X para previsualizar tu Tweet."
}

Tarjetas de conversación con imagen

Nota: Para asociar una tarjeta a un Tweet, utiliza el parámetro card_uri con cualquiera de los endpoints POST accounts/:account_id/tweet, POST statuses/update o POST accounts/:account_id/scheduled_tweets.

GET accounts/:account_id/cards/image_conversation

Recupera los detalles de algunas o todas las tarjetas de conversación con 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	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_ids opcional	Limita la respuesta únicamente a las image conversation cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `59woh`
count opcional	Especifica la cantidad de registros a intentar recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la página siguiente de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
q opcional	Consulta opcional para limitar las cards por `name`. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: realiza una coincidencia por prefijo que no distingue mayúsculas/minúsculas. Tipo: string Ejemplo: `night`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: este parámetro y `cursor` son mutuamente excluyentes. Nota: las solicitudes que incluyen `total_count` tendrán límites de frecuencia más bajos, actualmente fijados en 200 por 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Recupera 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 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	Referencia a la image conversation card con la que se opera en la solicitud. Tipo: string Ejemplo: `59woh`
with_deleted opcional	Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "image_conversation",
      "card_id": "59woh",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "tarjeta de conversación con imagen",
    "first_cta": "#moon",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "gracias",
    "id": "59woh",
    "first_cta_tweet": "estrellas",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Luna llena",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  }
}

POST accounts/:account_id/cards/image_conversation

Cree una nueva tarjeta de conversación con imagen asociada a la cuenta especificada. Consulte 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

Parámetros

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

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "data": {
    "name": "tarjeta de conversación de imagen",
    "first_cta": "#moon",
    "image_display_height": "670",
    "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
    "thank_you_text": "gracias",
    "id": "59woh",
    "first_cta_tweet": "estrellas",
    "media_key": "3_957113581522141184",
    "created_at": "2018-01-27T04:58:42Z",
    "image_display_width": "1280",
    "card_uri": "card://923498485702009837",
    "title": "Luna llena",
    "updated_at": "2018-01-27T04:58:42Z",
    "deleted": false,
    "card_type": "IMAGE_CONVERSATION"
  },
  "request": {
    "params": {
      "name": "tarjeta de conversación de imagen",
      "first_cta": "#moon",
      "image_display_height": "670",
      "media_url": "https://pbs.twimg.com/media/DUhZuzxUQAAWZqr.jpg",
      "thank_you_text": "gracias",
      "media_key": "3_957113581522141184",
      "account_id": "18ce54d4x5t",
      "first_cta_tweet": "estrellas",
      "image_display_width": "1280",
      "title": "Luna llena",
      "card_type": "IMAGE_CONVERSATION"
    }
  }
}

Actualiza la tarjeta de conversación con imagen especificada que pertenece a la cuenta actual. Consulta Uploading Media para obtener información útil sobre cómo cargar imágenes en nuestros endpoints.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Referencia a la tarjeta de conversación con imagen con la que opera la solicitud. Tipo: string Ejemplo: `4i0qg`
first_cta opcional	El hashtag de la llamada a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: `#ShareNow`
first_cta_tweet opcional	El texto del Tweet que se usará cuando se haga clic en el primer CTA. Tipo: string Ejemplo: `I Heart @AdsAPI`
second_cta opcional	El hashtag de la llamada a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Nota: Obligatorio si `title` no está establecido. Ejemplo: `#ShareAgain`
second_cta_tweet opcional	El texto del Tweet que se usará cuando se haga clic en el segundo CTA. Nota: Obligatorio si `second_cta` está establecido. Tipo: string Ejemplo: `I Heart @AdsAPI Again`
third_cta opcional	El hashtag de la llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: `#ShareMore`
third_cta_tweet opcional	El texto del Tweet que se usará cuando se haga clic en el tercer CTA. Tipo: string Nota: Obligatorio si `third_cta` está establecido. Ejemplo: `I Heart @TwitterDev`
fourth_cta opcional	El hashtag de la llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: string Ejemplo: `#ShareExtra`
fourth_cta_tweet opcional	El texto del Tweet que se usará cuando se haga clic en el cuarto CTA. Tipo: string Nota: Obligatorio si `fourth_cta` está establecido. Ejemplo: `I Heart @TwitterDev Again`
media_key opcional	La clave de medios 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 800 px y una relación de aspecto ancho:alto de 1.91:1. Tipo: string Ejemplo: `3_1151345051104991073`
name opcional	El nombre de la tarjeta. Tipo: string Ejemplo: `moon card`
thank_you_text opcional	El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: string Ejemplo: `Thank you`
thank_you_url opcional	La URL que se mostrará con el texto de agradecimiento. Tipo: string Ejemplo: `https://example.com/thankyou`
title opcional	El título de la tarjeta, que aparece debajo de la imagen y encima de los CTA. Longitud máxima: 23 caracteres. Tipo: string Nota: Obligatorio si `second_cta` no está establecido. Ejemplo: `Start a conversation`
unlocked_image_media_key opcional	Un `media_key` de una imagen que se usará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen. Nota: La imagen debe estar en la biblioteca de medios de la cuenta. Nota: Se requiere un ancho mínimo de 800 px y una relación de aspecto ancho:alto de 5:2. Tipo: string Ejemplo: `3_883112887618682880`

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 de imagen especificada que pertenece a la cuenta actual. Nota: Esta es una eliminación permanente. Por lo tanto, 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 de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Referencia a la Image Conversation Card con la que se opera en la solicitud. Tipo: string Ejemplo: `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 multimedia

GET accounts/:account_id/media_library

Recupera los detalles de algunos o de 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 obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Tipo: int Predeterminado: `20` Mín., máx.: `1`, `50`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `c-1`
media_type opcional	Limita la respuesta únicamente al tipo de medio deseado. Tipo: enum Valores posibles: `GIF`, `IMAGE`, `VIDEO`
q opcional	Consulta opcional para acotar el recurso por los campos `name`, `title`, `file_name` y `description`. Nota: realiza una coincidencia de términos sin distinguir mayúsculas y minúsculas. Tipo: string Longitud mín., máx.: `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"
}

Recupera 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 en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
media_key obligatorio	Una referencia al objeto de la biblioteca multimedia con el que se opera 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 más detalles, consulta nuestra guía de la Media Library. Nota: Al agregar un video con la categoría de medios AMPLIFY_VIDEO a la Media Library, este pasa a estar disponible automáticamente como un recurso PREROLL de account_media.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
media_key obligatorio	El `media_key` del contenido subido. Se devuelve un `media_key` en la respuesta de POST media/upload cuando se especifica un `media_category`. Tipo: string Ejemplo: `3_931236738554519552`
description opcional	La descripción que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 200 caracteres. Esto no se muestra en el Tweet de forma predeterminada. Para mostrar la `description` del video, use el parámetro `video_description` con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Tipo: string Ejemplo: `Esta es la descripción debajo del video.`
file_name opcional	El nombre de archivo del objeto de la biblioteca de medios. Longitud máxima: 255. El nombre de archivo se puede ver en el detalle de medios de cada recurso en la interfaz de Media Library en ads.x.com. Este campo estará vacío cuando no se establezca `file_name`. Tipo: string Ejemplo: `coffee.jpeg`
name opcional	El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta debajo de cada recurso en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando no se establezca `name`. Tipo: string Ejemplo: `Latte`
poster_media_key opcional	Especifique una imagen de póster para el video usando el `media_key` de una imagen subida. Si no se especifica, se usará el primer fotograma. Nota: Solo se puede usar con videos. Tipo: string Ejemplo: `3_890599134483242005`
title opcional	El título (encabezado) que aparece debajo del video cuando se publica como Tweet. Longitud máxima: 70 caracteres. Esto no se muestra en el Tweet de forma predeterminada. Para mostrar el `title` del video, use el parámetro `video_title` con el endpoint POST accounts/:account_id/tweet. Nota: Solo se puede usar con videos. Tipo: string Ejemplo: `Título del video`

Ejemplo de solicitud

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

Ejemplo de respuesta

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

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`
media_key obligatorio	Una referencia al objeto de la biblioteca de medios con el que se opera en la solicitud. Tipo: string Ejemplo: `16_844800354743074820`
description opcional	La descripción que aparece debajo del video cuando se publica como un Post. Longitud máxima: 200 caracteres. Esto no se muestra en el Post de forma predeterminada. Para mostrar la `description` del video, usa el parámetro `video_description` con el endpoint POST accounts/:account_id/tweet. Nota: Solo puede usarse con videos. Tipo: string Ejemplo: `Esta es la descripción debajo del video.`
file_name opcional	El nombre de archivo del objeto de la biblioteca de medios. Longitud máxima: 255. El nombre de archivo puede verse en los detalles de cada recurso en la interfaz de Media Library en ads.x.com. Permanecerá vacío cuando no se haya definido `file_name`. Tipo: string Ejemplo: `coffee.jpeg`
name opcional	El nombre del objeto de la biblioteca de medios. Longitud máxima: 100. Esta es la etiqueta debajo de cada recurso en la interfaz de Media Library en ads.x.com. La etiqueta será “Untitled” cuando no se haya definido `name`. Tipo: string Ejemplo: `Latte`
poster_media_key opcional	Especifica una imagen de póster para el video usando la `media_key` de una imagen cargada. Nota: Solo puede usarse con videos. Tipo: string Ejemplo: `3_885003359340375465`
title opcional	El título (encabezado) que aparece debajo del video cuando se publica como un Post. Longitud máxima: 70 caracteres. Esto no se muestra en el Post de forma predeterminada. Para mostrar el `title` del video, usa el parámetro `video_title` con el endpoint POST accounts/:account_id/tweet. Nota: Solo puede usarse con videos. Tipo: string Ejemplo: `Título del video`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "media_key": "16_844800354743074820",
      "title": "GIF de gato",
      "description": "en el espacio"
    }
  },
  "data": {
    "tweeted": true,
    "duration": null,
    "name": null,
    "file_name": null,
    "description": "en el espacio",
    "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": "GIF de gato",
    "media_type": "GIF",
    "aspect_ratio": "125:79",
    "updated_at": "2017-10-23T06:37:56Z",
    "deleted": false
  }
}

Elimina el objeto especificado de la biblioteca de medios que pertenece 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 apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
media_key obligatorio	Una referencia al objeto de la biblioteca de medios con el que se opera 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

Recupera los detalles de algunas o todas las tarjetas de encuesta asociadas a la cuenta actual.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_ids opcional	Limita la respuesta únicamente a las tarjetas de encuesta deseadas especificando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `57i77`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: `8x7v00oow`
q opcional	Consulta opcional para acotar las tarjetas por `name`. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: realiza coincidencia de prefijo sin distinción de mayúsculas/minúsculas. Tipo: string Ejemplo: `night`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: este parámetro y `cursor` son excluyentes. Nota: las solicitudes que incluyan `total_count` tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/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": "encuesta mejor costa",
      "start_time": "2018-01-09T04:51:34Z",
      "first_choice": "Este",
      "video_height": "9",
      "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
      "content_duration_seconds": "8",
      "second_choice": "Oeste",
      "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"
    }
  ]
}

Obtén 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

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	Una referencia a la tarjeta de encuesta con la que se opera en la solicitud. Tipo: string Ejemplo: `57i8t`
with_deleted opcional	Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "poll",
      "card_id": "57i8t",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "encuesta solo de texto",
    "start_time": "2018-01-09T05:03:05Z",
    "first_choice": "Mañana",
    "second_choice": "Noche",
    "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 permite crear tarjetas de encuesta con una imagen, un video o sin contenido multimedia. Las encuestas con contenido multimedia se denominan Media Forward Polls. Nota: El producto Media Forward Polls está en fase 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 requerido	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro requerido para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
duration_in_minutes requerido	El tiempo (en minutos) durante el cual la encuesta permanecerá abierta. Tras alcanzarse 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 tan pronto como se crea la tarjeta y no cuando se agrega a un Tweet. Tipo: int Mín., máx.: `5`, `10080`
first_choice requerido	La primera opción de la encuesta. Longitud máxima: 25 caracteres. Tipo: string Ejemplo: `One`
name requerido	El nombre de la tarjeta. Tipo: string Ejemplo: `poll card`
second_choice requerido	La segunda opción de la encuesta. Longitud máxima: 25 caracteres. Tipo: string Ejemplo: `Two`
fourth_choice opcional	La cuarta opción de la encuesta. Longitud máxima: 25 caracteres. Nota: La primera, segunda y tercera opciones deben establecerse al usar este parámetro. Tipo: string Ejemplo: `Four`
media_key opcional	El `media_key` de una imagen o video de la biblioteca multimedia que se utilizará en esta tarjeta. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para este contenido multimedia. Nota: La imagen o el video deben estar en la biblioteca multimedia 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.
third_choice opcional	La tercera opción de la encuesta. Longitud máxima: 25 caracteres. Nota: La primera y segunda opciones deben establecerse al usar este parámetro. Tipo: string Ejemplo: `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": "Este",
      "name": "encuesta sobre la mejor costa",
      "second_choice": "Oeste",
      "media_key": "13_950589518557540353",
      "duration_in_minutes": 10080
    }
  },
  "data": {
    "video_poster_height": "9",
    "name": "encuesta sobre la mejor costa",
    "start_time": "2018-01-09T04:51:34Z",
    "first_choice": "Este",
    "video_height": "9",
    "video_url": "https://video.twimg.com/amplify_video/vmap/950589518557540353.vmap",
    "content_duration_seconds": "8",
    "second_choice": "Oeste",
    "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"
  }
}

Elimina de forma permanente la tarjeta de encuesta especificada que pertenece a la cuenta actual. Nota: Se trata de una eliminación definitiva. En consecuencia, 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 en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
card_id obligatorio	Una referencia a la poll card con la que se está operando 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": "encuesta con imagen",
    "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 (CTA) 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 obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_ids opcional	Limita la respuesta a los CTA de prerroll asociados con los line items especificados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `8v53k`
count opcional	Especifica la cantidad de registros a intentar recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., Máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
preroll_call_to_action_ids opcional	Limita la respuesta a los CTA de prerroll deseados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `8f0`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de frecuencia más bajos, actualmente establecidos en 200 por 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Recupera 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 obligatorio	Identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
preroll_call_to_action_id obligatorio	Referencia al llamado a la acción de preroll con el que opera la solicitud. Tipo: string Ejemplo: `8f0`
with_deleted opcional	Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/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 la llamada a la acción (CTA) opcional para un ítem de línea PREROLL_VIEWS.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
call_to_action obligatorio	El texto del CTA del botón mostrado en el anuncio. Tipo: enum Valores posibles: `GO_TO`, `SEE_MORE`, `SHOP`, `VISIT_SITE`, `WATCH_NOW`
call_to_action_url obligatorio	La URL a la que se redirige al usuario cuando se hace clic en el botón de CTA. Tipo: string Ejemplo: `https://www.x.com`
line_item_id obligatorio	Referencia al line item con el que estás operando en la solicitud. Tipo: string Ejemplo: `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 la llamada a la acción (CTA) opcional de un elemento 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 apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
preroll_call_to_action_id obligatorio	Referencia al CTA de prerroll con el que se opera en la solicitud. Tipo: string Ejemplo: `8f0`
call_to_action opcional	El texto del CTA para el botón mostrado en el 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) prerroll especificada que pertenece a 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 apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
preroll_call_to_action_id obligatorio	Referencia al CTA de prerroll con el que se opera 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

Recupera los detalles de algunos o todos los Tweets programados asociados a la cuenta actual.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `100` Mín., máx.: `1`, `200`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `c-j3cn6n40`
user_id opcional	Especifica el usuario para el que se recuperarán los Tweets programados. Si no se establece, se usa el usuario promocionable `FULL` de la cuenta. Tipo: long Ejemplo: `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"
}

Recupera 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 obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_tweet_id obligatorio	Una referencia al Scheduled Tweet con el que opera en la solicitud. Tipo: string Ejemplo: `917438609065623552`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "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 totalmente 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/scheduled_tweets

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_at obligatorio	La hora, expresada en ISO 8601, a la que el Tweet debe publicarse (o ponerse en vivo). Nota: Los Tweets solo se pueden programar hasta con un año de antelación. Nota: Los Tweets deben programarse con granularidad de minutos; los segundos se ignorarán. Tipo: string Ejemplo: `2017-12-31T23:59:00Z`
as_user_id obligatorio	El id de usuario del anunciante en cuyo nombre 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 te permite llamar a la API usando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: long Ejemplo: `756201191646691328`
text a veces obligatorio	El texto de tu actualización de estado. Obligatorio si no se especifican `media_keys`. Tipo: string Ejemplo: `just setting up my twttr`
card_uri opcional	Asocia una tarjeta al Tweet usando el valor `card_uri` de cualquier respuesta de tarjetas, si está disponible. Tipo: string Ejemplo: `card://855591459410511943`
media_keys opcional	Asocia contenido multimedia al 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. Tipo: string Ejemplo: `13_1153584529292270722`
nullcast opcional	Indica si se debe crear un Tweet nullcast (o “solo promocionado”). Tipo: boolean Predeterminado: `true` Valores posibles: `true`, `false`
name opcional	El nombre del Tweet programado. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `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 perteneciente 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 requerido	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro requerido para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_tweet_id requerido	Referencia al Scheduled Tweet con el que se opera en la solicitud. Tipo: string Ejemplo: `870321875435442177`
card_uri opcional	Asocia una card con el Tweet usando el valor `card_uri` de cualquier respuesta de cards, si está disponible. Nota: Anula (elimina) estableciendo el parámetro sin valor. Tipo: string Ejemplo: `card://875146925316386347`
media_keys opcional	Asocia medios con el Tweet especificando una lista de identificadores separada por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Nota: El recurso multimedia debe estar en la Media Library de la cuenta. Nota: Anula (elimina) estableciendo el parámetro sin valor. Tipo: string Ejemplo: `13_1153584529292270722`
nullcast opcional	Indica si se debe crear un Tweet nullcasted (o “Promoted-only”). Tipo: boolean Valores posibles: `true`, `false`
scheduled_at opcional	La hora, expresada en ISO 8601, a la que debe publicarse el Tweet (o ponerse en línea). Tipo: string Ejemplo: `2017-12-31T23:59:59Z`
text opcional	El texto de la actualización de estado. Tipo: string Ejemplo: `just setting up my twttr`
name opcional	El nombre del Scheduled Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `Tweet with name`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "request": {
    "params": {
      "scheduled_tweet_id": "875057751231037440",
      "text": "solsticio de invierno"
    }
  },
  "data": {
    "name": null,
    "completed_at": null,
    "scheduled_status": "SCHEDULED",
    "text": "solsticio de invierno",
    "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 que pertenece a la cuenta actual. Nota: Esta es una eliminación definitiva. Por lo tanto, 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 de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_tweet_id obligatorio	Una referencia al Scheduled Tweet con el que 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

Obtén una vista previa de Tweets publicados, programados o en borrador.

Permite previsualizar varios Tweets —hasta 200— en una sola solicitud a la API
Representación precisa y actualizada del diseño y estilo del Tweet
Compatible con los formatos y tipos de tarjeta más recientes
Devuelve un iframe

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
tweet_ids obligatorio	Una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id. Nota: Los id deben corresponder al `tweet_type` especificado. Por ejemplo, si se pasa un id de un Tweet programado y se especifica `tweet_type=PUBLISHED`, no se devolverá una vista previa para ese id. Tipo: long Ejemplo: `1122911801354510336,1102836745790316550`
tweet_type obligatorio	El tipo de Tweet para los `tweet_ids` especificados. Tipo: 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

Recupera los detalles de Tweet del usuario promocionable principal de la cuenta (predeterminado) o del usuario especificado en el parámetro user_id. Puede ser cualquiera de los usuarios promocionables de la cuenta.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
tweet_type obligatorio	El tipo de Tweet para los `tweet_ids` especificados. Tipo: enum Valores posibles: `DRAFT`, `PUBLISHED`, `SCHEDULED`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `AAAAAFhLRpQLNF-sGBSgAA`
include_mentions_and_replies opcional	Indica si se deben excluir las menciones y las respuestas de la lista de Tweets disponibles. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
name opcional	Consulta opcional para acotar Tweets por `name`. Omite este parámetro para recuperar todos. Longitud máxima: 80 caracteres. Nota: realiza coincidencia por prefijo sin distinción de mayúsculas/minúsculas. Tipo: string Ejemplo: `dtc`
timeline_type opcional	Indica si se deben devolver Tweets nullcasted (también llamados “solo promocionados”), Tweets orgánicos o ambos. Tipo: enum Predeterminado: `NULLCAST` Valores posibles: `ALL`, `NULLCAST`, `ORGANIC`
trim_user opcional	Indica si se debe excluir el objeto de usuario en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto de usuario que se devolverá es el id de usuario del autor del Tweet. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
tweet_ids opcional	Lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Nota: los IDs deben corresponder al `tweet_type` especificado. Por ejemplo, si se envía un ID de Tweet programado, el `tweet_type` debe ser `SCHEDULED` para que ese Tweet se devuelva en la respuesta. Tipo: long Ejemplo: `1122911801354510336,1102836745790316550`
user_id opcional	Especifica el usuario al que se acotarán los Tweets. De manera predeterminada, se usa el usuario promocionable `FULL` de la cuenta cuando no se establece. Tipo: long Ejemplo: `756201191646691328`

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "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">App interna de prueba de Ads API</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": "TODOS",
      "nullcast": true,
      "created_at": "mar 27 ago 22:22:12 +0000 2019",
      "place": null,
      "scheduled_at": null,
      "tweet_type": "PUBLISHED",
      "favorited": false,
      "full_text": "hola, 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

Cree un Tweet para el usuario promocionable completo de la cuenta (predeterminado) o para el usuario especificado en el parámetro as_user_id. Se admite la creación de Tweets nullcast (predeterminada) y orgánicos. Los Tweets nullcast no aparecen en la cronología pública ni se muestran a los seguidores. Ambos tipos pueden usarse en campañas. Si el usuario autenticado no es el usuario promocionable FULL de esta cuenta, determine si tiene permiso para publicar Tweets en nombre de ese usuario realizando una solicitud al endpoint GET accounts/:account_id/authenticated_user_access. Un permiso TWEET_COMPOSER indica que el usuario puede usar este endpoint para crear Tweets nullcast en nombre del usuario promocionable FULL. Al usar el endpoint upload.x.com para contenido multimedia, pase el mismo valor de user_id en el parámetro additional_owners que el valor de as_user_id que envía a este endpoint.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta 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`
as_user_id obligatorio	El ID de usuario del anunciante en cuyo nombre publicas el Tweet. El anunciante debe otorgar acceso a tu handle (o handles) a su cuenta de anuncios a través de ads.x.com. Este permiso te permite llamar a la API usando los tokens OAuth de tu propio handle en lugar de los del anunciante. Tipo: long Ejemplo: `756201191646691328`
text a veces obligatorio	El texto de tu actualización de estado. Obligatorio si no se especifican `media_keys`. Tipo: string Ejemplo: `hello, world`
card_uri opcional	Asocia una card con el Tweet usando el valor `card_uri` de cualquier respuesta de cards, si está disponible. Tipo: string Ejemplo: `card://853503245793641682`
conversation_settings opcional	Elige quién puede responder a este Tweet. Las personas mencionadas siempre pueden responder. Nota: Este campo no se devolverá en la respuesta a la solicitud POST, pero se devolverá al hacer una solicitud GET. Nota: Este parámetro solo funciona en Ads API v8 y posteriores. Tipo: enum Predeterminado: `EVERYONE` Valores posibles: `EVERYONE`, `FOLLOWING`, `MENTIONED_USERS`
media_keys opcional	Asocia contenido multimedia con el Tweet especificando una lista de identificadores separados por comas. Incluye hasta 4 imágenes, 1 GIF animado o 1 video. Tipo: string Ejemplo: `13_1153584529292270722`
name opcional	El nombre del Tweet. Longitud máxima: 80 caracteres. Tipo: string Ejemplo: `Tweet with name`
nullcast opcional	Indica si se debe crear un Tweet nullcasted (o “solo promocionado”). Nota: Los Tweets orgánicos (`nullcast=false`) solo pueden crearse para el usuario autenticado. Tipo: boolean Predeterminado: `true` Valores posibles: `true`, `false`
trim_user opcional	Indica si se debe excluir el objeto de usuario en la respuesta del Tweet. Cuando está habilitado, la única parte del objeto de usuario que se devolverá es el ID de usuario del autor del Tweet. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
tweet_mode opcional	Indica si la respuesta debe estar en modo de compatibilidad o extendido. Consulta esto para obtener información adicional. Tipo: string Valores posibles: `compat`, `extended`
video_cta opcional	La CTA del video. Tipo: enum Valores posibles: `VISIT_SITE`, `WATCH_NOW`
video_cta_value opcional	El valor de la CTA correspondiente 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 con la plataforma publicitaria de X`
video_title opcional	El título (encabezado) que aparece debajo del video. Longitud máxima: 70 caracteres. Tipo: string Ejemplo: `X Ads API`

Ejemplo de solicitud

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

Respuesta de ejemplo

{
  "data": {
    "created_at": "Sat Jun 24 05:08:30 +0000 2017",
    "id": 878479925472251906,
    "id_str": "878479925472251906",
    "text": "hola, mundo",
    "name": null,
    "truncated": false,
    "entities": {
      "hashtags": [],
      "symbols": [],
      "user_mentions": [],
      "urls": []
    },
    "source": "<a href='"https://ads-api.x.com"' rel='"nofollow"'>App interna de prueba de Ads API</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": "hola, mundo",
      "trim_user": true,
      "as_user_id": 756201191646691328,
      "account_id": "18ce54d4x5t"
    }
  }
}

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

URL del recurso

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

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
tweet_id obligatorio	Referencia al Tweet con el que se opera en la solicitud. Tipo: long Ejemplo: `994747471329873920`
name opcional	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

Nota: Para asociar una tarjeta con un Tweet, usa el parámetro card_uri con cualquiera de los endpoints POST accounts/:account_id/tweet, POST statuses/update o POST accounts/:account_id/scheduled_tweets.

GET accounts/:account_id/cards/video_conversation

Recupera los detalles de algunas o todas las tarjetas de conversación en video asociadas a la cuenta actual.

URL del recurso

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

Parámetros

Nombre	Descripción
account_id 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_ids opcional	Limita la respuesta únicamente a las video conversation cards deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `5a86h`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: `8x7v00oow`
q opcional	Consulta opcional para limitar las cards por `name`. Omite este parámetro para recuperar todas. Longitud máxima: 80 caracteres. Nota: Realiza coincidencia de prefijo sin distinción entre mayúsculas y minúsculas. Tipo: string Ejemplo: `night sky`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son mutuamente excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de frecuencia más bajos, actualmente establecidos en 200 por cada 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Recupera 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

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

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "request": {
    "params": {
      "card_type": "video_conversation",
      "card_id": "5a86h",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "tarjeta de conversación en vídeo",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Créalo",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "API de anuncios",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Desarrolladores",
    "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 video asociada a la cuenta especificada. Consulta Carga de medios para obtener información útil sobre cómo cargar imágenes en nuestros endpoints.

URL del recurso

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

Parámetros

Nombre	Descripción
cuenta_idobligatorio	El identificador de la cuenta con apalancamiento. Aparece dentro del recurso’s path y, por lo general, es un parámetro obligatorio para todas las solicitudes de la API de Anunciantes, exceptoGET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: cadena Ejemplo:`18ce54d4x5t`
primera_llamado a la acciónobligatorio	El hashtag de llamada a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: cadena Ejemplo:`#APIs`
primero_CTA_Tweetrequerido	El texto del Tweet que se usará al hacer clic en el primer CTA. Tipo: string Ejemplo:`API de anuncios`
multimedia_claveobligatorio	La clave de media de un video que se usará en esta tarjeta.Nota: El vídeo debe estar en la cuenta’sBiblioteca multimedia.Nota: Se requiere una relación de aspecto de 16:9. Tipo: cadena Ejemplo:`13_1168079965037467209`
nombreobligatorio	Nombre de la tarjeta. Tipo: cadena Ejemplo:`tarjeta de conversación en video`
gracias_usted_textoobligatorio	El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: cadena Ejemplo:`Créalo`
títuloa veces obligatorio	El título de la tarjeta, que aparece debajo del vídeo y encima de las CTA. Longitud máxima: 23 caracteres. Tipo: stringNota: Obligatorio si`second_cta`es`not`configurado. Ejemplo:`Desarrolladores`
segundo_CTAa veces obligatorio	El hashtag de llamada a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar “#”). Tipo: cadenaNota: Obligatorio cuando`title`es`not`configurado. Ejemplo:`#VolverACompartir`
segundo_llamada a la acción_Tweeta 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:`Vuelvo a amar @AdsAPI`
cartel_multimedia_claveopcional	La clave de medios de la imagen de póster que se utilizará en esta tarjeta. Si no se especifica, se usará el primer fotograma.Nota: El vídeo debe estar en la cuenta’sBiblioteca multimedia. Tipo: long Ejemplo:`3_882726458191298561`
tercer_CTAopcional	El hashtag de llamado a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: cadena Ejemplo:`#ComparteMás`
tercer_llamada a la acción_Tweeta veces requerido	El texto del Tweet que se usará cuando se haga clic en la tercera CTA. Tipo: stringNota: Obligatorio si`third_cta`está configurado. Ejemplo:`Me encanta @TwitterDev`
cuarta_CTAopcional	El hashtag de llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: cadena Ejemplo:`#ExtraCompartido`
cuarta_llamada a la acción_Tweeta veces requerido	El texto del Tweet que se usará cuando se haga clic en el cuarto CTA. Tipo: cadenaNota: Obligatorio si`fourth_cta`está definido. Ejemplo:`Vuelvo a querer a @TwitterDev`
gracias_usted_urlopcional	La URL que se mostrará con el texto de agradecimiento. Tipo: cadena Ejemplo:`https://example.com/gracias`
desbloqueado_imagen_multimedia_llaveopcional	A`media_key`de una imagen que se usará en el escenario de desbloqueo instantáneo. Este es un campo de solo escritura. En la respuesta, la API proporcionará una URL de X para esta imagen.Nota: La imagen debe estar en la cuenta’la biblioteca de medios de la cuenta.Tipo: cadena Ejemplo:`3_883112887618682880`
desbloqueado_video_multimedia_claveopcional	El identificador de un vídeo delGET accounts/:account_id/media_libraryendpoint 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 video especificada que pertenece a la cuenta actual. Consulta Carga de contenido multimedia para obtener información útil sobre cómo cargar 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
cuenta_idobligatorio	El identificador de la cuenta con apalancamiento. Aparece dentro del recurso’la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la API de Anuncios, exceptoGET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: cadena Ejemplo:`18ce54d4x5t`
tarjeta_idobligatorio	Una referencia a la tarjeta de conversación de video con la que estás trabajando en la solicitud. Tipo: cadena Ejemplo:`5a86h`
primero_CTAopcional	El hashtag del llamado a la acción (CTA) para la primera opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: cadena Ejemplo:`#APIs`
primera_llamada a la acción_Tweetopcional	El texto del Tweet que se usará cuando se haga clic en la primera CTA. Tipo: string Ejemplo:`API de anuncios`
segundo_CTAopcional	El hashtag de llamada a la acción (CTA) para la segunda opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: cadenaNota: Obligatorio si`título`es`not`definido. Ejemplo:`#VolverACompartir`
segundo_LLAMADA_A_LA_ACCIÓN_Tweetopcional	El texto del Tweet que se usará cuando se haga clic en el segundo CTA.Nota: Obligatorio si`second_cta`está establecido. Tipo: cadena Ejemplo:`Vuelvo a amar @AdsAPI`
tercer_llamada a la acciónopcional	El hashtag de llamada a la acción (CTA) para la tercera opción. Longitud máxima: 20 caracteres (sin contar “#”). Tipo: cadena Ejemplo:`#ComparteMás`
tercer_llamado a la acción_Tweetopcional	El texto de Tweet que se utilizará cuando se haga clic en la tercera CTA. Tipo: stringNota: Obligatorio si`third_cta`está configurado. Ejemplo:`Amo a @TwitterDev`
cuarto_CTAopcional	El hashtag de llamada a la acción (CTA) para la cuarta opción. Longitud máxima: 20 caracteres (sin contar el #). Tipo: cadena Ejemplo:`#ContenidoExtra`
cuarto_cta_Tweetopcional	El texto del Tweet que se usará cuando se haga clic en el cuarto CTA. Tipo: cadenaNota: Obligatorio si`fourth_cta`está configurado. Ejemplo:`Vuelvo a querer a @TwitterDev`
multimedia_claveopcional	La clave de medios del video que se utilizará en esta tarjeta.Nota: El video debe estar en la cuenta’sBiblioteca multimedia.Nota: Se requiere una relación de aspecto de 16:9. Tipo: cadena Ejemplo:`13_1168079965037467209`
nombreopcional	Nombre de la tarjeta. Tipo: cadena Ejemplo:`tarjeta para desarrolladores`
cartel_contenido multimedia_claveopcional	La clave de medios de una imagen de póster que se usará en esta tarjeta. Si no se especifica, se usará el primer fotograma.Nota: El vídeo debe estar en la cuenta’sBiblioteca multimedia. Tipo: long Ejemplo:`3_882726458191298561`
gracias_usted_textoopcional	El texto que se mostrará después de hacer clic en el CTA. Longitud máxima: 23 caracteres. Tipo: cadena. Ejemplo:`Créalo`
gracias_usted_urlopcional	La URL que se mostrará junto con el texto de agradecimiento. Tipo: string Ejemplo:`https://example.com/thankyou`
títuloopcional	El título de la tarjeta, que aparece debajo del video y encima de las CTA. Longitud máxima: 23 caracteres. Tipo: cadenaNota: Obligatorio si`second_cta`es`not`establecido. Ejemplo:`Iniciar una conversación`
desbloqueado_imagen_multimedia_claveopcional	A`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 cuenta’biblioteca de medios de la cuenta. Tipo: cadena Ejemplo:`3_883112887618682880`
desbloqueado_video_multimedia_claveopcional	El identificador de un vídeo delGET accounts/:account_id/media_libraryendpoint que se utilizará en el escenario de desbloqueo instantáneo. Tipo: cadena 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": "tarjeta para desarrolladores",
    "first_cta": "#APIs",
    "video_height": "9",
    "media_url": "https://video.twimg.com/amplify_video/vmap/958388276489895936.vmap",
    "thank_you_text": "Créalo",
    "video_owner_id": "756201191646691328",
    "media_key": "13_958388276489895936",
    "id": "5a86h",
    "video_width": "16",
    "first_cta_tweet": "API de anuncios",
    "created_at": "2018-01-30T17:53:04Z",
    "card_uri": "card://958397665015775232",
    "title": "Desarrolladores",
    "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 forma permanente la tarjeta de conversación de video especificada que pertenece a la cuenta actual. Nota: Se trata de 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/video_conversation/:card_id

Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la 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 video conversation card con la que se opera en la solicitud. Tipo: string Ejemplo: `4i0ya`

Ejemplo de petición

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

Ejemplo de respuesta

{
  "data": {
    "name": "tarjeta de conversación en video",
    "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"
    }
  }
}

API de X Ads

Conceptos básicos

Recursos

Medición

​Descripción general

​Tarjetas

​Imagen

​Video

​Video promocionado

​Video promocionado en Tweets

​Video promocionado en Cards

​Información general

​Guías

​Tweets programados

​Introducción

​Puntos de conexión de la API

​Gestión de Tweets programados

​Tweets promocionados programados

​Vista de Scheduled Tweet

​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 de medios

​Introducción

​Endpoints de la API

​Agregar a la biblioteca

​Parámetros de la solicitud

​Atributos

​Uso

​Identificación de Cards

​Introducción

​Identificación de Tweets con card_uri

​Identificación de Tweets con preview_url

​Obtención de cards

​Identificación de contenido multimedia

​Introducción

​Imágenes

​Videos

​Biblioteca de medios

​Tweets

​Introducción

​Tweets nullcasted

​Promocionar Tweets

​IDs de Tweet

​Carruseles

​Introducción

​Endpoints

​Cuerpo de la solicitud JSON (POST)

​Ejemplo

​etiquetado-de-metadatos-de-creativos

​Introducción

​Etiquetado de recursos creativos

​¿Preguntas?

​Referencia de 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

Descripción general

Tarjetas

Imagen

Video

Video promocionado

Video promocionado en Tweets

Video promocionado en Cards

Información general

Guías

Tweets programados

Introducción

Puntos de conexión de la API

Gestión de Tweets programados

Tweets promocionados programados

Vista de Scheduled Tweet

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 de medios

Introducción

Endpoints de la API

Agregar a la biblioteca

Parámetros de la solicitud

Atributos

Uso

Identificación de Cards

Introducción

Identificación de Tweets con card_uri

Identificación de Tweets con preview_url

Obtención de cards

Identificación de contenido multimedia

Introducción

Imágenes

Videos

Biblioteca de medios

Tweets

Introducción

Tweets nullcasted

Promocionar Tweets

IDs de Tweet

Carruseles

Introducción

Endpoints

Cuerpo de la solicitud JSON (POST)

Ejemplo

etiquetado-de-metadatos-de-creativos

Introducción

Etiquetado de recursos creativos

¿Preguntas?

Referencia de 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