Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

El siguiente ejemplo asume que has instalado, configurado y autorizado tu App y tu usuario usando twurl. twurl es una herramienta de línea de comandos similar a cURL que gestiona de forma adecuada la autenticación OAuth de X. twurl es una excelente herramienta para probar y depurar rápidamente la funcionalidad de la Ads API (y la REST API). Para ver los encabezados completos de la solicitud y la respuesta, usa -t para rastrear la llamada, aproximadamente equivalente a la opción -v de cURL. En este ejemplo, crearemos una campaña de anuncios de productos dinámicos (Dynamic Product Ads, DPA). Obtén el id de la cuenta. 
twurl -H ads-api.x.com /12/accounts/

{
  "request": {
    "params": {}
  },
  "data": [
    {
      "name": "Test account for @AdsAPI",
      "timezone": "America/Los_Angeles",
      "timezone_switch_at": null,
      "id": "xxxxxx",
      "created_at": "2014-03-09T00:41:49Z",
      "salt": "f9f9d5a5f23075c618da5eb1d1a9df57",
      "updated_at": "2015-01-29T00:41:49Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ],
  "data_type": "account",
  "total_count": 1,
  "next_cursor": null
}
Obtén el id del instrumento de financiación. Realiza una llamada a la API GET accounts/:account_id/funding_instruments usando el id de la cuenta obtenido en el comando anterior. 
twurl -H ads-api.x.com /12/accounts/xxxxxx/funding_instruments

{
  "data": [
    {
      "cancelled": true,
      "created_at": "2014-03-09T00:41:49Z",
      "credit_limit_local_micro": null,
      "currency": "USD",
      "deleted": false,
      "description": null,
      "end_time": null,
      "funded_amount_local_micro": null,
      "id": "yyyy",
      "type": null,
      "updated_at": "2014-05-29T00:41:49Z"
    }
  ],
  "data_type": "funding_instrument",
  "next_cursor": null,
  "request": {
    "params": {
      "account_id": "xxxxxx"
    }
  },
  "total_count": 1
}

​
Paso 1: Crear campaña

Crea una campaña y asóciala al instrumento de financiación. Especifica una fecha y hora de inicio y un presupuesto para la campaña.
  • Campos obligatorios: instrumento de financiación, nombre de la campaña, presupuesto (total o diario), fecha y hora de inicio e id de la cuenta de anuncios
twurl -H ads-api.x.com -d "funding_instrument_id={FUNDING_INSTRUMENT_ID}&name={CAMPAIGN_NAME}&total_budget_amount_local_micro={TOTAL_BUDGET}&daily_budget_amount_local_micro={DAILY_BUDGET}&start_time={START_TIME}" /12/accounts/{ADS_ACCOUNT_ID}/campaigns | jq

​
Paso 2: Crear elemento de línea con objetivo de ventas

Crea un elemento de línea asociado a la campaña.
  • Campos obligatorios: campaign id (del Paso 1), product type, placements, objective, goal, entity status, primary web event tag, catalog id, product set id, creative_source, ads_account_id
  • catalog_id y product_set_id se pueden encontrar en tu Shopping Manager
  • creative_source siempre debe ser DYNAMIC_PRODUCT_CREATIVE
  • objective siempre debe ser WEBSITE_CLICKS
  • goal siempre debe ser WEBSITE_CONVERSIONS
twurl -H ads-api.x.com -d "campaign_id={CAMPAIGN_ID}&product_type={product_type}&placements={PLACEMENTS}&objective=WEBSITE_CLICKS&goal=WEBSITE_CONVERSIONS&entity_status={entity_status}&primary_web_event_tag={WEB_EVENT_TAG}&catalog_id={catalog_id}&product_set_id={product_set_id}&creative_source=DYNAMIC_PRODUCT_CREATIVE" /12/accounts/{ADS_ACCOUNT_ID}/line_items | jq
  • Después de este paso, la campaña estará disponible para verla en el Ads Manager de X.

​
Paso 3: Crear tarjeta DPA

Crea una tarjeta DPA.
  • Parámetros obligatorios: id de la cuenta de anuncios y URL:
  • La URL debe comenzar con https://twitter.com; se pueden añadir parámetros UTM adicionales después, como en el ejemplo siguiente:
    • https://twitter.com?utm_source=%7B%7Bsite_source%7D%7D
  • Opcionalmente, puedes elegir el formato de tu tarjeta especificando creative_type con uno de los siguientes valores: “CAROUSEL”, “SINGLE”, “COLLECTION”. Si no se especifica, tu tarjeta se creará como una tarjeta en formato carrusel.
twurl -X POST -H ads-api.twitter.com -A "Content-Type: application/json" "/12/accounts/{ADS_ACCOUNT_ID}/dynamic_product_cards" -d '{"url": "{URL}", "creative_type": "{CREATIVE_TYPE}"}' | jq

​
Paso 4: Crear Publicación

Crea una publicación.
  • Parámetros obligatorios: id de cuenta de anuncios, id de usuario, URI de la card (del Paso 3), texto, nombre y dynamic product ad
  • dynamic_product_ad siempre debe configurarse en true
twurl -X POST -H "https://ads-api.twitter.com" "/12/accounts/{ADS_ACCOUNT_ID}/tweet?as_user_id={USER_ID}1&card_uri=card%3A%2F%2F{CARD_URI}&text={POST_TEXT}&name={POST_NAME}%201&dynamic_product_ad=true" | jq

​
Paso 5: Asociar la publicación con el elemento de línea

Asocia la publicación con el elemento de línea.
  • Parámetros obligatorios: id de la cuenta publicitaria, id del elemento de línea (del Paso 2) y tweet id (id_str del Paso 4)
twurl -X POST -H "https://ads-api.twitter.com" "/12/accounts/{ADS_ACCOUNT_ID}/promoted_tweets?line_item_id={line_item_id}&tweet_ids={tweet_id}" | jq
Si los anunciantes quieren ver la tarjeta en la interfaz de usuario, podrán hacerlo.