Saltar al contenido principal

API para anunciantes

Programa campañas y gestiona anuncios en X de forma programática con este conjunto de API.

¿Qué puedes promocionar?

  • Los anuncios promocionados son anuncios normales que compran los anunciantes que quieren llegar a un grupo más amplio de usuarios o generar interacción por parte de sus seguidores existentes.
  • Los anuncios promocionados están claramente etiquetados como Promocionados cuando un anunciante paga por su aparición en X. En todos los demás aspectos, los anuncios promocionados se comportan igual que los anuncios normales y se pueden volver a publicar, responder, indicar “Me gusta”, etc. Tienen reglas de entrega típicas y se crean usando POST statuses/update.
  • “Promoted-only” Tweets, creados mediante POST accounts/:account_id/tweet, se pueden usar en campañas de Tweets promocionados, pero no se mostrarán a los seguidores ni aparecerán en la cronología pública. Para obtener una lista de Tweets “Promoted-only” de una cuenta determinada, usa GET accounts/:account_id/scoped_timeline.
  • Las cuentas promocionadas forman parte de A quién seguir, que sugiere cuentas que las personas aún no siguen y que pueden encontrar interesantes. Las cuentas promocionadas ayudan a presentar una variedad aún más amplia de cuentas que pueden interesar a los usuarios.
  • Las cuentas promocionadas para Timeline asocian un Tweet promocionado con una campaña de cuentas promocionadas y se muestran en las timelines de los usuarios.
Las Tendencias promocionadas no están disponibles en la Ads API.

Campañas y Grupos de Anuncios (Line Items)

Las campañas definen la programación y el presupuesto de un anuncio. El anunciante especifica un presupuesto diario y uno total. La campaña puede estar vinculada a horas específicas de inicio y finalización o ejecutarse de forma continua hasta que se agote el presupuesto. El presupuesto proviene de uno de los Funding Instruments de la cuenta publicitaria. Los identificadores de campaña (:campaign_id) son la representación en base 36 del valor en base 10 que presentamos en la interfaz de X Ads. Las cuentas publicitarias están limitadas a un máximo de 200 campañas activas. Este límite se puede aumentar manualmente hasta 4.000 campañas activas previa solicitud del anunciante a su X Account Manager. Una campaña se considera activa hasta que alcanza su hora de finalización o se elimina. Las campañas en pausa se consideran activas hasta sus horas de finalización designadas. Los grupos de anuncios (line items) consumen el presupuesto definido por una campaña. Estos grupos de anuncios reúnen la puja por interacción, el Tweet o la cuenta que se va a promocionar y las reglas de segmentación.

Analítica

La X Ads API ofrece un conjunto de endpoints de analítica para rastrear y optimizar el rendimiento de los anuncios. Consulta Analytics y Analytics Best Practices para obtener más información. Para la métrica de facturación, es posible que los datos no estén finalizados hasta tres días después del evento. Antes de ese momento, los datos deben considerarse especulativos. La cifra final facturable siempre será menor que el valor especulativo. La cifra facturable se ajusta para descontar el spam y el tráfico de baja calidad relacionado. Consulta Timezones para otras consideraciones relacionadas con las zonas horarias.

Creación de una campaña - Paso a paso

El siguiente ejemplo supone que ya has instalado, configurado y autorizado tu App y usuario usando twurl. twurl es una herramienta de línea de comandos similar a cURL que gestiona de forma eficaz la autenticación OAuth de X. twurl es una excelente herramienta para probar y depurar rápidamente la funcionalidad de Ads API (y de REST API). Para ver los encabezados completos de la solicitud y la respuesta, usa -t para trazar la llamada; es aproximadamente equivalente a la opción -v de cURL. En este ejemplo, crearemos una campaña de Promoted Ads segmentada por palabra clave.
  1. Obtén el id de la cuenta.
twurl -H ads-api.x.com /9/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
}
  1. Recupera el id del instrumento de financiación.
Realiza una llamada a la API GET accounts/:account_id/funding_instruments utilizando el id de la cuenta obtenido en el comando anterior.
twurl -H ads-api.x.com /9/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
}
  1. Crea una campaña y asóciala con el instrumento de financiación.
Especifica una hora de inicio y un presupuesto para la campaña. Para este ejemplo, usaremos un presupuesto de 500 USD y, para el límite diario, 50 USD.
twurl -H ads-api.x.com -d "funding_instrument_id=yyyy&name=My First Campaign&total_budget_amount_local_micro=500000000&daily_budget_amount_local_micro=50000000" /9/accounts/xxxxxx/campaigns
{
  "data": {
    "created_at": "2015-02-09T00:00:00Z",
    "currency": "USD",
    "daily_budget_amount_local_micro": 50000000,
    "deleted": false,
    "end_time": null,
    "funding_instrument_id": "yyyy",
    "id": "92ph",
    "name": "My First Campaign",
    "entity_status": "PAUSED",
    "standard_delivery": true,
    "total_budget_amount_local_micro": 500000000,
    "updated_at": "2015-02-09T00:00:00Z"
  },
  "data_type": "campaign",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "daily_budget_amount_local_micro": 50000000,
      "funding_instrument_id": "yyyy",
      "name": "My First Campaign",
      "total_budget_amount_local_micro": 500000000
    }
  }
}
  1. Crea un elemento de línea asociado a la campaña.
Ahora que tenemos un id de campaña, podemos crear un elemento de línea para asociarlo a ella. El elemento de línea encapsula el precio de la puja, la segmentación y la parte creativa propiamente dicha de la campaña. Para este elemento de línea, promocionaremos Tweets con una puja de 1,50 USD.
twurl -H ads-api.x.com -d "campaign_id=XXXX&bid_amount_local_micro=1500000&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&objective=ENGAGEMENTS&entity_status=PAUSED" /9/accounts/xxxxxxx/line_items
{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "Untitled",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "azjx",
    "entity_status": "PAUSED",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:00Z",
    "updated_at": "2015-02-09T00:00:00Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "92ph",
    "deleted": false
  },
  "request": {
    "params": {
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "bid_amount_local_micro": 1500000,
      "product_type": "PROMOTED_TWEETS",
      "entity_status": "PAUSED",
      "account_id": "xxxxxxx",
      "campaign_id": "92ph"
    }
  }
}
  1. Crea un perfil de segmentación asociado con el line item.
Con el line item creado, podemos asignar criterios de segmentación. Queremos segmentar las palabras clave de concordancia de frase “grumpy cat” en la ubicación del Área de la Bahía de San Francisco. Esto va a requerir una consulta del id de ubicación y dos solicitudes POST al endpoint targeting_criteria.
twurl -H ads-api.x.com "/9/targeting_criteria/locations?location_type=CITIES&q=San Francisco"
{
  "data": [
    {
      "name": "San Francisco-Oakland-San Jose CA, US",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  ],
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "location_type": "CITY",
      "q": "San Francisco"
    }
  }
}
twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=LOCATION&targeting_value=5122804691e5fecc" /9/accounts/xxxxxx/targeting_criteria
{
  "data": {
    "created_at": "2015-02-09T00:00:15Z",
    "deleted": false,
    "id": "2u3be",
    "line_item_id": "yyyy",
    "name": "San Francisco-Oakland-San Jose CA, US",
    "targeting_type": "LOCATION",
    "targeting_value": "5122804691e5fecc",
    "updated_at": "2013-05-30T21:01:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  }
}
twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=PHRASE_KEYWORD&targeting_value=grumpy cat" /9/accounts/xxxxxx/targeting_criteria
{
  "data": {
    "created_at": "2015-02-09T00:00:20Z",
    "deleted": false,
    "id": "2u3bd",
    "line_item_id": "yyyy",
    "name": "grumpy cat",
    "targeting_type": "PHRASE_KEYWORD",
    "targeting_value": "grumpy cat",
    "updated_at": "2013-05-30T18:05:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "PHRASE_KEYWORD",
      "targeting_value": "grumpy cat"
    }
  }
}
  1. Por último, reactiva la partida.
twurl -H ads-api.x.com -X PUT "/9/accounts/xxxxxx/line_items/yyyy/?entity_status=ACTIVE"
{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "grumpy cat",
    "placements": [],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "yyyy",
    "entity_status": "ACTIVE",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:20Z",
    "updated_at": "2015-02-09T00:00:20Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "dy1f",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "yyyy",
      "entity_status": "ACTIVE",
      "account_id": "xxxxxx"
    }
  }
}
¡Listo! Ahora tenemos una campaña activa, segmentada y con presupuesto de Tweets Promocionados en Timelines que ya está en marcha.

Campañas basadas en objetivos

Las campañas y la fijación de precios basadas en objetivos permiten a los anunciantes pagar por las acciones que están alineadas con sus objetivos de marketing. Para ello, establece el objective apropiado en los line items. El parámetro utilizado en los endpoints de escritura de line items y devuelto en los endpoints de lectura es objective. Este campo tiene los siguientes valores posibles en la actualidad:
  • APP_ENGAGEMENTS
  • APP_INSTALLS
  • FOLLOWERS
  • ENGAGEMENTS
  • REACH
  • VIDEO_VIEWS
  • PREROLL_VIEWS
  • WEBSITE_CLICKS
Los objetivos determinan cómo optimizamos las campañas en nuestras subastas y cómo facturamos esas campañas. Ofrecemos precios basados en el objetivo, como CPAC para APP_ENGAGEMENTS, CPAC o CPI para APP_INSTALLS, CPLC para WEBSITE_CLICKS, CPF para FOLLOWERS, CPE para ENGAGEMENTS y CPM para REACH. Las campañas de promoción de aplicaciones móviles deben contener obligatoriamente el objetivo APP_ENGAGEMENTS o APP_INSTALLS. Nota: No se permiten line items con objetivos diferentes dentro de la misma campaña.
Campaign objectiveAPI objectiveMedia in TweetsPricing model
App re-engagementsAPP_ENGAGEMENTSSe requiere una tarjeta de descarga de la app con imagen o video.CPAC
App installsAPP_INSTALLSSe requiere una tarjeta de descarga de la app con imagen o video.CPAC o CPI (se configura usando charge_by)
ReachREACHSin restricciones.CPM
FollowersFOLLOWERSEl Tweet no es obligatorio, pero se recomienda. No hay restricciones de medios en los Tweets para campañas de seguidores, aunque recomendamos Tweets solo de texto. Más informaciónCPF
EngagementsENGAGEMENTSSin restricciones.CPE
Video ViewsVIDEO_VIEWSSe requiere tarjeta de conversación de video, video o GIF.CPV o costo por visualización de 3 s/100 %
Pre-roll viewsPREROLL_VIEWSSe requiere video.CPV o costo por visualización de 3 s/100 %
Website ClicksWEBSITE_CLICKSSe recomienda la tarjeta de sitio web, pero no es obligatoria. El Tweet debe incluir una tarjeta de sitio web o un enlace de sitio web (no ambos).CPLC

Instrumentos de financiación

Los instrumentos de financiación son la fuente del presupuesto de la campaña. Los instrumentos de financiación no se pueden crear a través de la Ads API; deben haber sido ya establecidos por el gestor de cuentas del anunciante en X (para líneas de crédito) o mediante ads.x.com (para tarjetas de crédito) para que estén disponibles. Para obtener una lista de todos los funding_instruments de una cuenta, consulta GET accounts/:account_id/funding_instruments y GET accounts/:account_id/funding_instruments/:funding_instrument_id para obtener los detalles de uno específico.

Atributos del instrumento de financiación

Descriptivo: account_id, id del instrumento de financiación, type del instrumento de financiación, description y io_header (ID del encabezado de orden de inserción). Ten en cuenta que un solo io_header puede estar asociado con múltiples instrumentos de financiación. Capacidad de financiación: able_to_fund y reasons_not_able_to_fund. Tiempo: created_at, updated_at, start_time y end_time, representados mediante una cadena con el formato “%Y-%m-%dT%l:%M:%S%z”. Estado booleano: paused, deleted y cancelled (true o false). Financiero: currency (formato ISO-4217), credit_limit_local_micro, credit_remaining_local_micro y funded_amount_local_micro. El valor de una moneda se representa en micros. Para USD, $5.50 se codifica como 5.50*1e6, es decir, 5,500,000. Para representar un “valor entero”, debes multiplicar el valor local en micros por 1e6 (1_000_000) para todas las monedas.

Detalles de los atributos

credit_limit_local_micro solo es válido para instrumentos de financiación de tipo CREDIT_CARD o CREDIT_LINE y representa el límite de crédito de ese instrumento. funded_amount_local_micro solo es válido para instrumentos de financiación de tipo INSERTION_ORDER y representa el presupuesto asignado. credit_remaining_local_micro es válido para instrumentos de financiación de tipo CREDIT_LINE y AGENCY_CREDIT_LINE. Representa credit_limit_local_micro menos el importe ya gastado en ese instrumento de financiación. No representa la diferencia entre funded_amount_local_micro y el importe gastado. Hacemos una distinción entre límite de crédito e importe financiado porque representan distintos métodos de financiación subyacentes y diferentes acuerdos de gasto que tenemos con los anunciantes.

Tipos de instrumentos de financiación

Tarjetas de crédito Se utilizan normalmente por anunciantes de autoservicio (sin ejecutivo de cuenta). Líneas de crédito Adoptan la forma de órdenes de inserción (IO) y las establecen los ejecutivos de cuenta. Líneas de crédito para múltiples handles Los anunciantes pueden financiar campañas en varios handles con este tipo de línea de crédito. Esta característica la habilita su X Account Manager, asociando los diferentes @handles a una línea de crédito específica. Por ejemplo, @NikeSB y @NikeFuel pueden tener acceso a la línea de crédito de @Nike. Este instrumento de financiación está disponible como cualquier otro. Puedes obtener los datos enviando una solicitud GET al endpoint funding_instrument. Aquí tienes una respuesta de ejemplo (ten en cuenta el CREDIT_LINE type).
      GET https://ads-api.x.com/5/accounts/a0b1c3/funding_instruments

{
    "request": {
        "params": {
            "account_id": "a0b1c3"
        }
    },
    "data": [
        {
            "start_time": "2013-05-30T04:00:00Z",
            "description": "FakeNike - Credit Line",
            "credit_limit_local_micro": 150000000000,
            "end_time": null,
            "cancelled": false,
            "id": "i1234",
            "paused": false,
            "account_id": "a0b1c3",
            "reasons_not_able_to_fund": [],
            "io_header": null,
            "currency": "USD",
            "funded_amount_local_micro": 0,
            "created_at": "2013-05-30T18:16:38Z",
            "type": "CREDIT_LINE",
            "able_to_fund": true,
            "updated_at": "2013-05-30T18:16:38Z",
            "credit_remaining_local_micro": 123661919751,
            "deleted": false,
        }
    ],
    "data_type": "funding_instrument",
    "total_count": 1,
    "next_cursor": null
}
Lo único particular de este Funding Instrument es el type y el hecho de que está disponible para todas las cuentas que están asociadas a él. Por supuesto, el crédito restante se ve afectado por todas las campañas financiadas por este instrumento, en todas las cuentas que lo comparten. Los detalles sobre qué cuentas están asociadas a una línea de crédito específica no están disponibles mediante la API (ni mediante ads.x.com). Para obtener más información sobre las enumeraciones de Funding Instrument, haz clic aquí.

Segmentación

La segmentación es un concepto fundamental de la Ads API. La segmentación se configura a nivel de línea de pedido y las opciones varían según la ubicación del anuncio. Para establecer nuevos criterios de segmentación usa POST accounts/:account_id/targeting_criteria y PUT accounts/:account_id/targeting_criteria para actualizarlos. Usa GET accounts/:account_id/line_items para obtener una lista de todas las líneas de pedido y GET accounts/:account_id/line_items/:line_item_id para recuperar una línea de pedido específica.

Opciones de segmentación por ubicación

Los productos Promoted Tweets y Promoted Accounts se pueden habilitar en una variedad de ubicaciones. Promoted Trends (PTr) no están disponibles a través de la API. Para ver las posibles combinaciones de ubicaciones, consulta el endpoint GET line_items/placements. Cada ubicación tiene diferentes opciones de segmentación. Ubicación, plataforma y género están disponibles para todas. Las demás opciones dependen del tipo de ubicación.
  • X Search: segmentación por edad, dispositivos, eventos, género, tipos de palabras clave (todas), idioma, ubicaciones, activación de red, operadores de red, plataforma, versión de la plataforma, audiencias personalizadas, solo WiFi
  • X Timeline: segmentación por edad, dispositivos, eventos, seguidores de, similares a seguidores de, género, intereses, idioma, ubicaciones, activación de red, operadores de red, tipos de palabras clave no exactas, tipos de audiencia de socios, plataforma, versión de la plataforma, tipos de resegmentación, audiencias personalizadas, tipos de segmentación por TV, solo WiFi
  • X Profiles & Tweet Details: segmentación por edad, dispositivos, eventos, seguidores de, similares a seguidores de, género, intereses, idioma, ubicaciones, activación de red, operadores de red, tipos de palabras clave no exactas, tipos de audiencia de socios, plataforma, versión de la plataforma, tipos de resegmentación, audiencias personalizadas, tipos de segmentación por TV, solo WiFi

Comprender los tipos de segmentación

Segmentación por edad: Segmenta a los usuarios según rangos de edad específicos. Puedes encontrar una lista de enumeraciones de rangos de edad en la página de Enumerations. Events: Especifica un evento para la segmentación. Solo se puede usar un evento para la segmentación (por line item). Usa el endpoint GET targeting_criteria/events para encontrar los eventos disponibles para la segmentación. Gender: Segmenta a hombres (1) o mujeres (2). Déjalo en null para segmentar a todos. Installed App Store Categories: usa este tipo de segmentación para llegar a usuarios según las categorías de apps que han instalado o en las que han indicado interés. Consulta GET targeting_criteria/app_store_categories. Interests: Segmenta a los usuarios por intereses. Obtén la lista de intereses desde GET targeting_criteria/interests. Puedes segmentar hasta 100 intereses. Followers Of: Segmenta a los seguidores de cualquier usuario totalmente promocionable de la cuenta actual (ten en cuenta que, actualmente, el titular principal de la cuenta es el único usuario totalmente promocionable de esa cuenta). Usa GET accounts/:account_id/promotable_users para obtener una lista de usuarios promocionables. Similar to Followers Of: Segmenta a personas con los mismos intereses que los seguidores de usuarios específicos. Puedes usar hasta 100 Users. Locations: Especifica hasta 2,000 ubicaciones para segmentar. Obtén la lista desde GET targeting_criteria/locations. Hay requisitos adicionales para anuncios que segmentan a ciertos países. Consulta Country Targeting and Display Requirements para obtener más información. Keywords: Las opciones de segmentación por palabras clave son específicas según el tipo de emplazamiento del anuncio. Puedes usar hasta 1,000 palabras clave para la segmentación (por line item). Consulta la sección Keyword Types para ver las opciones. Language Targeting: Segmenta a usuarios que entienden idiomas específicos. Mobile Network Operator Targeting: Permite a los anunciantes segmentar usuarios según el operador móvil, usando el tipo de segmentación NETWORK_OPERATOR de GET targeting_criteria/network_operators. New Mobile Device Targeting: Llega a los usuarios según la fecha en que accedieron por primera vez a X desde su dispositivo, usando el tipo de segmentación NETWORK_ACTIVATION_DURATION con operator_type de LT para menor que y GTE para mayor o igual que. Platforms, Platform Versions, Devices y Wifi-Only: Permiten segmentar dispositivos móviles según una variedad de vectores. Platforms es un tipo de segmentación de alto nivel que puede abarcar categorías amplias de teléfonos. Los valores de ejemplo son iOS y Android. Devices permite segmentar a usuarios de dispositivos móviles específicos, por ejemplo iPhone 5s, Nexus 4 o Samsung Galaxy Note. Platform versions permite segmentar a usuarios de versiones específicas de sistemas operativos móviles, hasta el nivel de la versión puntual. Ejemplos incluyen iOS 7.1 y Android 4.4. Wifi-Only permite segmentar solo a aquellos usuarios que usan sus dispositivos en una red WiFi; si esto no se configura, se segmentará a usuarios que usan tanto la conexión del operador como WiFi.
  • Los usuarios pueden segmentar plataformas y dispositivos si no hay superposición. Puedo segmentar BlackBerry como plataforma e iPad Air como dispositivo simultáneamente.
  • Los usuarios pueden segmentar dispositivos y versiones de sistema operativo simultáneamente. Puedo segmentar iPad Air y iOS >= 7.0.
  • Los usuarios no pueden segmentar plataformas que sean más amplias que los dispositivos. No puedo segmentar iOS e iPad Air.
[Tailored Audiences]/x-ads-api/audiences: Llega a usuarios a través de un socio de anuncios aprobado para segmentar grupos de clientes y conectar con ellos en X. TV Targeting TV Show Targeting: llega a personas que interactúan con programas de TV específicos. Este criterio de segmentación se puede configurar para dirigirse de forma continua mientras una campaña esté activa con el tipo de segmentación TV_SHOW. Usa los endpoints GET targeting_criteria/tv_markets y GET targeting_criteria/tv_shows para determinar los programas de TV disponibles. Tweet Engager Retargeting Tweet engager retargeting permite a los anunciantes segmentar audiencias en múltiples dispositivos que anteriormente hayan estado expuestas o hayan interactuado con sus Tweets promocionados u orgánicos en X. Con esta segmentación, los anunciantes pueden volver a impactar a personas que vieron o interactuaron con el contenido de un anunciante en X y que tienen más probabilidades de seguir interactuando o de convertir con mensajes u ofertas posteriores. Los usuarios serán aptos para la segmentación a los pocos minutos de la exposición o interacción y seguirán siéndolo hasta 90 días después para interacciones y 30 días para exposiciones. Tipos de segmentación de Tweet engager:
  • ENGAGEMENT_TYPE, que acepta IMPRESSION o ENGAGEMENT como valor de segmentación. Esto especifica si quieres segmentar usuarios expuestos (IMPRESSION) o usuarios que interactuaron (ENGAGEMENT).
  • CAMPAIGN_ENGAGEMENT usa un ID de campaña como valor de segmentación. Los usuarios que interactuaron con esta campaña o estuvieron expuestos a ella (según ENGAGEMENT_TYPE) son quienes serán segmentados.
  • USER_ENGAGEMENT, que usa el ID de usuario promocionado como valor de segmentación para llegar a usuarios que estuvieron expuestos o interactuaron con el contenido orgánico de un anunciante (según ENGAGEMENT_TYPE). Este debe ser el ID de usuario promocionado asociado con la cuenta de Ads.
Nota: ENGAGEMENT_TYPE es obligatorio además de al menos un valor válido de CAMPAIGN_ENGAGEMENT o USER_ENGAGEMENT. Ambos tipos de segmentación de Tweet engager pueden estar presentes y se pueden segmentar varias campañas en un mismo line item. Video Viewer Targeting: Video viewer targeting se basa en la segmentación de Tweet engager para permitir a los anunciantes segmentar audiencias que anteriormente hayan visto parte o la totalidad de un video en X. Los anunciantes pueden segmentar videos orgánicos, videos promocionados o ambos. Los videos promocionados no se limitan a campañas o line items con objetivo de visualizaciones de video. Tipos de Video Viewer Targeting:
  • VIDEO_VIEW para usuarios que han hecho clic para reproducir el video o han visto 3 segundos de reproducción automática
  • VIDEO_VIEW_PARTIAL para usuarios que han visto el 50% del video
  • VIDEO_VIEW_COMPLETE para usuarios que han visto al menos el 95% del video
Al igual que con la segmentación de Tweet engager, uno o ambos de los siguientes también deben estar presentes en los criterios de segmentación del line item cuando se usa ENGAGEMENT_TYPE:
  • CAMPAIGN_ENGAGEMENT usa un ID de campaña como valor de segmentación. Los usuarios que vieron un video (según ENGAGEMENT_TYPE) en esta campaña son quienes serán segmentados.
  • USER_ENGAGEMENT, que usa el ID de usuario promocionado como valor de segmentación para llegar a usuarios que vieron un video (según ENGAGEMENT_TYPE) en el contenido orgánico de un anunciante. Este debe ser el ID de usuario promocionado asociado con la cuenta de Ads.
Tipos de keyword Consulta nuestro documento de ayuda sobre keyword targeting para una descripción conceptual.
  • Broad (valor predeterminado): hace coincidir todas las palabras, independientemente del orden. No es sensible a mayúsculas, plurales ni tiempos verbales. Se expandirá automáticamente cuando sea posible (es decir, “car repair” también coincidiría con “automobile fix”). Si quieres segmentar sin expansión, debes añadir un signo + antes de las palabras clave, como “+boat +jet”. Usar palabras clave sin el + tendrá como valor predeterminado Broad Match.
  • Unordered (en desuso): hace coincidir todas las palabras, independientemente del orden. No es sensible a mayúsculas, plurales ni tiempos verbales.
  • Phrase: hace coincidir la cadena exacta de palabras clave; puede haber otras palabras clave presentes.
  • Exact: hace coincidir exactamente la cadena de palabras clave, y no ninguna otra.
  • Negative: evita hacer coincidir búsquedas que incluyan todas estas palabras clave en cualquier parte de la consulta, independientemente del orden en que estén escritas, incluso si hay otras palabras presentes.
  • Negative Phrase: evita hacer coincidir búsquedas que incluyan esta cadena exacta de palabras clave en cualquier parte de la consulta, incluso si hay otras palabras presentes.
  • Negative Exact: evita hacer coincidir búsquedas que coincidan exactamente con estas palabras clave y no contengan otras palabras.  
Segmentación por emoji La segmentación por emoji se admite a través de la segmentación por palabra clave. Para usar la segmentación por emoji, simplemente crea una segmentación por palabra clave para los puntos de código Unicode que representan ese emoji, como U+1F602 (xF0x9Fx98x82 en UTF-8) para el emoji de «cara con lágrimas de alegría» (😂). Los emoji que aceptamos se pueden verificar con la lista de twemoji. Al segmentar un emoji se segmentan todas sus variaciones. Para obtener un resumen de todos los valores, incluidos cuáles son obligatorios u opcionales y los detalles específicos de cada uno, consulta PUT accounts/:account_id/targeting_criteria.

Combinaciones de criterios de segmentación

Flujo de trabajo de campaña actualizado Crea campañas que se segmenten ampliamente con criterios de ubicación geográfica, género, idioma y dispositivo/plataforma. Luego, los anunciantes pueden combinar esta segmentación amplia con criterios de segmentación adicionales (por ejemplo, intereses, palabras clave, seguidores, audiencias personalizadas, TV). Si no se especifica ningún criterio de segmentación para una línea, esta línea segmentará a todos los usuarios a nivel mundial.
Tipos “primarios”Otros tipos
SeguidoresUbicaciones
Audiencias personalizadasGénero
InteresesIdiomas
Palabras claveDispositivos y plataformas
TVEdad
Los criterios de segmentación se combinarán para tu grupo de anuncios de la siguiente manera:
  • Los tipos de segmentación “primarios” se combinarán mediante (es decir, se pondrán en una unión lógica).
  • Los otros tipos de segmentación se combinarán con AND.
  • Los mismos tipos se combinarán con OR.
Algunos ejemplos De un vistazo: [(Seguidores) ∪ (Audiencias personalizadas) ∪ (Intereses) ∪ (Palabras clave)] AND (Ubicación) AND (Género) AND (Idiomas) AND (Dispositivos y plataformas) Un ejemplo geográfico: Supongamos que queremos que un grupo de anuncios de nuestra campaña se muestre a:
  • usuarios de X en EE. UU., Inglaterra y Canadá (Ubicación)
  • que sean mujeres (Género)
  • provenientes de una lista de audiencias personalizadas (“Primario”)
  • con palabras clave (“Primario”)
Los criterios de segmentación serán: [US OR GB OR CA] AND [Mujer] AND [Audiencias personalizadasPalabra clave]

Ejemplos adicionales

  • Seleccionar género y ubicación geográfica pero sin criterio principal: (Male) AND (US OR GB)
  • Seleccionar género, ubicación geográfica, intereses: (Female) AND (CA) AND (Computers OR Technology OR Startups)
  • Seleccionar género, ubicación geográfica, intereses, Audiencias personalizadas (Tailored Audiences), palabras clave: (Male) AND (GB) AND (CarsTailored Audiences for CRMautocross)

Ritmo de presupuesto

Los anunciantes ahora tienen más control sobre la velocidad a la que se gastan sus presupuestos diarios en tus campañas de Tweets promocionados y de Cuenta. Habilitar la entrega estándar, que es la opción predeterminada, garantiza una tasa de gasto uniforme a lo largo del día. Al desactivar la entrega estándar, mostraremos impresiones y generaremos interacciones tan rápido como sea posible hasta que tu presupuesto diario se agote, lo que puede ocurrir bastante temprano en el día dependiendo de la segmentación y la competencia. Esto se denomina entrega acelerada. Primeros pasos La entrega estándar es la opción predeterminada para todas las campañas, por lo que no se requiere ninguna acción a menos que desees desactivarla. Para gastar tu presupuesto diario en una campaña tan rápido como sea posible, configura el parámetro standard_delivery en false para establecer un ritmo de entrega acelerado (consulta GET accounts/:account_id/campaigns). Notas
  • El “día” corresponde a la zona horaria de la cuenta de anunciante de X (por ejemplo, America/Los_Angeles).
  • Los primeros resultados indican que la entrega estándar mejora el eCPE/CPF para los anunciantes, con una cobertura más uniforme a lo largo del día.
Para obtener información adicional sobre presupuestos y ritmo, consulta las Preguntas frecuentes sobre pujas y subastas.

Puja basada en objetivos

Gestión de campañas

Estrategia de puja

Hemos introducido el concepto de Estrategia de puja para simplificar el flujo de creación de campañas y reducir la confusión sobre las combinaciones de múltiples parámetros. Todas las combinaciones anteriores de parámetros (marcadas como heredadas) se pueden lograr estableciendo un parámetro goal equivalente. Puedes encontrar más información en el anuncio aquí. Por ejemplo:
Objetivo de la campañaAnterior (heredado)Ads API v10+
App Installsbid_type= AUTO

bid_unit = APP_INSTALLS

charge_by = APP_CLICKS
goal = APP_INSTALLS

bid_strategy = AUTO
Website Clicksbid_type = TARGET (Nota: bid_unit no era necesario para algunos objetivos de campaña)bid_strategy = TARGET

Puja objetivo

Con la puja objetivo, puedes especificar un costo objetivo que quieres pagar y la plataforma de X Ads optimizará tu campaña en función del rendimiento, manteniéndose cerca o por debajo de tu costo objetivo. Esta función te ofrece la flexibilidad de llegar a usuarios que tienen una probabilidad especialmente alta de realizar la acción deseada (como hacer clic en un enlace, generar un lead o realizar un follow), manteniendo al mismo tiempo el control de los costos. Es una función potente para anunciantes que desean más opciones para la configuración y optimización de campañas (incluidas las opciones de puja). Para los elementos de línea con objetivos de campaña compatibles, hemos introducido un nuevo mecanismo de precios para el monto de la puja que te permite especificar un costo objetivo que quieres pagar. Nuestra plataforma de anuncios puja dinámicamente en tu nombre para ayudarte a obtener más resultados, mientras trabaja para mantener tu costo promedio dentro del 20% de tu objetivo especificado. La configuración bid_strategy en los elementos de línea puede configurarse con un valor de TARGET para habilitar la puja objetivo en objetivos de campaña relevantes, como:
  • WEBSITE_CLICKS
  • WEBSITE_CONVERSIONS 
  • APP_INSTALLS 
  • APP_ENGAGEMENTS
  • REACH

Requisitos de segmentación por país y de visualización

Gestión de campañas En esta página se detallan los requisitos de segmentación y visualización específicos de cada país. Todos los socios deben cumplir estos requisitos.

Rusia

Las Políticas de anuncios de X prohíben a los anunciantes publicar anuncios dirigidos a Rusia que no estén en ruso. Cuando tus usuarios orienten específicamente sus anuncios a Rusia, debes mostrar el siguiente mensaje de advertencia a tus usuarios: Los anuncios dirigidos a Rusia deben estar en ruso.

Instrumentos de financiación gestionados por el partner

El flujo de incorporación configura una cuenta de ads.x.com asociada a la cuenta de X, que puede ser gestionada por el partner a través de la Ads API y cuyo gasto publicitario se factura al propio partner.  

Configuración inicial del partner

El proceso para configurar inicialmente a un nuevo partner de la Ads API PMFI puede tomar hasta 3 semanas a partir del intercambio de la información requerida. Debes compartir lo siguiente con tus contactos técnicos en X, así como con el contacto de X que gestione la integración con el partner para iniciar el proceso:
  • El partner debe compartir su clave pública PGP/GPG. Debe intercambiarse una clave secreta compartida entre el partner de la Ads API y X. Esta se utilizará para verificar los datos durante el flujo de incorporación.
  • El app_id o el consumer_secret de la App de X que se utilizará para acceder a la Ads API. Puedes ver y editar tus Apps de X existentes mediante el panel de Apps si has iniciado sesión en tu cuenta de X en developer.x.com. Si necesitas crear una App de X, deberás tener una cuenta de desarrollador aprobada. X permite una App para producción+sandbox y una App opcional solo para sandbox. La App de X debe crearse en una cuenta corporativa de X controlada por el partner.  

Flujo de incorporación del anunciante

El flujo de incorporación del anunciante se lleva a cabo a través de un navegador web de la siguiente manera:
  1. El usuario inicia el flujo de incorporación en el sitio web del partner e introduce el handle que desea incorporar.
  2. El partner redirige al usuario a una URL en ads.x.com con un payload firmado. Este payload contiene el app_id de la API del partner, el user_id de X del handle de X que se va a incorporar, así como una URL de callback y otros campos documentados a continuación.
  3. Se le pide al usuario que inicie sesión en ads.x.com utilizando la página de inicio de sesión estándar de x.com.
  4. Una vez que el usuario ha iniciado sesión, se inicia el proceso de incorporación. Este paso incluye la revisión de anuncios, la validación de la cuenta y otras comprobaciones.
  5. Cuando se completan todas las tareas de incorporación, el usuario es redirigido a la URL de callback proporcionada por el partner de la Ads API, con un payload que indica si se ha producido un éxito o un error. Esto incluye el proceso de autorización de tipo 3-legged.  

Carga útil de redirección de incorporación

URL para la redirección: https://ads.x.com/link_managed_account La URL de redirección se invocará con los siguientes parámetros:
NameTypeDescription
callback_urlCadena codificada en URLel usuario será redirigido a esta URL después de que se complete el proceso de vinculación de la cuenta, independientemente del resultado. Consulta la sección de URL de redirección del partner para obtener detalles sobre el protocolo
client_app_idintegerid de la App cliente de X API, usado para identificar al partner de gestión
promotable_user_idintegeruser_id de X del @handle cuyas promociones serán gestionadas por el partner de gestión. Se usa para asegurarse de que sea el mismo usuario que inicia sesión en ads.x.com para completar el proceso de vinculación
fi_descriptionString codificada en URL (máx. 255 caracteres)nombre del instrumento de financiación. Se mostrará en el campo de descripción de la API cuando se recupere el instrumento de financiación. Si se proporciona una descripción de funding_instrument, el funding_instrument existente se pondrá en pausa y se configurará un nuevo instrumento de financiación de partner gestionado. (si ya existe uno con el mismo nombre, no ocurrirá nada)
timezoneString, en formato Area/LocationEsta será la zona horaria usada para determinar el día al que se aplican los presupuestos diarios y en la que se agruparán los cargos
currencyCódigo de moneda ISO 4217Moneda que se usará para introducir pujas y en la que se facturarán los cargos
countryCódigo de país ISO 3166-1 alfa 2País de facturación de la cuenta
signatureCódigo binario codificado en base64 y codificado en URL, como se explica a continuaciónfirma que combina un secreto compartido y los otros parámetros para verificar la autenticidad de la llamada, así como la validez de los parámetros.

Carga útil de la URL de callback

La URL base de redirección se proporciona usando el parámetro callback_url en la solicitud de enlace de cuenta (ver arriba). Los parámetros agregados por ads.x.com son:
NameTypeDescription
statusstringOK se creó una cuenta o se encontró una cuenta existente y apta.

ACCOUNT_INELIGIBLE si no se cumplen las restricciones específicas del socio USER_MISMATCH la cuenta de X usada para iniciar sesión en ads.x.com era diferente del promotable_user_id en la solicitud de enlace de cuenta INCOMPLETE_SERVING_BILLING_INFO no se especificaron zona horaria, moneda o país INVALID_COUNTRY se proporcionó un valor de país no válido INVALID_CURRENCY se proporcionó un valor de moneda no válido INVALID_TIMEZONE se proporcionó un valor de zona horaria no válido
account_idURL encoded stringid de la cuenta de anuncios de X vinculada
funding_instrument_idURL encoded stringid del instrumento de financiación administrado por el socio que esté activo
signatureURL encoded, base64 encoded binary code, as explained belowFirma HMAC-SHA1 codificada en Base64 que combina un secreto compartido y los otros parámetros para verificar la autenticidad de la llamada, así como la validez de los parámetros. Para garantizar que la URL de callback solo sea válida para el user_id de X para el que estaba previsto el proceso de enlace de cuenta, se debe adjuntar el user_id de X al secreto compartido (usando &) al firmar la solicitud.
Para garantizar que la URL de callback solo sea válida para el user_id de X para el que estaba previsto el proceso de enlace de cuenta, se debe adjuntar el user_id de X al secreto compartido (usando &) al firmar la solicitud.  

Firmar las URLs de solicitud y de callback

Para garantizar que las solicitudes a /link_managed_account y la URL de callback sean válidas, las solicitudes deben firmarse en el origen y ser verificadas por el destinatario antes de que este actúe en consecuencia. Firmar la solicitud con un secreto compartido entre X y el socio gestor garantiza que cada parte solo acepte solicitudes enviadas por la contraparte autorizada. El algoritmo de generación de la firma es similar al utilizado en OAuth. Cree una cadena base de firma de la siguiente manera:
  • Convierta el método HTTP a mayúsculas y establezca la cadena base igual a este valor.
  • Agregue el carácter ‘&’ a la cadena base.
  • Codifique con porcentaje (percent-encode) la URL (sin parámetros) y agréguela a la cadena base.
  • Agregue el carácter ‘&’ a la cadena base.
  • Agregue la cadena de consulta codificada con porcentaje, que se construye de la siguiente manera:
  • Codifique con porcentaje cada clave y valor que se firmará.
  • Ordene la lista de parámetros alfabéticamente por clave.
  • Para cada par clave/valor (y con primary_promotable_user_id para la URL de redirección del socio):
  • Agregue la clave codificada con porcentaje a la cadena de consulta.
  • Agregue el carácter ‘=’ a la cadena base.
  • Agregue el valor codificado con porcentaje a la cadena de consulta.
  • Separe los pares clave=valor codificados con porcentaje con el carácter ‘&’.
  • Use el algoritmo HMAC-SHA1, utilizando como clave el secreto compartido intercambiado previamente y como valor la cadena base para generar la firma.
  • Codifique en Base64 la salida del paso 2, elimine el carácter de nueva línea final, codifique con porcentaje la firma generada en el paso 3 y añádala a la URL en un parámetro de firma.  

Ejemplos de firma

Firmar una solicitud de vinculación de cuenta URL que se firmará, suponiendo una solicitud GET: https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1 Esta URL tiene los siguientes parámetros: callback_url = https://managingpartner.com/link_account_callback\ client_app_id = 12345
fi_description = some name
promotable_user_id = 1
La cadena base, compuesta por el método HTTP y la URL sin parámetros, pasos a - d, se ve así: GET https://ads.x.com/link_managed_account La cadena de consulta (query string), producida por los subpasos de e, se ve así: callback_url=https://managingpartner.com/link_account_callback&client_app_id=12345&fi_description=some name&promotable_user_id=1 Ten en cuenta que los pares clave-valor están ordenados por nombre de clave. La cadena de consulta codificada con porcentajes (percent-encoded) se ve así: callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1 La cadena base completa, combinando los pasos a - d y e: GET https://ads.x.com/link_managed_account&callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1 Usando el algoritmo HMAC-SHA1, firmaremos esto con la palabra “secret” como clave. El resultado se codifica en Base64 y se presenta sin el “\n” final (pasos 2 y 3): KBxQMMSpKRrtg9aw3qxK4fTXvUc= Esta firma se añade (codificada con porcentajes) al final de la URL original en el parámetro signature (paso 4): https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D Firmar una URL de redirección del socio (callback de solicitud de vinculación de cuenta) La URL que se firmará, suponiendo una solicitud GET: https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF Esta URL tiene los siguientes parámetros: account_id = ABC, funding_instrument_id = DEF y status = OK La cadena base, compuesta por el método HTTP y la URL sin parámetros, pasos a - d, se ve así: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“ La cadena de consulta (query string), producida por los subpasos de e, se ve así: account_id=ABC&funding_instrument_id=DEF&status=OK La cadena de consulta codificada con porcentajes (percent-encoded) se ve así: account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK La cadena base completa, combinando los pasos a - d y e: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK Usando el algoritmo HMAC-SHA1, firmaremos esto con la palabra “secret” y la id de usuario de X para la cual se realizó la solicitud de vinculación original, 1 (promotable_user_id = 1 de arriba), como clave, “secret&1”. El resultado se codifica en Base64 y se presenta sin el “\n” final (pasos 2 y 3): jDSHDkHJIFXpPLVxtA3a9d4bPjM= Esta firma se agrega a continuación (codificada mediante percent-encoding) al final de la URL original en el parámetro signature (paso 4): https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D

Uso / renovación de claves compartidas

El algoritmo de firma debe poder operar con múltiples claves. Esto permitirá utilizar varias claves compartidas y facilitará la rotación periódica de las mismas.  

Creación de partner_managed_funding_instrument

Si se proporciona el parámetro fi_description y no existe ningún partner_managed_funding_instrument con el mismo nombre en la cuenta, se creará un nuevo partner_managed_funding_instrument y todos los partner_managed_funding_instruments existentes se pondrán en pausa. Si ya existe un partner_managed_funding_instrument con el mismo nombre, no se creará uno nuevo.  

Llamadas repetidas al flujo de incorporación / actualización del token

El flujo de incorporación se puede repetir en caso de que se haya perdido el token de acceso de la API. La implementación del flujo de incorporación requiere que el usuario haya iniciado sesión. Si el usuario coincide con el promotable_user_id, se encuentra la cuenta de anuncios asociada y todo está correcto, el usuario será redirigido nuevamente a la URL de callback, y el partner puede iniciar el flujo OAuth para obtener un token de acceso.  

Flujo de error sin redirección

Si se invoca la URL de vinculación de la cuenta con parámetros no válidos, se mostrará al usuario una página similar a la que se muestra en el flujo de OAuth cuando se proporcionan parámetros no válidos o caducados.  

Actualizaciones continuas del PMFI

Una vez que el anunciante se haya incorporado, el instrumento de financiación puede gestionarse mediante el endpoint PUT accounts/:account_id/funding_instruments/:funding_instrument_id únicamente por el partner que lo administra.

Ubicaciones

Hay varios lugares en los que se pueden mostrar los anuncios de X. Esto se configura en el elemento de línea usando el parámetro placements. Los valores posibles son:
  • ALL_ON_TWITTER
  • PUBLISHER_NETWORK
  • TWITTER_PROFILE
  • TWITTER_SEARCH
  • TWITTER_TIMELINE
  • SPOTLIGHT
  • TREND
El product_type y el objective del elemento de línea determinan qué ubicaciones están permitidas. El endpoint GET line_items/placements puede usarse para obtener las opciones de ubicación válidas para cada tipo de producto. Además, la siguiente tabla muestra las combinaciones válidas de ubicación y objetivo.
ObjetivoALL_ON_TWITTERTWITTER_PROFILETWITTER_SEARCHTWITTER_TIMELINE
APP_ENGAGEMENTS
APP_INSTALLS
REACH
FOLLOWERS
ENGAGEMENTS
VIDEO_VIEWS
PREROLL_VIEWS
WEBSITE_CLICKS
Nota: No es posible especificar únicamente la ubicación TWITTER_PROFILE. Nota: TWITTER_SEARCH requiere segmentación por palabras clave. Nota: El objetivo REACH debe incluir la ubicación TWITTER_TIMELINE. Puede incluir ALL_ON_TWITTER, cualquier combinación de ubicaciones que incluya TWITTER_TIMELINE o TWITTER_TIMELINE por sí sola.

Preguntas frecuentes sobre grupos de anuncios

Este documento es una recopilación de preguntas frecuentes sobre los grupos de anuncios en la Ads API de X.

¿Qué es un grupo de anuncios?

Los grupos de anuncios, conocidos como line items en la Ads API, existen dentro de las campañas y se utilizan para segmentar y pujar por un conjunto de usuarios de X. Los anunciantes promocionan Tweets o contenido multimedia (por ejemplo, videos que se promocionan como anuncios In-stream) al asociarlos con un line item.

¿Cómo creamos un grupo de anuncios?

Los grupos de anuncios se crean llamando a POST accounts/:account_id/line_items varias veces para el mismo id de campaña y manteniendo la segmentación (que puede ser completamente diferente) y los Tweets asociados a esos elementos de línea. Hay un límite de 100 elementos de línea por campaña y un límite de 200 campañas activas para una sola cuenta de anuncios. En el conjunto de todas las campañas, hay un límite de 8.000 elementos de línea activos por cuenta de anuncios.

¿Por qué deberíamos agregar compatibilidad con Ad Groups?

Los Ad Groups están diseñados para facilitar a los anunciantes la organización, optimización y administración de sus campañas. La ventaja de los Ad Groups es poder comparar y controlar diferentes estrategias en cuanto a pujas, presupuesto, creatividades y segmentación. Al asociar múltiples Promoted Tweets a un único line item, la subasta seleccionaría el mejor Tweet de ese grupo y luego seleccionaría el mejor Tweet para esa campaña entre todos los line items. Si se tienen varios Ad Groups con Tweets individuales, en la práctica se seleccionaría el Tweet de ese Ad Group que probablemente tendría un mejor desempeño. El uso de Ad Groups permite a un anunciante dividir la segmentación y las pujas en un número mucho mayor de combinaciones posibles y, en general, permite dividir la segmentación en grupos lógicos. En particular, las herramientas de Ads API podrían construirse en torno a reglas de optimización muy precisas con Ad Groups, algo que sería más difícil de hacer mediante ediciones manuales debido a la mayor escala de combinaciones de line items y creatividades.

¿Cómo se relaciona el presupuesto del line item con el presupuesto de la campaña en una campaña de Ad Groups?

El total_budget_amount_local_micro de un line item no puede exceder el presupuesto total de su campaña padre. Del mismo modo, el valor bid_amount_local_micro del line item no debe exceder daily_budget_amount_local_micro o total_budget_amount_local_micro de la campaña padre. Configurar estos valores de forma incorrecta puede hacer que la campaña general quede en pausa y deje de publicarse. Ten en cuenta que el presupuesto total de la campaña puede ser menor que la suma de los presupuestos de sus line items hijos, y la distribución del presupuesto entre line items depende en parte de que la herramienta de Ads API lo optimice y lo ajuste de forma eficaz, ya que el rendimiento diario de la segmentación (line item) puede diferir significativamente de un día a otro debido a la naturaleza en tiempo real de X.

¿Tienen mejor rendimiento los grupos de anuncios que los line items individuales?

El rendimiento de una campaña depende de muchos factores y, en última instancia, un Tweet es el factor decisivo del rendimiento. Un Line Item se considerará un factor que determina si un Tweet siquiera entra en consideración para mostrarse a un usuario. Los line items que segmentan a los mismos conjuntos de usuarios se consideran que tienen un solapamiento de usuarios. Se considera una práctica recomendada reducir este solapamiento de segmentación entre line items para que los conjuntos de usuarios con mejor rendimiento puedan identificarse con claridad.

Guías

Objetivo de vistas de video preroll

La siguiente guía describe los pasos necesarios para configurar una campaña PREROLL_VIEWS en la Ads API. En términos generales, estas campañas se dividen en dos tipos: Categorías seleccionadas y Categorías de contenido (denominadas Categorías estándar en la interfaz de Ads).  

Endpoints necesarios

Pasos

Subir el video

Subir el video consta de 2 pasos:

Cargar el contenido multimedia de video

Primero, usando el endpoint de carga de contenido multimedia segmentada, cargarás el video en X para su procesamiento. Debes pasar media_category=amplify_video en la llamada INIT inicial usando este endpoint. Cargarás el video por partes. Una vez que STATUS devuelva un state de succeeded, puedes continuar con los siguientes pasos. Puedes encontrar más información sobre la carga de contenido multimedia usando el endpoint segmentado en nuestra Descripción general de video promocionado.

Agregar el video a la cuenta de anuncios

Una vez que el estado que devuelve el comando STATUS sea succeeded, deberás usar el media_key devuelto por ese endpoint para agregar el video a la biblioteca de medios del anunciante, usando el endpoint POST accounts/:account_id/media_library.
POST https://ads-api.x.com/8/55w3kv/media\_library?media\_key=3_931236738554519552

{
 "request": {
   "params": {
     "account_id": "55w3kv",
     "media\_key": "3\_931236738554519552"
   }
 },
 "data": {
   "tweeted": false,
   "name": null,
   "file_name": null,
   "media\_url": "https://video.twimg.com/amplify\_video/1059840836186165250/vid/568x320/Gr2l1fB1X7xotKwC.mp4?tag=8",
   "media\_category": "AMPLIFY\_VIDEO",
   "media\_key": "3\_931236738554519552",
   "created_at": "2017-11-16T19:05:14Z",
   "media\_status": "TRANSCODE\_COMPLETED",
   "media_id": 931236738554519552,
   "media_type": "VIDEO",
   "updated_at": "2017-11-16T19:05:23Z",
   "deleted": false
 }
}

Configura la campaña

Creación de campaña

Crea la campaña y el line item/grupo de anuncios. Los line items se deben crear con un objective de VIDEO_VIEWS_PREROLL y un product_type de MEDIA. El parámetro categories también se debe establecer en las categorías comerciales del anunciante correspondientes.
POST https://ads-api.x.com/8/accounts/55w3kv/campaigns?name=test-curated-categories-api&funding\_instrument\_id=103hp9&start\_time=2021-02-10&entity\_status=PAUSED&daily\_budget\_amount\_local\_micro=55000000

{
  "request": {
    "params": {
      "name": "test-curated-categories-api",
      "start_time": "2021-02-10T00:00:00Z",
      "daily\_budget\_amount\_local\_micro": 55000000,
      "funding\_instrument\_id": "103hp9",
      "entity_status": "PAUSED",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
      "EXPIRED",
      "PAUSED\_BY\_ADVERTISER",
      "FUNDING_PROBLEM"
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "PAUSED",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "PAUSED",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

Creación de line items

Los line items deben tener el parámetro categories establecido con el conjunto apropiado de categorías IAB, obtenidas mediante el endpoint GET content_categories. Cada una de estas categorías de contenido corresponde a una o más categorías IAB. Para poder utilizar estos valores, los socios deben seleccionar una categoría de contenido adecuada y usar el conjunto completo de iab_categories devuelto en la respuesta para establecer el parámetro categories en el endpoint de line items. Cualquier aplicación parcial de las iab_categories tendrá como resultado que todo el grupo se establezca en el line item. Por ejemplo,
GET https://ads-api.x.com/8/advertiser\_business\_categories

{
  "request": {
    "params": {}
  },
  "next_cursor": null,
  "data": \[
    {
      "id": "1jl",
      "name": "Bienes de consumo envasados",
      "iab_categories": \[
        "IAB9-26",
        "IAB9-18",
        "IAB9-29",
        "IAB9-1",
        "IAB9-8",
        "IAB9-22",
        "IAB6",
        "IAB9-5",
        "IAB9-12",
        "IAB9-11",
        "IAB9-23",
        "IAB9-14",
        "IAB4",
        "IAB9-25",
        "IAB9-17",
        "IAB23",
        "IAB9-24",
        "IAB9-13",
        "IAB16",
        "IAB9-4",
        "IAB9-9",
        "IAB9-20",
        "IAB22",
        "IAB9-28",
        "IAB9-27",
        "IAB9-16",
        "IAB9-31",
        "IAB9-3",
        "IAB9-19",
        "IAB10",
        "IAB9-2",
        "IAB9-6",
        "IAB9-21",
        "IAB9-10",
        "IAB9-15"
      \]
    },
    {
      "id": "1jm",
      "name": "Salud y farmacéutica",
      "iab_categories": \[
        "IAB7"
      \]
    },
    {
      "id": "1jn",
      "name": "Alcohol",
      "iab_categories": \[
        "IAB8-5",
        "IAB8-18"
      \]
    },
    {
      "id": "1jo",
      "name": "Gastronomía",
      "iab_categories": \[
        "IAB8-10",
        "IAB8-8",
        "IAB8-7",
        "IAB8-15",
        "IAB8-3",
        "IAB8-4",
        "IAB8-1",
        "IAB8-16",
        "IAB8-12",
        "IAB8-13",
        "IAB8-17",
        "IAB8-11",
        "IAB8-6",
        "IAB8-9",
        "IAB8-2",
        "IAB8-14"
      \]
    },
    {
      "id": "1jp",
      "name": "Servicios financieros",
      "iab_categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \]
    },
    {
      "id": "1jq",
      "name": "Comercio minorista",
      "iab_categories": \[
        "IAB18"
      \]
    },
    {
      "id": "1jr",
      "name": "Viajes",
      "iab_categories": \[
        "IAB20"
      \]
    },
    {
      "id": "1js",
      "name": "Videojuegos",
      "iab_categories": \[
        "IAB9-30"
      \]
    },
    {
      "id": "1jt",
      "name": "Tecnología",
      "iab_categories": \[
        "IAB19-22",
        "IAB19-13",
        "IAB19-4",
        "IAB19-33",
        "IAB19-26",
        "IAB19-3",
        "IAB19-16",
        "IAB19-9",
        "IAB19-32",
        "IAB19-25",
        "IAB19-30",
        "IAB19-36",
        "IAB19-21",
        "IAB5",
        "IAB19-12",
        "IAB19-28",
        "IAB19-17",
        "IAB19-8",
        "IAB19-7",
        "IAB19-24",
        "IAB15",
        "IAB19-11",
        "IAB19-31",
        "IAB19-20",
        "IAB19-15",
        "IAB19-1",
        "IAB19-35",
        "IAB19-29",
        "IAB19-34",
        "IAB19-23",
        "IAB19-2",
        "IAB19-5",
        "IAB19-14",
        "IAB19-27",
        "IAB19-10",
        "IAB19-19"
      \]
    },
    {
      "id": "1ju",
      "name": "Telecomunicaciones",
      "iab_categories": \[
        "IAB19-6",
        "IAB19-18"
      \]
    },
    {
      "id": "1jv",
      "name": "Automotriz",
      "iab_categories": \[
        "IAB2"
      \]
    },
    {
      "id": "1jw",
      "name": "Medios y entretenimiento",
      "iab_categories": \[
        "IAB14-8",
        "IAB14-4",
        "IAB1-5",
        "IAB14-7",
        "IAB1-7",
        "IAB17",
        "IAB14-3",
        "IAB1-1",
        "IAB12",
        "IAB1-6",
        "IAB25-1",
        "IAB1-2",
        "IAB14-2",
        "IAB14-6",
        "IAB1-3",
        "IAB1-4",
        "IAB14-5"
      \]
    },
    {
      "id": "1jx",
      "name": "Política",
      "iab_categories": \[
        "IAB11-4"
      \]
    },
    {
      "id": "1jy",
      "name": "Juegos de azar",
      "iab_categories": \[
        "IAB9-7"
      \]
    },
    {
      "id": "1jz",
      "name": "Citas",
      "iab_categories": \[
        "IAB14-1"
      \]
    },
    {
      "id": "1k0",
      "name": "Sin fines de lucro",
      "iab_categories": \[
        "IAB11-1",
        "IAB11-2",
        "IAB11-3",
        "IAB11-5"
      \]
    }
  \]
}
Ahora, para establecer el parámetro categories en “Science & Education”, es necesario definir el conjunto completo de iab_categories, es decir, "IAB5", "IAB15", en el line item, de la siguiente manera:
POST https://ads-api.x.com/8/accounts/55w3kv/line\_items?campaign\_id=f2rp3&bid\_amount\_local\_micro=5500000&name=curated-category-line-item&product\_type=MEDIA&placements=ALL\_ON\_TWITTER&objective=PREROLL_VIEWS&categories=IAB3,IAB13,IAB21

{
  "request": {
    "params": {
      "name": "curated-category-line-item",
      "placements": \[
        "ALL\_ON\_TWITTER"
      \],
      "bid\_amount\_local_micro": 5500000,
      "product_type": "MEDIA",
      "objective": "PREROLL_VIEWS",
      "account_id": "55w3kv",
      "categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \],
      "campaign_id": "f2rp3"
    }
  },
  "data": {
    "bid_type": "MAX",
    "advertiser\_user\_id": 312226591,
    "name": "curated-category-line-item",
    "placements": \[
      "ALL\_ON\_TWITTER"
    \],
    "start_time": null,
    "bid\_amount\_local_micro": 5500000,
    "automatically\_select\_bid": false,
    "advertiser_domain": null,
    "target\_cpa\_local_micro": null,
    "raw_categories": \[
      "x",
      "5l",
      "9z"
    \],
    "primary\_web\_event_tag": null,
    "charge\_by": "VIEW\_3S_100PCT",
    "product\_type": "PROMOTED\_TWEETS",
    "end_time": null,
    "duration\_in\_days": null,
    "bid\_unit": "VIEW\_3S_100PCT",
    "total\_budget\_amount\_local\_micro": null,
    "objective": "PREROLL_VIEWS",
    "id": "iqwka",
    "entity_status": "ACTIVE",
    "automatic\_tweet\_promotion": null,
    "optimization": "DEFAULT",
    "frequency_cap": null,
    "android\_app\_store_identifier": null,
    "categories": \[
      "IAB3",
      "IAB13",
      "IAB21"
    \],
    "currency": "USD",
    "created_at": "2021-02-09T00:00:46Z",
    "tracking_tags": \[\],
    "ios\_app\_store_identifier": null,
    "amplify_config": {
      "auto_promote": true,
      "is_open": true
    },
    "updated_at": "2021-02-09T00:00:46Z",
    "campaign_id": "f2rp3",
    "creative_source": "MANUAL",
    "deleted": false
  }
}

Selección de publishers

Un anunciante puede optar por orientar la segmentación a una Categoría de contenido o a una Categoría seleccionada, con detalles adicionales descritos a continuación.  Nota:  Los line items pueden segmentar a Categorías seleccionadas o a Categorías de contenido, pero no a ambas a la vez. 

Categorías seleccionadas

Las Categorías seleccionadas permiten a los anunciantes dirigirse a un grupo preestablecido de publishers y se pueden recuperar mediante el endpoint GET curated_categories. Estas categorías son específicas de cada país y, por lo tanto, requieren que el elemento de línea tenga como objetivo el país adecuado según el country_code de la categoría. Para poder usar una de estas categorías, se deben seguir los siguientes pasos en el orden específico indicado:
  1. El elemento de línea debe dirigirse al país adecuado según el country_code de la Categoría seleccionada.
  2. Se debe usar el endpoint POST line_item_curated_categories para asociar el elemento de línea con un curated_category_id específico.
Nota: Asociar un elemento de línea con una categoría seleccionada también limitará el número de publishers que se pueden incluir en la denylist a 5. La lista completa de user_id utilizados para colocar publishers específicos en la denylist se puede recuperar desde el endpoint GET publishers. Además, un elemento de línea dado no puede dirigirse a más de una Categoría seleccionada a la vez. El siguiente ejemplo ilustra cómo asociar un id de categoría seleccionada: b0xt, que solo está disponible en los EE. UU., con el elemento de línea creado en el paso anterior. Primero, los criterios de segmentación del elemento de línea se configuran con el valor 96683cc9126741d
GET https://ads-api.x.com/8/targeting\_criteria/locations?country\_code=US&location_type=COUNTRIES

{
  "data": \[
    {
      "name": "United States",
      "country_code": "US",
      "location_type": "COUNTRIES",
      "targeting_value": "96683cc9126741d1",
      "targeting_type": "LOCATION"
    }
  \],
  "request": {
    "params": {
      "location_type": "COUNTRIES",
      "country_code": "US"
    }
  },
  "next_cursor": null
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwka",
      "targeting_type": "LOCATION",
      "targeting_value": "96683cc9126741d1",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "United States",
      "raw_negated": false,
      "raw\_targeting\_value": "2",
      "id": "rv9hmc",
      "raw\_targeting\_type": "GEO",
      "raw\_operator\_type": "EQUAL_TO",
      "location_type": "COUNTRIES",
      "operator_type": "EQ",
      "created_at": "2021-02-09T00:06:28Z",
      "targeting_value": "96683cc9126741d1",
      "updated_at": "2021-02-09T00:06:28Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "96683cc9126741d1",
        "targeting_type": "LOCATION"
      },
      "operation_type": "Create"
    }
  \]
}

POST https://ads-api.x.com/8/accounts/55w3kv/line\_item\_curated\_categories?line\_item\_id=iqwka&curated\_category_id=9ddrgesiap6o

{
  "request": {
    "params": {
      "curated\_category\_id": "9ddrgesiap6o",
      "line\_item\_id": "iqwka",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "line\_item\_id": "iqwka",
    "curated\_category\_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T17:26:42Z",
    "deleted": false
  }
}

Categorías de contenido

Las categorías de contenido, también conocidas como Categorías estándar, se pueden recuperar desde el endpoint GET curated_categories. Estas categorías luego se pueden segmentar en el elemento de línea utilizando los endpoints de criterios de segmentación por lotes. El siguiente ejemplo ilustra cómo seleccionar una categoría de contenido en particular, id: sr, que corresponde a “News & Current Events” y aplicarla al elemento de línea.
Nota: El conjunto completo de iab_categories en la respuesta de GET curated_categories debe segmentarse mediante el endpoint de criterios de segmentación. De no hacerlo, se producirá un error de validación. 
GET https://ads-api.x.com/8/content_categories
{
      "name": "News & Current Events",
      "id": "sr",
      "iab_categories": \[
        "IAB12",
        "IAB14"
      \],
      "publishers\_in\_last\_thirty\_days": 124,
      "videos\_monetized\_in\_last\_thirty_days": 5429
    }
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB12",
      "operator_type": "EQ"
    }
  },
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB14",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwls",
      "name": "News",
      "raw_negated": false,
      "raw\_targeting\_value": "5h",
      "id": "saib9p",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB12",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    },
    {
      "line\_item\_id": "iqwls",
      "name": "Society",
      "raw_negated": false,
      "raw\_targeting\_value": "5y",
      "id": "saib9q",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB14",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB12",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB14",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    }
  \]
}
Asociar el contenido multimedia de la cuenta (vídeo) con el elemento de línea
Utiliza el endpoint POST accounts/:account_id/media_creatives para asociar el vídeo con un grupo de anuncios.
POST https://ads-api.x.com/8/accounts/55w3kv/media_creatives
line\_item\_id=4bii5&account\_media\_id=knb

{
 "data":{
   "account\_media\_id":"74g",
   "approval_status":"ACCEPTED",
   "created_at":"2016-02-11T22:23:23Z",
   "deleted":false,
   "id":"qeq",
   "landing_url":null,
   "line\_item\_id":"4bii5",
   "serving_status":"ACTIVE",
   "updated_at":"2016-02-11T22:23:23Z"
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "account\_media\_id":"knb"
   }
 }
}

Configurar el CTA y la URL de destino

Es importante tener en cuenta que, a diferencia de la mayoría de las demás campañas en X, el objetivo VIDEO_VIEWS_PREROLL no utiliza Promoted Tweets ni Cards. En su lugar, el creativo de video se asocia a tu grupo de anuncios (line item) y la información del CTA se asocia a una entidad preroll_call_to_action. El endpoint POST accounts/:account_id/preroll_call_to_action te permite controlar el botón de CTA y la URL de destino.
POST https://ads-api.x.com/8/accounts/55w3kv/preroll\_call\_to_action
line\_item\_id=4bii5&call\_to\_action=VISIT\_SITE&call\_to\_action\_url=https%3A%2F%2Fx.com%2FAdsAPI

{
 "data":{
   "id":"aaa111",
   "line\_item\_id":"4bii5",
   "call\_to\_action":"WATCH_NOW",
   "call\_to\_action_url":"https://x.com/AdsAPI",
   "created_at":"2016-02-11T22:23:23Z",
   "updated_at":"2016-02-11T22:23:23Z",
   "deleted":false
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "call\_to\_action":"VISIT_SITE",
     "call\_to\_action_url":"https://x.com/AdsAPI"
   }
 }
}

Definir criterios de segmentación

El criterio de segmentación utilizado para anuncios de video pre-roll solo está disponible mediante nuestro endpoint de criterios de segmentación por lotes POST batch/accounts/:account_id/targeting_criteria. Utiliza CONTENT_PUBLISHER_USER como segmentación negativa para excluir que el anuncio se asocie con un conjunto de usuarios. Proporciona el user_id de X o el publisher_user_id de las cuentas que desees excluir. El endpoint GET publishers se puede usar para obtener la lista de user_id que se van a excluir para Categorías de contenido. El publisher_user_id devuelto en la respuesta de GET curated_categories se puede usar para obtener una lista de exclusión similar para Categorías seleccionadas. Nota: Se puede excluir un máximo de 5 publisher_user_id para Categorías seleccionadas y 50 user_id para Categorías de contenido.
POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "CONTENT\_PUBLISHER_ID",
      "targeting_value": "1917731",
      "operator_type": "NE"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "realsaltlake",
      "raw_negated": true,
      "raw\_targeting\_value": "aajwo",
      "id": "sajk32",
      "raw\_targeting\_type": "CONTENT_PUBLISHER",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "NE",
      "created_at": "2021-03-30T18:02:32Z",
      "targeting_value": 17288520,
      "updated_at": "2021-03-30T18:02:32Z",
      "deleted": false,
      "targeting\_type": "CONTENT\_PUBLISHER_USER"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "NE",
        "targeting_value": "17288520",
        "targeting\_type": "CONTENT\_PUBLISHER_USER"
      },
      "operation_type": "Create"
    }
  \]
}

Lanzar la campaña

Cuando estés listo para lanzar tu campaña, simplemente reanúdala usando PUT accounts/:account_id/campaigns/:id. PUT https://ads-api.x.com/8/accounts/55w3kv/campaigns/f2rp3? entity_status=ACTIVE
{
  "request": {
    "params": {
      "campaign_id": "f2rp3",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "ACTIVE",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "ACTIVE",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

Analítica

La analítica de las campañas VIDEO_VIEWS_PREROLL está disponible a través de nuestros endpoints de estadísticas.

Segmentación por palabra clave en líneas de tiempo

La segmentación por palabra clave es fundamental para nuestros productos de Tweets promocionados, ya que permite que las campañas logren un mayor alcance. La segmentación por palabra clave en la línea de tiempo permite a las plataformas llegar a usuarios de X en función de las palabras clave presentes en sus Tweets recientes. Por ejemplo, si un anunciante orienta su segmentación a la combinación de palabras clave sin orden específico “plan + trip” y un usuario hace un Tweet que dice: “I’m starting to plan my trip to Cabo, any suggestions?” mientras la campaña está activa, es posible que ese usuario vea poco después el Tweet promocionado de ese anunciante.

¿Cómo funciona?

TL;DR: desde la perspectiva de la API, este cambio es bastante sencillo: ahora puedes segmentar por palabras clave en Tweets promocionados en Timeline. Solo tienes que establecer targeting_type en unordered_keywords o phrase_keywords para los line items.

Guía de inicio rápido

Referencia de la API

Cuentas

GET accounts

Recupera detalles de algunas o todas las cuentas con publicidad habilitada a las que el usuario autenticado tiene acceso. URL del recurso https://ads-api.x.com/12/accounts Parámetros
NombreDescripción
account_ids
optional
Limita la respuesta únicamente a las ID de cuenta deseadas especificando una lista de identificadores separados por comas.

Type: string

Example: 18ce54d4x5t
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud independiente.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
q
optional
Una consulta opcional para restringir el recurso por name.

Note: Esto realiza una coincidencia de prefijo sin distinguir mayúsculas de minúsculas.

Type: string

Longitud mín., máx.: 1, 255
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Valores posibles: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Note: Este parámetro y cursor son excluyentes.

Note: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.

Type: boolean

Default: false
Valores posibles: true, false

Solicitud de ejemplo

GET https://ads-api.x.com/12/accounts?account_ids=18ce54d4x5t
Respuesta de ejemplo
       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
           {
             "name": "API McTestface",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": "2016-07-21T07:00:00Z",
             "id": "18ce54d4x5t",
             "created_at": "2016-07-21T22:42:09Z",
             "updated_at": "2017-07-06T16:51:04Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

GET accounts/:account_id

Obtiene una cuenta específica a la que el usuario autenticado tiene acceso. Resource URL https://ads-api.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts.

La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t Example Response
       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
           }
         },
         "data": {
           "name": "API McTestface",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TRAVEL",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

POST accounts

Nota: SOLO SANDBOX Crea una cuenta de anuncios en el entorno sandbox. URL del recurso https://ads-api-sandbox.x.com/12/accounts Parámetros Ninguno Ejemplo de solicitud POST https://ads-api-sandbox.x.com/12/accounts Ejemplo de respuesta
       {
         "request": {
           "params": {}
         },
         "next_cursor": null,
         "data": [
           {
             "name": "Sandbox account",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": null,
             "id": "gq12fh",
             "created_at": "2016-07-18T23:02:20Z",
             "updated_at": "2016-07-18T23:02:20Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

PUT accounts/:account_id

Actualiza el nombre de la cuenta y/o el tipo de industria. URL del recurso https://ads-api.x.com/12/accounts/:account_id Parámetros
NombreDescripció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 con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
name
optional
El nombre de la cuenta.

Tipo: string

Ejemplo: API McTestface
industry_type
optional
Industria a la que pertenece la cuenta.

Tipo: string

Valores posibles: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER
Ejemplo de solicitud PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY Ejemplo de respuesta
       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
             "name"": "API McTestface 2",
             "industry_type": "TECHNOLOGY"
           }
         },
         "data": {
           "name": "API McTestface 2",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TECHNOLOGY",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

DELETE accounts/:account_id

Nota: SOLO ENTORNO SANDBOX Elimina una cuenta de anuncios en el entorno de sandbox. URL del recurso https://ads-api-sandbox.x.com/12/accounts/:account_id Parámetros
NameDescription
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, excluyendo GET accounts.

La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
Ejemplo de solicitud DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh Ejemplo de respuesta
       {
         "data": {
           "name": "Sandbox account",
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": null,
           "id": "gq12fh",
           "created_at": "2016-07-18T23:02:20Z",
           "updated_at": "2017-08-23T18:21:10Z",
           "approval_status": "ACCEPTED",
           "deleted": true
         },
         "request": {
           "params": {
             "account_id": "gq12fh"
           }
         }
       }

Apps de la cuenta

Ejecutar en Postman ❯

GET account_apps

Recupera detalles de todas las aplicaciones móviles que están asociadas con la cuenta de anuncios especificada. Resource URL https://ads-api.x.com/12/accounts/:account_id/account_apps Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
count
optional
Especifica la cantidad de registros que se intentarán recuperar por cada solicitud distinta.

Tipo: int

Predeterminado: 200
Mín., Máx.: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
sort_by
optional
Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para obtener más información.

Tipo: string

Ejemplo: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Predeterminado: false
Valores posibles: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son mutuamente excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 cada 15 minutos.

Tipo: boolean

Predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps Example Response
       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
          {
            "app_store_identifier": "com.twitter.android",
            "conversion_tracking_enabled": false,
            "deep_link_pattern": "twitter://",
            "id": "4x",
            "created_at": "2019-06-20T22:36:16Z",
            "updated_at": "2021-10-19T20:05:29Z",
            "os_type": "Android",
            "deleted": false
          }
         ]
       }

Historial de la cuenta

GET accounts/:account_id/account_history

Recupera un resumen de los cambios realizados en el entity_id especificado en la solicitud. Nota: Este endpoint se encuentra actualmente en versión beta y requiere inclusión en una lista de permitidos (allowlist). URL de recurso https://ads-api.x.com/12/accounts/:account_id/account_history Parámetros
NombreDescripción
account_id
obligatorio
El identificador de la cuenta asociada.

Tipo: string

Ejemplo: 18ce54d4x5t
count
opcional
Especifica el número de registros que se intentan recuperar por cada solicitud distinta.

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
entity_type
obligatorio
El tipo de entidad para la que se desea recuperar datos.

Tipo: enum

Ejemplo: PROMOTED_TWEET
Valores posibles: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT
entity_id
obligatorio
La entidad específica para la que se desea recuperar datos.

Tipo: string

Ejemplo: 8u94t
start_time
obligatorio
Limita los datos recuperados a la hora de inicio especificada, expresada en ISO 8601.

Nota: Debe expresarse en horas completas (0 minutos y 0 segundos).

Tipo: string

Ejemplo: 2017-05-19T07:00:00Z
end_time
obligatorio
Limita los datos recuperados a la hora de finalización especificada, expresada en ISO 8601.

Nota: Debe expresarse en horas completas (0 minutos y 0 segundos).

Tipo: string

Ejemplo: 2017-05-26T07:00:00Z
user_id
opcional
Limita la respuesta a un usuario específico.

Tipo: long

Ejemplo: 3271358660
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "entity": "CAMPAIGN",
          "entity_id": "fc3h5",
          "count": 1
        }
      },
      "next_cursor": "1r2407sb4lc",
      "data": [
        {
          "change_by": {
            "user_id": "982978172",
            "platform": "API_OTHER"
          },
          "changes": {},
          "change_time": "2021-04-02T20:55:42Z",
          "entity_id": "fc3h5",
          "entity": "CAMPAIGN",
          "entity_data": {
            "name": "test_campaign",
            "start_time": "2021-04-02T18:59:11Z",
            "purchase_order_number": null,
            "daily_budget_amount_local_micro": 100000000,
            "end_time": null,
            "duration_in_days": null,
            "standard_delivery": true,
            "total_budget_amount_local_micro": 100000000,
            "entity_status": "ACTIVE",
            "frequency_cap": null,
            "created_at": "2021-04-02T20:55:42Z",
            "updated_at": "2021-04-02T20:55:42Z",
            "deleted": false
          },
          "change_type": "CREATE"
        }
      ]
    }

Categorías empresariales del anunciante

GET advertiser_business_categories

Solicita las categories de negocio de anunciante válidas para Grupos de anuncios (line_items) y que describen la marca de un anunciante a los editores. Nota: Estas categorías se aplican solo a line_items con el objetivo PREROLL_VIEWS y son independientes de las content_categories usadas para los criterios de segmentación. Cada advertiser_business_categories representa una colección de Categorías IAB. Al crear un Grupo de anuncios con el objetivo PREROLL_VIEWS, se deben definir una o dos advertiser_business_categories para el Grupo de anuncios. Esto se puede hacer configurando el valor del parámetro de solicitud categories en el endpoint de line item al conjunto de iab_categories correspondientes disponibles a través de este endpoint. Encontrarás más detalles en la Guía del objetivo de Video Views Preroll URL del recurso https://ads-api.x.com/12/advertiser_business_categories Parámetros Sin parámetros de solicitud Ejemplo de solicitud GET https://ads-api.x.com/12/advertiser_business_categories Ejemplo de respuesta
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "id": "1jl",
          "name": "Bienes de consumo envasados",
          "iab_categories": [
            "IAB9-26",
            "IAB9-18",
            "IAB9-29",
            "IAB9-1",
            "IAB9-8",
            "IAB9-22",
            "IAB6",
            "IAB9-5",
            "IAB9-12",
            "IAB9-11",
            "IAB9-23",
            "IAB9-14",
            "IAB4",
            "IAB9-25",
            "IAB9-17",
            "IAB23",
            "IAB9-24",
            "IAB9-13",
            "IAB16",
            "IAB9-4",
            "IAB9-9",
            "IAB9-20",
            "IAB22",
            "IAB9-28",
            "IAB9-27",
            "IAB9-16",
            "IAB9-31",
            "IAB9-3",
            "IAB9-19",
            "IAB10",
            "IAB9-2",
            "IAB9-6",
            "IAB9-21",
            "IAB9-10",
            "IAB9-15"
          ]
        },
        {
          "id": "1jm",
          "name": "Health & Pharma",
          "iab_categories": [
            "IAB7"
          ]
        },
        {
          "id": "1jn",
          "name": "Alcohol",
          "iab_categories": [
            "IAB8-5",
            "IAB8-18"
          ]
        },
        {
          "id": "1jo",
          "name": "Dining",
          "iab_categories": [
            "IAB8-10",
            "IAB8-8",
            "IAB8-7",
            "IAB8-15",
            "IAB8-3",
            "IAB8-4",
            "IAB8-1",
            "IAB8-16",
            "IAB8-12",
            "IAB8-13",
            "IAB8-17",
            "IAB8-11",
            "IAB8-6",
            "IAB8-9",
            "IAB8-2",
            "IAB8-14"
          ]
        },
        {
          "id": "1jp",
          "name": "Financial Services",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ]
        },
        {
          "id": "1jq",
          "name": "Retail",
          "iab_categories": [
            "IAB18"
          ]
        },
        {
          "id": "1jr",
          "name": "Travel",
          "iab_categories": [
            "IAB20"
          ]
        },
        {
          "id": "1js",
          "name": "Gaming",
          "iab_categories": [
            "IAB9-30"
          ]
        },
        {
          "id": "1jt",
          "name": "Technology",
          "iab_categories": [
            "IAB19-22",
            "IAB19-13",
            "IAB19-4",
            "IAB19-33",
            "IAB19-26",
            "IAB19-3",
            "IAB19-16",
            "IAB19-9",
            "IAB19-32",
            "IAB19-25",
            "IAB19-30",
            "IAB19-36",
            "IAB19-21",
            "IAB5",
            "IAB19-12",
            "IAB19-28",
            "IAB19-17",
            "IAB19-8",
            "IAB19-7",
            "IAB19-24",
            "IAB15",
            "IAB19-11",
            "IAB19-31",
            "IAB19-20",
            "IAB19-15",
            "IAB19-1",
            "IAB19-35",
            "IAB19-29",
            "IAB19-34",
            "IAB19-23",
            "IAB19-2",
            "IAB19-5",
            "IAB19-14",
            "IAB19-27",
            "IAB19-10",
            "IAB19-19"
          ]
        },
        {
          "id": "1ju",
          "name": "Telecommunication",
          "iab_categories": [
            "IAB19-6",
            "IAB19-18"
          ]
        },
        {
          "id": "1jv",
          "name": "Auto",
          "iab_categories": [
            "IAB2"
          ]
        },
        {
          "id": "1jw",
          "name": "Media & Entertainment",
          "iab_categories": [
            "IAB14-8",
            "IAB14-4",
            "IAB1-5",
            "IAB14-7",
            "IAB1-7",
            "IAB17",
            "IAB14-3",
            "IAB1-1",
            "IAB12",
            "IAB1-6",
            "IAB25-1",
            "IAB1-2",
            "IAB14-2",
            "IAB14-6",
            "IAB1-3",
            "IAB1-4",
            "IAB14-5"
          ]
        },
        {
          "id": "1jx",
          "name": "Politics",
          "iab_categories": [
            "IAB11-4"
          ]
        },
        {
          "id": "1jy",
          "name": "Gambling",
          "iab_categories": [
            "IAB9-7"
          ]
        },
        {
          "id": "1jz",
          "name": "Dating",
          "iab_categories": [
            "IAB14-1"
          ]
        },
        {
          "id": "1k0",
          "name": "Non-Profit",
          "iab_categories": [
            "IAB11-1",
            "IAB11-2",
            "IAB11-3",
            "IAB11-5"
          ]
        }
      ]
    }

Estimación de la audiencia

POST accounts/:account_id/audience_estimate

Determina el tamaño aproximado de la audiencia de tus campañas.

Este endpoint acepta un array de objetos JSON que contienen los parámetros para los objetos de criterios de segmentación. Una lista de parámetros de criterios de segmentación obligatorios y opcionales está disponible en el endpoint POST accounts/:account_id/targeting_criteria. Las solicitudes deben ser HTTP POST con un cuerpo JSON y un encabezado Content-Type: application/json. Nota: Es obligatorio que especifiques al menos un criterio de segmentación principal; puedes ver una lista de todos los criterios de segmentación principales en nuestra página de segmentación de campañas. URL de recurso https://ads-api.x.com/12/accounts/:account_id/audience_estimate Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta empleada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes del Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
targeting_criteria
required
Objeto JSON que contiene todos los parámetros para los objetos de criterios de segmentación. Una lista de parámetros de criterios de segmentación obligatorios y opcionales está disponible en el endpoint POST accounts/:account_id/targeting_criteria.
operator_type
optional
Especifica la relación que debe tener el criterio de segmentación. Por ejemplo, para establecer segmentación negativa (excluida), usa operator_type=NE.

Tipo: enum

Valores posibles: EQ, NE

Predeterminado: EQ
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate
    {
        "targeting_criteria": [
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "nba",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "tech",
                "operator_type": "NE"
            },
            {
                "targeting_type": "LOCATION",
                "targeting_value": "96683cc9126741d1",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "14230524"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "90420314"
            }
        ]
    }
Ejemplo de respuesta
    {
      "request": {
        "params": {
          "targeting_criteria": null,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "audience_size": {
          "min": 38236294,
          "max": 42261167
        }
      }
    }

Acceso de usuario autenticado

GET accounts/:account_id/authenticated_user_access

Recupera los permisos del usuario actualmente autenticado (access_token) en relación con la cuenta de anuncios especificada. Estos permisos coinciden con los expuestos en ads.x.com. Los valores posibles incluyen:
  • ACCOUNT_ADMIN: Acceso completo para modificar campañas y ver estadísticas, incluida la capacidad de agregar o eliminar usuarios y cambiar la configuración
  • AD_MANAGER: Acceso completo para modificar campañas y ver estadísticas, pero no puede agregar o eliminar usuarios ni cambiar la configuración
  • CREATIVE_MANAGER: Acceso para modificar creatividades y ver vistas previas, pero sin acceso para crear o modificar campañas
  • CAMPAIGN_ANALYST: Acceso para ver campañas y ver estadísticas, pero sin acceso para crear o modificar campañas
  • ANALYST (“Organic Analyst” en ads.x.com): Acceso para ver analíticas orgánicas e insights de audiencia, pero sin acceso para crear, modificar o ver campañas
  • PARTNER_AUDIENCE_MANAGER: Acceso solo a través de la API para ver y modificar audiencias de socios de datos, pero sin acceso a campañas, creatividades u otros tipos de audiencia.
Además, el permiso TWEET_COMPOSER indica que el usuario autenticado puede crear Tweets sin difusión orgánica (nullcasted) o “solo promocionados” en nombre del anunciante. Esto solo está disponible para usuarios con acceso ACCOUNT_ADMIN, AD_MANAGER o CREATIVE_MANAGER. URL del recurso https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access Parámetros Ninguno Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access Ejemplo de respuesta
    {
      "data": {
        "user_id": "2417045708",
        "permissions": [
          "ACCOUNT_ADMIN",
          "TWEET_COMPOSER"
        ]
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      }
    }

Reglas de pujas

GET bidding_rules

Recupera las reglas de puja para algunas o todas las divisas. La respuesta indicará las pujas mínimas y máximas de CPE (coste por interacción). Aunque estas reglas de puja cambian rara vez, se recomienda que tus sistemas se actualicen desde estos endpoints al menos una vez al mes. Resource URL https://ads-api.x.com/12/bidding_rules Parameters
NameDescription
currency
optional
El tipo de divisa por el que filtrar los resultados, identificada usando ISO-4217. Es una cadena de tres letras, como “USD” o “EUR”. Omite este parámetro para recuperar todas las reglas de puja asociadas con el usuario que se está autenticando.

Tipo: string

Ejemplo: USD
Example Request GET https://ads-api.x.com/12/bidding_rules?currency=USD Example Response
    {
      "request": {
        "params": {
          "currency": "USD"
        }
      },
      "data_type": "bidding_rule",
      "data": [
        {
          "currency": "USD",
          "minimum_cpe_bid_local_micro": 10000,
          "maximum_cpe_bid_local_micro": 1000000000,
          "minimum_denomination": 10000
        }
      ],
      "total_count": 1
    }

Campañas

GET accounts/:account_id/campaigns

Obtiene los detalles de algunas o todas las campañas asociadas con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/campaigns Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
campaign_ids
optional
Limita la respuesta únicamente a las campañas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: 8wku2
count
optional
Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional
Limita la respuesta únicamente a las campañas bajo instrumentos de financiación específicos, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: lygyi
q
optional
Una consulta opcional para limitar el recurso por name.

Type: string

Min, Max length: 1, 255
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_draft
optional
Incluye resultados de campañas en borrador en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "campaign_ids": [
            "8wku2"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "test",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 10000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8wku2",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/campaigns/:campaign_id

Obtiene una campaña específica asociada con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
campaign_id
required
Una referencia a la campaña con la que se está operando en la solicitud.

Tipo: string

Ejemplo: 8wku2
with_deleted
optional
Incluye 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/campaigns/8wku2 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 10000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

POST accounts/:account_id/campaigns

Crea una nueva campaña asociada con la cuenta actual. Nota: Existe un límite predeterminado de 200 campañas activas por cuenta. Sin embargo, no hay límite en la cantidad de campañas inactivas. Este límite se puede aumentar a 8.000 campañas activas. Para habilitar el límite superior, el anunciante debe enviar la solicitud a su X Account Manager. URL del recurso https://ads-api.x.com/12/accounts/:account_id/campaigns Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
funding_instrument_id
required
El identificador del instrumento de financiación bajo el cual se creará la campaña.

Type: string

Example: lygyi
name
required
El nombre de la campaña. Longitud máxima: 255 caracteres.

Type: string

Example: demo
budget_optimization
optional
Selecciona el tipo de optimización de presupuesto que se aplicará.

Type: enum

Default: CAMPAIGN
Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro
sometimes required
El importe de presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $5.50 se representa como 5500000.

Nota: Este valor debe ser menor o igual que total_budget_amount_local_micro y es obligatorio para la mayoría de los tipos de Funding Instrument.

Type: long

Example: 5500000
entity_status
optional
El estado de la campaña.

Type: enum

Default: ACTIVE
Possible values: ACTIVE, DRAFT, PAUSED
purchase_order_number
optional
El número de referencia de la reserva. Usa este campo para ayudar con la conciliación de facturas. Longitud máxima: 50 caracteres.

Type: string

Example: D00805843
standard_delivery
optional
Activa la entrega estándar o acelerada. Consulta Budget Pacing para obtener más información sobre la entrega estándar frente a la acelerada. Solo está disponible cuando budget_optimization está establecido en CAMPAIGN.

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional
El importe total de presupuesto que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $37.50 se representa como 37500000.

Type: long

Example: 37500000
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false Ejemplo de respuesta
    {
      "request": {
        "params": {
          "name": "demo",
          "budget_optimization": "CAMPAIGN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "standard_delivery": false,
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "demo",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "hwtbm",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

POST batch/accounts/:account_id/campaigns

Permite la creación en lote de nuevas campaigns con una sola solicitud. Solicitudes por lotes
  • El tamaño máximo actual del lote es 40.
  • Todos los parámetros se envían en el cuerpo de la solicitud y se requiere un Content-Type de application/json.
  • Las solicitudes por lotes fallan o se completan correctamente juntas como un grupo y todas las respuestas de la API, tanto de error como de éxito, preservan el orden de los elementos de la solicitud inicial.
Respuestas por lotes Las respuestas de la API por lotes devuelven una colección ordenada de elementos. Por lo demás, son idénticas en estructura a sus endpoints de un solo elemento correspondientes. Errores por lotes
  • Los errores a nivel de solicitud (p. ej., tamaño máximo de lote excedido) se muestran en la respuesta bajo el objeto errors.
  • Los errores a nivel de elemento (p. ej., parámetro obligatorio de campaña faltante) se muestran en la respuesta bajo el objeto operation_errors.
URL del recurso https://ads-api.x.com/12/batch/accounts/:account_id/campaigns Parámetros
NameDescription
operation_type
required
El tipo de operación por elemento que se está realizando.

Tipo: enum

Valores posibles: Create, Delete, Update
params
required
Un objeto JSON que contiene todos los parámetros para los objetos de campaña. Para obtener una lista de parámetros de campaña obligatorios y opcionales, consulte aquí.
Ejemplo de solicitud POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns
    [
      {
        "operation_type":"Create",
        "params":{
          "name":"batch campaigns",
          "funding_instrument_id":"lygyi",
          "daily_budget_amount_local_micro":140000000,
          "entity_status":"PAUSED",
          "budget_optimization":"CAMPAIGN"
        }
      }
    ]
Ejemplo de respuesta
    {
      "data": [
        {
          "name": "batch campaigns",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8yn7m",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "name": "batch campaigns",
            "funding_instrument_id": "lygyi",
            "daily_budget_amount_local_micro": 140000000,
            "entity_status": "PAUSED",
            "budget_optimization":"CAMPAIGN",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        }
      ]
    }

PUT accounts/:account_id/campaigns/:campaign_id

Actualiza la campaña especificada asociada con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
campaign_id
required
Una referencia a la campaña con la que estás operando en la solicitud.

Type: string

Example: 8wku2
budget_optimization
optional
Selecciona el tipo de optimización de presupuesto que se aplicará.

Type: enum

Default: CAMPAIGN
Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro
optional
El presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, 5,50 USD se representa como 5500000. Cuando no se proporciona, la campaña gastará de manera uniforme según el presupuesto total y la duración de la campaña.

Nota: Esto debe ser menor o igual que total_budget_amount_local_micro.

Type: long

Example: 5500000
entity_status
optional
El estado de la campaña.

Type: enum

Possible values: ACTIVE, PAUSED
name
optional
El nombre de la campaña. Longitud máxima: 255 caracteres.

Type: string

Example: demo
purchase_order_number
optional
El número de referencia de la reserva. Usa este campo para ayudar con la conciliación de facturas. Longitud máxima: 50 caracteres.

Type: string

Example: D00805843
standard_delivery
optional
Habilita la entrega estándar o acelerada. Consulta Budget Pacing para obtener más información sobre la entrega estándar frente a la acelerada. Solo está disponible cuando budget_optimization está establecido en CAMPAIGN.

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional
El presupuesto total que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, 37,50 USD se representa como 37500000.

Type: long

Example: 140000000
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000 Example Response
    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "daily_budget_amount_local_micro": 140000000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:53:54Z",
        "deleted": false
      }
    }

DELETE accounts/:account_id/campaigns/:campaign_id

Elimina la campaña especificada que pertenece a la cuenta actual. Nota: Eliminar una campaña no se puede deshacer y los intentos posteriores de eliminar el recurso devolverán HTTP 404. URL del recurso https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
campaign_id
required
Una referencia a la campaña con la que se está operando en la solicitud.

Tipo: string

Ejemplo: 8yn7m
Solicitud de ejemplo DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m Respuesta de ejemplo
    {
      "request": {
        "params": {
          "campaign_id": "8yn7m",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [],
        "servable": null,
        "purchase_order_number": null,
        "effective_status": "RUNNING",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8yn7m",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:56:35Z",
        "deleted": true
      }
    }

Categorías de contenido

GET content_categories

Solicita las categories de contenido válidas que se pueden establecer como targeting_criteria para un line item. Cada content_category se asigna a una o más categorías de la IAB. Esto se puede hacer estableciendo targeting_type en IAB_CATEGORY en el endpoint por lotes targeting_critera para incluir el conjunto de iab_categories correspondientes que devuelve la solicitud content_categories. De lo contrario, se producirá un error de validación. Los detalles del publisher para cada una de estas categorías de contenido pueden recuperarse usando el endpoint GET publishers. Hay información adicional en la guía del objetivo de reproducciones de video Pre-roll. URL del recurso https://ads-api.x.com/12/content_categories Parámetros Sin parámetros de solicitud Ejemplo de solicitud GET https://ads-api.x.com/12/content_categories Ejemplo de respuesta
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Automotive (Cars, Trucks, Racing)",
          "id": "ru",
          "iab_categories": [
            "IAB2"
          ],
          "publishers_in_last_thirty_days": 12,
          "videos_monetized_in_last_thirty_days": 316
        },
        {
          "name": "Comedy",
          "id": "sk",
          "iab_categories": [
            "IAB1-4"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 174
        },
        {
          "name": "Digital Creators",
          "id": "sl",
          "iab_categories": [
            "IAB25-1"
          ],
          "publishers_in_last_thirty_days": 110,
          "videos_monetized_in_last_thirty_days": 1257
        },
        {
          "name": "Entertainment & Pop Culture",
          "id": "sm",
          "iab_categories": [
            "IAB1-1",
            "IAB1-2",
            "IAB1-3",
            "IAB1-5"
          ],
          "publishers_in_last_thirty_days": 120,
          "videos_monetized_in_last_thirty_days": 3482
        },
        {
          "name": "Financial & Business News",
          "id": "sn",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ],
          "publishers_in_last_thirty_days": 29,
          "videos_monetized_in_last_thirty_days": 1461
        },
        {
          "name": "Food & Drink",
          "id": "so",
          "iab_categories": [
            "IAB8-8",
            "IAB8-12",
            "IAB8-17",
            "IAB8-2",
            "IAB8-3",
            "IAB8-7",
            "IAB8-11",
            "IAB8-4",
            "IAB8-14",
            "IAB8-10",
            "IAB8-15",
            "IAB8-13",
            "IAB8-9",
            "IAB8-16",
            "IAB8-6",
            "IAB8-1"
          ],
          "publishers_in_last_thirty_days": 24,
          "videos_monetized_in_last_thirty_days": 516
        },
        {
          "name": "Estilo de Vida (Moda, Viajes, Bienestar)",
          "id": "sp",
          "iab_categories": [
            "IAB16",
            "IAB9-21",
            "IAB9-4",
            "IAB9-25",
            "IAB9-8",
            "IAB4",
            "IAB9-3",
            "IAB9-15",
            "IAB7",
            "IAB6",
            "IAB9-11",
            "IAB9-16",
            "IAB9-7",
            "IAB9-20",
            "IAB9-24",
            "IAB9-17",
            "IAB9-12",
            "IAB9-31",
            "IAB9-27",
            "IAB10",
            "IAB9-10",
            "IAB9-23",
            "IAB9-6",
            "IAB9-18",
            "IAB9-13",
            "IAB9-1",
            "IAB9-28",
            "IAB20",
            "IAB9-5",
            "IAB9-26",
            "IAB22",
            "IAB23",
            "IAB9-9",
            "IAB9-22",
            "IAB18",
            "IAB9-2",
            "IAB9-19",
            "IAB9-14",
            "IAB9-29"
          ],
          "publishers_in_last_thirty_days": 67,
          "videos_monetized_in_last_thirty_days": 2412
        },
        {
          "name": "Music",
          "id": "sq",
          "iab_categories": [
            "IAB1-6"
          ],
          "publishers_in_last_thirty_days": 31,
          "videos_monetized_in_last_thirty_days": 518
        },
        {
          "name": "News & Current Events",
          "id": "sr",
          "iab_categories": [
            "IAB12",
            "IAB14"
          ],
          "publishers_in_last_thirty_days": 125,
          "videos_monetized_in_last_thirty_days": 5507
        },
        {
          "name": "Politics",
          "id": "s4",
          "iab_categories": [
            "IAB11"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 1402
        },
        {
          "name": "Science & Education",
          "id": "ss",
          "iab_categories": [
            "IAB5",
            "IAB15"
          ],
          "publishers_in_last_thirty_days": 7,
          "videos_monetized_in_last_thirty_days": 132
        },
        {
          "name": "Sports",
          "id": "se",
          "iab_categories": [
            "IAB17"
          ],
          "publishers_in_last_thirty_days": 403,
          "videos_monetized_in_last_thirty_days": 18281
        },
        {
          "name": "Technology",
          "id": "sg",
          "iab_categories": [
            "IAB19"
          ],
          "publishers_in_last_thirty_days": 13,
          "videos_monetized_in_last_thirty_days": 1089
        },
        {
          "name": "Television",
          "id": "sh",
          "iab_categories": [
            "IAB1-7"
          ],
          "publishers_in_last_thirty_days": 58,
          "videos_monetized_in_last_thirty_days": 1307
        },
        {
          "name": "Esports & Video Games",
          "id": "s0",
          "iab_categories": [
            "IAB9-30"
          ],
          "publishers_in_last_thirty_days": 109,
          "videos_monetized_in_last_thirty_days": 1844
        }
      ],
      "total_count": 15
    }

Categorías seleccionadas

GET accounts/:account_id/curated_categories

Recupera una lista de Categorías seleccionadas disponibles para los country_codes proporcionados. Cada curated_category solo está disponible en países específicos indicados por los country_codes en la respuesta. Puedes encontrar más detalles en la Guía del objetivo de vistas de video pre‑roll. URL del recurso https://ads-api.x.com/12/accounts/:account_id/curated_categories Parámetros
NombreDescripción
account_id
obligatorio
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
country_codes
obligatorio
Limita la respuesta solo a los países deseados especificando una lista separada por comas de códigos de país ISO de dos letras. Se pueden proporcionar hasta 200 identificadores.

Tipo: string

Ejemplo: US
cursor
opcional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Paginación para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US Ejemplo de respuesta
{
      "request": {
        "params": {
          "country_codes": [
            "US"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Baloncesto",
          "description": "Ejecuta junto al mejor contenido diario de baloncesto, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten videos de baloncesto durante y fuera de temporada.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20265254",
            "378174762",
            "900368808",
            "18939563",
            "18371803",
            "18360370",
            "770658432928079872",
            "11026952",
            "37085464",
            "16212685",
            "57422635",
            "281669945",
            "7117962",
            "23065057",
            "41688179",
            "29779226",
            "900280416",
            "364460082",
            "902030382",
            "19409270",
            "19077044",
            "18139461",
            "14992591",
            "66753565",
            "667563",
            "16727749",
            "40941404",
            "18481113",
            "791598918",
            "16201775",
            "15900167",
            "45891626",
            "191894553",
            "2181233851",
            "34352904",
            "171483987",
            "454122399",
            "57415242",
            "19263978",
            "902089998",
            "423540866",
            "2715223320",
            "22185437",
            "17292143",
            "55590247",
            "66757066",
            "22642626",
            "41604618",
            "87275465",
            "22643259",
            "32414973",
            "73406718",
            "20346956",
            "413422891",
            "45412765",
            "19537303",
            "459511725",
            "30954864",
            "21308488",
            "18552281",
            "19924520",
            "24903350",
            "851142163",
            "26270913",
            "20444254",
            "26074296",
            "6395222",
            "15537451",
            "28672101",
            "38053254",
            "24925573",
            "19564719",
            "18164425",
            "22815383",
            "20196159"
          ],
          "id": "929wbl6ymlfk",
          "created_at": "2019-11-08T21:12:47Z",
          "updated_at": "2021-03-09T20:36:44Z",
          "videos_monetized_in_last_thirty_days": 2446
        },
        {
          "name": "Personalidades de Gaming",
          "description": "Ejecuta junto al mejor contenido diario de gaming exclusivamente de una lista de algunos de los creadores digitales más grandes y queridos del gaming en línea.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "90779436",
            "268270621",
            "567167802",
            "246596682",
            "474919140",
            "284422688",
            "185909682",
            "4767225325",
            "2559865245",
            "186888760",
            "161418822",
            "141021153",
            "352881953",
            "1117931702",
            "146556805",
            "357294577",
            "234526497",
            "266687361",
            "214201922",
            "9451052",
            "2163885564",
            "2231422037",
            "116952434",
            "399909209",
            "15993650",
            "974356091193741312",
            "210839744",
            "2313002094",
            "159916388",
            "3258981481",
            "231992478",
            "182236262",
            "386884916",
            "22705686",
            "4140881832",
            "995979576",
            "2244953047",
            "311775629",
            "98821255",
            "2733210014",
            "2741078150"
          ],
          "id": "94ngssfrr01x",
          "created_at": "2019-12-02T20:45:12Z",
          "updated_at": "2021-03-09T20:18:13Z",
          "videos_monetized_in_last_thirty_days": 448
        },
        {
          "name": "Béisbol",
          "description": "Ejecuta junto al mejor contenido diario de béisbol, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten cobertura importante de béisbol.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "22016177",
            "22798877",
            "52803520",
            "20710218",
            "423532170",
            "28603812",
            "41144996",
            "22819823",
            "39389304",
            "252273678",
            "123307490",
            "2319354187",
            "41488578",
            "37947138",
            "302066953",
            "159143990",
            "35006336",
            "53178109",
            "40918816",
            "39682297",
            "39397148",
            "39419180",
            "53197137",
            "52863923",
            "21407926",
            "31164229",
            "19607400",
            "39392910",
            "241544156",
            "43024351",
            "37837907",
            "165764237",
            "69117905",
            "87673496",
            "23043294",
            "52824038",
            "52861612",
            "33137450",
            "30008146",
            "39367703",
            "21436663",
            "188575356",
            "40931019",
            "41468683",
            "40927173",
            "172742915"
          ],
          "id": "9lav5usxfmdc",
          "created_at": "2020-05-18T20:20:27Z",
          "updated_at": "2021-03-09T20:37:46Z",
          "videos_monetized_in_last_thirty_days": 190
        },
        {
          "name": "Equipos de Esports",
          "description": "Ejecuta junto a la programación de los mejores equipos de esports del mundo, cubriendo tanto la cobertura de eventos como otra programación complementaria durante todo el año.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "759527448757215232",
            "61933836",
            "477213534",
            "907193396049182720",
            "895382891408089089",
            "862708050116976640",
            "115038550",
            "3182089458",
            "4131266472",
            "1145702070961496065",
            "2262070855",
            "920664872786059264",
            "1035653581683220481",
            "14229141",
            "1101275970995027968",
            "20734751",
            "1452520626",
            "720303639277928448",
            "2853641871",
            "912696400571486208",
            "874362688939413504",
            "286505380",
            "892808605170245632",
            "875087838613733376",
            "238431491",
            "867053221940011014",
            "964529942",
            "1172506293174710272",
            "535756639",
            "2255226817",
            "1100825469853696000",
            "1122713320086220803",
            "1124064709295128581",
            "899858978418642944",
            "864977592532688896",
            "864476897106898944",
            "862770685445361665",
            "257268592"
          ],
          "id": "9ys3jz3ktreo",
          "created_at": "2020-10-01T20:02:35Z",
          "updated_at": "2021-03-09T20:36:20Z",
          "videos_monetized_in_last_thirty_days": 169
        },
        {
          "name": "Fútbol Americano ",
          "description": "Muestra anuncios junto al mejor contenido diario de fútbol americano, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten videos de fútbol americano durante y fuera de temporada.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21790466",
            "53103297",
            "23642374",
            "817416193854283776",
            "43403778",
            "24179879",
            "26813914",
            "36375662",
            "33587536",
            "180884045",
            "16332223",
            "27902825",
            "180503626",
            "44468807",
            "18336787",
            "818431566",
            "22146282",
            "31126587",
            "40358743",
            "35865630",
            "16347506",
            "72665816",
            "33583496",
            "389038362",
            "36155311",
            "227342532",
            "2151130166",
            "26791995",
            "44666348",
            "24109979",
            "31504542",
            "713143",
            "423536031",
            "25545388",
            "59471027",
            "706923475",
            "19383279",
            "8824902",
            "1655877529",
            "18734310",
            "240734425",
            "17076218",
            "47964412",
            "2802184770",
            "19426729",
            "56443153",
            "23508439",
            "25084916",
            "764347046",
            "19853312",
            "348590880"
          ],
          "id": "8tujg1lvi8sn",
          "created_at": "2019-08-15T20:48:51Z",
          "updated_at": "2021-03-09T20:34:13Z",
          "videos_monetized_in_last_thirty_days": 254
        },
        {
          "name": "Men’s Culture + Lifestyle",
          "description": "Run next to content from a set of handles curated based on their follower profiles to help you reach a majority male audience, including some of the top handles sharing technology, news, and lifestyle content.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "17764377",
            "61933836",
            "28370738",
            "3224616765",
            "22819823",
            "18927441",
            "734826612684783616",
            "14372486",
            "7157132",
            "15764136",
            "590316679",
            "7302282",
            "895014043932540928",
            "7517222",
            "3489420013",
            "14063426",
            "72665816",
            "214201922",
            "14980903",
            "22199141",
            "21272440",
            "25319414",
            "119593082",
            "4760694445",
            "765905855195803648",
            "238431491",
            "22178780",
            "241544156",
            "25093616",
            "16877611",
            "22146985",
            "368703433",
            "14342661",
            "415605847",
            "2181233851",
            "890891",
            "15764001",
            "614754689",
            "18479513",
            "23508439",
            "348590880"
          ],
          "id": "8tujj1ep7t34",
          "created_at": "2019-08-15T20:49:47Z",
          "updated_at": "2021-03-09T20:39:00Z",
          "videos_monetized_in_last_thirty_days": 1330
        },
        {
          "name": "Women’s Culture + Lifestyle",
          "description": "Run next to content from a set of handles curated based on their follower profiles to help you reach a majority female audience, including some of the top handles sharing pop culture, news, and lifestyle content.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "23482952",
            "20177423",
            "19074134",
            "15566901",
            "32469566",
            "19784831",
            "16145224",
            "16932962",
            "14934818",
            "29730065",
            "24190981",
            "30278532",
            "15846407",
            "24994219",
            "23993734",
            "40965341",
            "16312576",
            "75094638",
            "549673665",
            "18806753",
            "75306892",
            "1482663290",
            "31181674",
            "971407531972186112",
            "4020532937",
            "25087685",
            "22515362",
            "80943051",
            "19247844",
            "15279429",
            "16824090",
            "20710809",
            "979831113655996416",
            "32432308",
            "19472585",
            "25589776",
            "739963476370673665",
            "20188834",
            "926269727663673349"
          ],
          "id": "8tujl1p3yn0g",
          "created_at": "2019-08-15T20:50:24Z",
          "updated_at": "2021-03-09T20:17:53Z",
          "videos_monetized_in_last_thirty_days": 1365
        },
        {
          "name": "Light-Hearted",
          "description": "Run next to a list of handles curated for the volume of positive, feel-good content and conversation they’ve consistently generated on X.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20177423",
            "22449367",
            "9695312",
            "19074134",
            "4805771380",
            "32469566",
            "1212860112047460352",
            "16402507",
            "16932962",
            "14934818",
            "17446621",
            "29730065",
            "15846407",
            "1604444052",
            "180066380",
            "16312576",
            "549673665",
            "18806753",
            "16211434",
            "545336345",
            "971407531972186112",
            "4020532937",
            "833612154",
            "22515362",
            "20710809",
            "32432308",
            "774311630",
            "3073349892",
            "926269727663673349"
          ],
          "id": "9fg8gmz96qdg",
          "created_at": "2020-03-20T19:37:44Z",
          "updated_at": "2021-03-09T19:57:40Z",
          "videos_monetized_in_last_thirty_days": 1395
        },
        {
          "name": "Soccer",
          "description": "Run next to the best of everyday soccer content including college teams, professional teams, and the top sports media handles sharing major soccer coverage.",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21677316",
            "20636347",
            "4704552148",
            "14573900",
            "22556296",
            "1415791555",
            "107146095",
            "17288520",
            "213474069",
            "17493398",
            "44990136",
            "452155423",
            "17744542",
            "16303450",
            "2841146601",
            "2413176055",
            "29739264",
            "38580532",
            "953476292913106945",
            "27092557",
            "86356439",
            "34613288",
            "3170659367",
            "119593082",
            "73412535",
            "627586654",
            "15891449",
            "23011345",
            "96951800",
            "15997022",
            "16960789",
            "21919642",
            "102965285",
            "17224076",
            "36432200",
            "1410055968"
          ],
          "id": "9ddrgesiap6o",
          "created_at": "2020-02-28T22:43:26Z",
          "updated_at": "2021-01-26T17:54:55Z",
          "videos_monetized_in_last_thirty_days": 421
        }
      ],
      "total_count": 9
    }

GET accounts/:account_id/curated_categories/:curated_category_id

Recupera los detalles de un curated_category_id específico. Cada curated_category solo está disponible en países específicos indicados por los country_codes en la respuesta. URL del recurso https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
curated_category_id
required
Una referencia a la Curated Category con la que se opera en la solicitud.

Type: string

Example: 9ddrgesiap6o
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o Ejemplo de respuesta
    {
      "request": {
        "params": {
          "id": "9ddrgesiap6o",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "Soccer",
        "description": "Run next to the best of everyday soccer content including college teams, professional teams, and the top sports media handles sharing major soccer coverage.",
        "country_codes": [],
        "publisher_user_ids": [
          "21677316",
          "20636347",
          "4704552148",
          "14573900",
          "22556296",
          "1415791555",
          "107146095",
          "17288520",
          "213474069",
          "17493398",
          "44990136",
          "452155423",
          "17744542",
          "16303450",
          "2841146601",
          "2413176055",
          "29739264",
          "38580532",
          "953476292913106945",
          "27092557",
          "86356439",
          "34613288",
          "3170659367",
          "119593082",
          "73412535",
          "627586654",
          "15891449",
          "23011345",
          "96951800",
          "15997022",
          "16960789",
          "21919642",
          "102965285",
          "17224076",
          "36432200",
          "1410055968"
        ],
        "id": "9ddrgesiap6o",
        "created_at": "2020-02-28T22:43:26Z",
        "updated_at": "2021-01-26T17:54:55Z",
        "videos_monetized_in_last_thirty_days": 421
      }
    }

Características

GET accounts/:account_id/features

Obtén la colección de funciones concedidas a las que tiene acceso esta cuenta de anuncios. Las funciones se identifican mediante una clave de función descriptiva y solo se exponen en este endpoint si se introducen en beta o en otro tipo de lanzamiento limitado y están disponibles en la Ads API. Las funciones que no cumplan estos criterios no se expondrán en este endpoint. Nota: Este endpoint ayuda al desarrollo del ecosistema de la Ads API al mejorar la visibilidad del acceso de los clientes a los lanzamientos beta. Los desarrolladores de API no pueden solicitar acceso a funciones en nombre de un anunciante. Estas solicitudes solo puede hacerlas el propio anunciante a su account manager de X. Resource URL https://ads-api.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
feature_keys
optional
Parámetro opcional que permite hacer consultas para una clave de función específica. Las solicitudes pueden incluir varias claves separadas por comas.

Nota: Solo se incluirán en la respuesta las funciones a las que esta cuenta tenga acceso.

Tipo: enum

Valores posibles: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": [
        "CITY_TARGETING",
        "CONVERSATION_CARD",
        "PROMOTED_MEDIA_POLLS",
        "REACH_AND_FREQUENCY_ANALYTICS",
        "REACH_FREQUENCY_CAP",
        "UNIVERSAL_LOOKALIKE"
      ]
    }

POST accounts/:account_id/features

SOLO SANDBOX Añadir una característica a una cuenta de sandbox. La lista actualizada de características de la cuenta se puede obtener a través del endpoint GET accounts/:account_id/features. URL de recurso https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parámetros
NombreDescripción
account_id
required
Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: gq180y
feature_keys
required
Lista separada por comas de características de cuenta que se agregarán a la cuenta.

Tipo: enum

Valores posibles: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD
Ejemplo de solicitud POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING Ejemplo de respuesta
    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "VALIDATED_AGE_TARGETING"
          ]
        }
      },
      "data": [
        "ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE",
        "AWARENESS_OBJECTIVE",
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VALIDATED_AGE_TARGETING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

DELETE accounts/:account_id/features

SOLO SANDBOX Elimina una funcionalidad de una cuenta sandbox. La lista actualizada de funcionalidades de la cuenta se puede obtener mediante el endpoint GET accounts/:account_id/features. URL del recurso https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parámetros
NombreDescripción
account_id
required
Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: gq180y
feature_keys
required
Lista separada por comas de funcionalidades de cuenta que se eliminarán de la cuenta.

Tipo: enum

Valores posibles: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD
Ejemplo de solicitud DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE Ejemplo de respuesta
    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "PREROLL_VIEWS_OBJECTIVE"
          ]
        }
      },
      "data": [
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

Instrumentos de financiación

GET accounts/:account_id/funding_instruments

Obtén los detalles de algunos o todos los instrumentos de financiación asociados con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
count
optional
Especifica la cantidad de registros que se intentará recuperar por cada solicitud distinta.

Tipo: int

Valor predeterminado: 200
Mín., máx.: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
funding_instrument_ids
optional
Limita la respuesta únicamente a los instrumentos de financiación deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID.

Tipo: string

Ejemplo: lygyi
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Tipo: string

Ejemplo: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "start_time": "2016-07-22T04:24:04Z",
          "description": "Visa terminando en 0650",
          "credit_limit_local_micro": 200000000,
          "end_time": null,
          "id": "lygyi",
          "entity_status": "ACTIVE",
          "account_id": "18ce54d4x5t",
          "reasons_not_able_to_fund": [],
          "io_header": null,
          "currency": "USD",
          "funded_amount_local_micro": 645940000,
          "created_at": "2016-07-22T04:24:04Z",
          "type": "CREDIT_CARD",
          "able_to_fund": true,
          "updated_at": "2017-04-05T00:25:13Z",
          "credit_remaining_local_micro": null,
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/funding_instruments/:funding_instrument_id

Obtiene un instrumento de financiación específico asociado con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
funding_instrument_id
required
Una referencia al instrumento de financiación con el que se opera en la solicitud.

Type: string

Example: lygyi
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi Example Response
    {
      "request": {
        "params": {
          "funding_instrument_id": "lygyi",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "start_time": "2016-07-22T04:24:04Z",
        "description": "Visa ending in 0650",
        "credit_limit_local_micro": 200000000,
        "end_time": null,
        "id": "lygyi",
        "entity_status": "ACTIVE",
        "account_id": "18ce54d4x5t",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 645940000,
        "created_at": "2016-07-22T04:24:04Z",
        "type": "CREDIT_CARD",
        "able_to_fund": true,
        "updated_at": "2017-04-05T00:25:13Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      }
    }

POST accounts/:account_id/funding_instruments

SOLO SANDBOX Crea un instrumento de financiación en el entorno sandbox. No hay riesgo de incurrir en costos al usar un instrumento de financiación de sandbox. Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments Parameters
NameDescription
account_id
required
El identificador de la cuenta apalancada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: gq1844
currency
required
La moneda, expresada según ISO-4217.

Tipo: string

Ejemplo: USD
start_time
required
La fecha en que el instrumento de financiación se vuelve activo y puede utilizarse, expresada en formato ISO 8601.

Tipo: string

Ejemplo: 2017-05-19T07:00:00Z
type
required
El tipo de instrumento de financiación que se va a crear.

Tipo: enum

Valores posibles: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED
end_time
sometimes required
La fecha en que el instrumento de financiación pasa a estar inactivo, expresada en formato ISO 8601.

Tipo: string

Ejemplo: 2017-05-26T07:00:00Z
credit_limit_local_micro
optional
El crédito total disponible para este instrumento de financiación.

Nota: Solo se aplica a algunos tipos de instrumentos de financiación.

Tipo: long

Ejemplo: 37500000
funded_amount_local_micro
optional
El presupuesto total asignado a este instrumento de financiación.

Nota: Solo se aplica a algunos tipos de instrumentos de financiación.

Tipo: long

Ejemplo: 37500000
Example Request POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000 Example Response
    {
      "data": {
        "start_time": "2017-07-10T00:00:00Z",
        "description": "(aún no se ha configurado un método de pago)",
        "credit_limit_local_micro": null,
        "end_time": "2018-01-10T00:00:00Z",
        "id": "hxtet",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 140000000000,
        "created_at": "2017-09-09T05:23:28Z",
        "type": "INSERTION_ORDER",
        "able_to_fund": true,
        "updated_at": "2017-09-09T05:23:28Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      },
      "request": {
        "params": {
          "start_time": "2017-07-10T00:00:00Z",
          "end_time": "2018-01-10T00:00:00Z",
          "account_id": "gq1844",
          "currency": "USD",
          "funded_amount_local_micro": 140000000000,
          "type": "INSERTION_ORDER"
        }
      }
    }

DELETE accounts/:account_id/funding_instruments/:funding_instrument_id

SOLO SANDBOX Elimina un instrumento de financiación en el entorno sandbox. URL del recurso https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: gq1844
funding_instrument_id
required
Una referencia al instrumento de financiación con el que operas en la solicitud.

Tipo: string

Ejemplo: hxt82
Ejemplo de solicitud DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82 Ejemplo de respuesta
    {
      "data": {
        "start_time": "2017-08-30T19:23:47Z",
        "description": "(aún no se ha configurado ningún método de pago)",
        "credit_limit_local_micro": 500000000,
        "end_time": null,
        "id": "hxt82",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [
          "DELETED"
        ],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": null,
        "created_at": "2017-08-30T19:23:47Z",
        "type": "CREDIT_CARD",
        "able_to_fund": false,
        "updated_at": "2017-09-09T02:08:30Z",
        "credit_remaining_local_micro": null,
        "deleted": true
      },
      "request": {
        "params": {
          "funding_instrument_id": "hxt82",
          "account_id": "gq1844"
        }
      }
    }

Categorías de IAB

GET iab_categories

Solicita las categories de App válidas para grupos de anuncios (line_items). URL del recurso https://ads-api.x.com/12/iab_categories Parámetros
NameDescription
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud distinta.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de categorías. Consulta Pagination para más información.

Type: string

Example: gc-ddf4a
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente fijados en 200 por cada 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/iab_categories?count=2 Ejemplo de respuesta
    {
      "data": [
        {
          "id": "IAB1",
          "parent_id": null,
          "name": "Arts & Entertainment"
        },
        {
          "id": "IAB1-1",
          "parent_id": "IAB1",
          "name": "Books & Literature"
        }
      ],
      "next_cursor": "uxa8",
      "request": {
        "params": {
          "count": 2
        }
      }
    }

Elementos de línea

GET accounts/:account_id/line_items

Recupera los detalles de algunos o todos los line items asociados con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_items Parámetros
NombreDescripción
account_id
required
Identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
campaign_ids
optional
Limita la respuesta solo a los line items de campañas específicas, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID.

Type: string

Example: 8gdx6
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud independiente.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional
Limita la respuesta solo a los line items de instrumentos de financiación específicos, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID.

Type: string

Example: lygyi
line_item_ids
optional
Limita la respuesta solo a los line items deseados, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID.

Type: string

Example: 8v7jo
q
optional
Consulta opcional para filtrar el recurso por name.

Type: string

Min, Max length: 1, 255
sort_by
optional
Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Valores posibles: true, false
with_draft
optional
Incluye resultados de campañas en borrador en tu solicitud.

Type: boolean

Default: false
Valores posibles: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son mutuamente excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.

Type: boolean

Default: false
Valores posibles: true, false
Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx Respuesta de ejemplo
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "itttx"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": "li-18",
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2021-02-16T00:00:00Z",
          "bid_amount_local_micro": 320000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "itttx",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2021-02-23T23:37:54Z",
          "ios_app_store_identifier": null,
          "updated_at": "2022-06-01T02:01:18Z",
          "campaign_id": "f4z6x",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/line_items/:line_item_id

Recupera un elemento de línea específico asociado con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
line_item_id
required
Una referencia al elemento de línea con el que se opera en la solicitud.

Tipo: string

Ejemplo: 8v7jo
with_deleted
optional
Incluye los resultados eliminados en la solicitud.

Tipo: boolean

Predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx Example Response
    {
      "request": {
        "params": {
          "line_item_id": "itttx",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": "li-18",
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2021-02-16T00:00:00Z",
        "bid_amount_local_micro": 320000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "funding_instrument_id": "lygyi",
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "itttx",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2021-02-23T23:37:54Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-01T02:01:18Z",
        "campaign_id": "f4z6x",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

POST accounts/:account_id/line_items

Crea un elemento de línea asociado con la campaña especificada de la cuenta actual. Todos los elementos de línea dentro de una campaña deben ser del mismo product_type y objective. Cuando se utiliza el tipo de producto PROMOTED_ACCOUNT, asociar un Tweet con el line_item agregará ubicaciones en la cronología móvil además de la ubicación estándar de PROMOTED_ACCOUNT. Definir android_app_store_identifier o ios_app_store_identifier agregará automáticamente los criterios de segmentación para el elemento de línea que coincidan con la app móvil que se está promocionando; por ejemplo, pasar ios_app_store_identifier agregaría criterios de segmentación PLATFORM (targeting criteria) para iOS. Nota: Hay un límite de 100 elementos de línea por campaña y 256 elementos de línea activos en todas las campañas. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_items Parámetros
NombreDescripción
account_id
obligatorio
Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio en todas las solicitudes a la Advertiser API, excepto GET accounts. La cuenta indicada debe estar asociada al usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
campaign_id
obligatorio
Identificador de la campaña para la que se creará el line item.

Tipo: string

Ejemplo: 8slvg
end_time
obligatorio
El momento, expresado en ISO 8601, en el que el line item dejará de mostrarse.

Type: string

Example: 2017-10-05T00:00:00Z
objetivo
obligatorio
El objetivo de la campaña para este line item.

Tipo: enum

Valores posibles: APP_ENGAGEMENTS, APP_INSTALLS, REACH, FOLLOWERS, ENGAGEMENTS, VIDEO_VIEWS, PREROLL_VIEWS, WEBSITE_CLICKS
ubicaciones
obligatorio
Las ubicaciones de publicación en las que se mostrará este line item. Especifique una lista de valores de ubicación separados por comas.

Tipo: enum

Valores posibles: ALL_ON_TWITTER, PUBLISHER_NETWORK, TAP_BANNER, TAP_FULL, TAP_FULL_LANDSCAPE, TAP_NATIVE, TAP_MRECT,TWITTER_PROFILE, TWITTER_REPLIES, TWITTER_SEARCH, TWITTER_TIMELINE
product_type
obligatorio
El tipo de producto promocionado que contendrá esta línea de pedido.

Tipo: enum

Valores posibles: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
start_time
obligatorio
La fecha y hora, expresadas en ISO 8601, en que el line item comenzará a publicarse.

Type: string

Example: 2017-07-05T00:00:00Z
advertiser_domain
obligatorio en algunos casos
El dominio del sitio web de este anunciante, sin incluir el protocolo.

Nota: Obligatorio cuando la ubicación del elemento de línea está configurada como PUBLISHER_NETWORK.

Type: string

Example: x.com
android_app_store_identifier
a veces obligatorio
El identificador de Google Play Store para las aplicaciones promocionadas.

Nota: los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren definir al menos un identificador de tienda de aplicaciones — ya sea android_app_store_identifier o ios_app_store_identifier.

Tipo: string

Ejemplo: com.twitter.android
bid_amount_local_micro
a veces es obligatorio
El monto de la puja que se asociará a este elemento de línea. Se utilizará la moneda asociada al instrumento de financiamiento especificado. Para USD, $5.50 se representa como 5500000.

Nota: Obligatorio si bid_strategy se establece en MAX o TARGET.

Nota: Solo se aceptan valores mayores que cero.

Type: long

Example: 5500000
categories
a veces obligatorio
Las categorías IAB relevantes para este anunciante. Consulta GET iab_categories.

Nota: Es obligatorio cuando la ubicación del line item se establece en PUBLISHER_NETWORK.

Type: string

Example: IAB3-1
ios_app_store_identifier
a veces es obligatorio
La parte numérica del identificador de la App Store de Apple para aplicaciones promocionadas.

Nota: los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren especificar al menos un identificador de tienda de aplicaciones: android_app_store_identifier o ios_app_store_identifier.

Type: string

Example: 333903271
primary_web_event_tag
a veces requerido
El identificador de la etiqueta principal de evento web. Permite realizar un seguimiento más preciso de las interacciones de la campaña asociada a este line item.

Nota: Es obligatorio cuando el objetivo del line item se configura como WEBSITE_CONVERSIONS.

Tipo: string

Ejemplo: nvo4z
advertiser_user_id
opcional
El identificador de usuario de X de la cuenta que promociona un anuncio de tipo PREROLL_VIEWS. Solo ciertas aplicaciones cliente pueden usar este parámetro.

Tipo: string

Ejemplo: 312226591
audience_expansion
opcional
Se utiliza para ampliar el alcance de las campañas segmentando a usuarios similares a los ya segmentados.

Nota: De forma predeterminada, no se aplicará ninguna expansión.

Type: enum

Valores posibles: BROAD, DEFINED, EXPANDED
bid_strategy
opcional
El mecanismo de puja.

AUTO optimiza automáticamente las pujas en función del presupuesto diario y las fechas de ejecución de la campaña.

MAX establece la puja máxima permitida y no está disponible cuando el objetivo se establece en REACH o FOLLOWERS.

TARGET intenta que los promedios diarios de puja se mantengan dentro del 20 % del valor especificado en bid_amount_local_micro y está disponible cuando el objetivo se establece en REACH, FOLLOWERS o WEBSITE_CLICKS.

Nota: Si se establece en AUTO, se ignorará bid_amount_local_micro.

Nota: Valor predeterminado según el objetivo.

Tipo: enum

Valores posibles: AUTO, MAX, TARGET
duration_in_days
opcional
El período de tiempo durante el cual se aplica el frequency_cap.

Type: int

Possible values: 1, 7, 30
entity_status
opcional
El estado del line item.

Type: enum

Valor predeterminado: ACTIVE
Valores posibles: ACTIVE, DRAFT, PAUSED
frequency_cap
opcional
El número máximo de veces que un anuncio puede mostrarse a un usuario.

Nota: Solo es compatible con los objetivos REACH, ENGAGEMENTS, VIDEO_VIEWS y PREROLL_VIEWS.

Tipo: int

Ejemplo: 5
objetivo
opcional
La configuración de optimización que se usará con este line item.

La opción APP_PURCHASES está disponible para APP_INSTALL. Las opciones APP_CLICKS y APP_INSTALLS están disponibles tanto para los objetivos APP_INSTALL como APP_ENGAGEMENTS y pueden requerir el uso de un socio MACT compatible.

La opción SITE_VISITS solo está disponible con el objetivo WEBSITE_CLICKS.

Nota: Valor predeterminado según el objetivo.

Tipo: enum

Valores posibles: APP_CLICKS, APP_INSTALLS, APP_PURCHASES,ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, SITE_VISITS, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
nombre
opcional
El nombre del line item.

Type: string

Ejemplo: demo

Longitud mínima y máxima: 1, 255
pay_by
opcional
La unidad de cobro de este line item. Esta configuración solo se puede modificar para line items que usen el objetivo APP_INSTALLS.

Nota: El pay_by predeterminado se establece automáticamente en función del objetivo de la campaña y de la unidad de puja del line item.

El objetivo APP_INSTALLS admite tanto los valores APP_CLICK como IMPRESSION. IMPRESSION es el valor predeterminado.

El objetivo LINK_CLICKS admite tanto los valores LINK_CLICK como IMPRESSION. IMPRESSION es el valor predeterminado, pero no es compatible al configurar TARGET en bid_strategy.

El objetivo SITE_VISITS admite el valor IMPRESSION.

Tipo: enum

Valores posibles: APP_CLICK, IMPRESSION, LINK_CLICK
standard_delivery
opcional
Activa la entrega estándar o acelerada. Consulta Budget Pacing para obtener más información sobre la entrega estándar y la acelerada. Solo disponible cuando budget_optimization está configurado en LINE_ITEM para la campaña padre

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
opcional
El importe total del presupuesto que se asignará al line item. Se utilizará la moneda asociada al instrumento de financiación especificado. Para USD, $37.50 se representa como 37500000.

Type: long

Example: 37500000
daily_budget_amount_local_micro
a veces obligatorio
El monto del presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. En USD, 5,50 $ se representa como 5500000. Cuando no se especifica, la campaña gastará de forma uniforme en función del presupuesto total y durante todo el periodo de difusión de la campaña. Solo está disponible cuando budget_optimization se establece en LINE_ITEM para la campaña principal

Nota: Esto debe ser menor o igual que total_budget_amount_local_micro.

Type: long

Example: 5500000
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2022-06-15T00:00:00Z",
          "bid_amount_local_micro": 3210000,
          "daily_budget_amount_local_micro": 1000000,
          "product_type": "PROMOTED_TWEETS",
          "objective": "ENGAGEMENTS",
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t",
          "campaign_id": "hwtq0"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2022-06-15T00:00:00Z",
        "bid_amount_local_micro": 3210000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": 1000000,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": true,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "ml5vs",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2022-06-03T23:47:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:47:20Z",
        "campaign_id": "hwtq0",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

POST batch/accounts/:account_id/line_items

Permite la creación por lotes de nuevos line items con una sola solicitud. Solicitudes por lotes
  • El tamaño máximo actual del lote es 40.
  • Todos los parámetros se envían en el cuerpo de la solicitud y se requiere un Content-Type de application/json.
  • Las solicitudes por lotes se realizan correctamente o fallan en conjunto como un grupo, y todas las respuestas de la API, tanto de error como de éxito, preservan el orden de los elementos de la solicitud inicial.
Respuestas por lotes Las respuestas de la API por lotes devuelven una colección ordenada de elementos. Por lo demás, son idénticas en estructura a sus endpoints correspondientes de un solo elemento. Errores por lotes
  • Los errores a nivel de solicitud (por ejemplo, tamaño máximo de lote superado) se muestran en la respuesta bajo el objeto errors.
  • Los errores a nivel de elemento (por ejemplo, parámetro obligatorio de line item faltante) se muestran en la respuesta bajo el objeto operation_errors.
URL de recurso https://ads-api.x.com/12/batch/accounts/:account_id/line_items Parámetros
NombreDescripción
operation_type
required
El tipo de operación por elemento que se está realizando.

Tipo: enum

Valores posibles: Create, Delete, Update
params
required
Objeto JSON que contiene todos los parámetros para los objetos de line item. Para ver una lista de parámetros obligatorios y opcionales de line item, consulta aquí.
Solicitud de ejemplo POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items
    [
      {
        "operation_type":"Create",
        "params":{
          "campaign_id":"8yn7m",
          "objective":"ENGAGEMENTS",
          "product_type":"PROMOTED_TWEETS",
          "placements":"ALL_ON_TWITTER",
          "bid_amount_local_micro":3210000,
          "entity_status":"PAUSED"
        }
      }
    ]
Ejemplo de respuesta
    {
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": null,
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": null,
          "bid_amount_local_micro": 3210000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "9cqi0",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2017-07-07T17:42:20Z",
          "ios_app_store_identifier": null,
          "updated_at": "2017-07-07T17:42:20Z",
          "campaign_id": "8yn7m",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "placements": [
              "ALL_ON_TWITTER"
            ],
            "bid_amount_local_micro": 3210000,
            "product_type": "PROMOTED_TWEETS",
            "objective": "ENGAGEMENTS",
            "entity_status": "PAUSED",
            "account_id": "18ce54d4x5t",
            "campaign_id": "8yn7m"
          },
          "operation_type": "Create"
        }
      ]
    }

PUT accounts/:account_id/line_items/:line_item_id

Actualiza el line item especificado asociado a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
NombreDescripción
account_id
obligatorio
El identificador de la cuenta empleada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio en todas las solicitudes a la Advertiser API, excepto en GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
line_item_id
obligatorio
Referencia al line item sobre el que se realiza la operación en la solicitud.

Type: string

Example: 8v7jo
advertiser_domain
opcional
El dominio del sitio web de este anunciante, sin la especificación del protocolo.

Nota: Obligatorio cuando el placement del line item se establece en PUBLISHER_NETWORK.

Type: string

Ejemplo: x.com
advertiser_user_id
opcional
El identificador de usuario de Twitter de la cuenta que promociona un anuncio de PREROLL_VIEWS. Solo ciertas aplicaciones cliente pueden usar este parámetro.

Tipo: string

Ejemplo: 312226591
android_app_store_identifier
opcional
El identificador de Google App Store de la aplicación promocionada.

Nota: los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren definir al menos un identificador de tienda de aplicaciones: android_app_store_identifier o ios_app_store_identifier.

Tipo: string

Ejemplo: com.twitter.android
audience_expansion
opcional
Se utiliza para ampliar el alcance de las campañas segmentando a usuarios similares a los que ya se segmentan.

Type: enum

Possible values: BROAD, DEFINED, EXPANDED
bid_amount_local_micro
opcional
El importe de la puja que se asociará a este elemento de línea. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, 5,50 USD se representa como 5500000.

Nota: Obligatorio si bid_strategy se configura en MAX o TARGET

Nota: Solo se aceptan valores mayores que cero.

Type: long

Example: 140000
bid_strategy
opcional
El mecanismo de puja.

AUTO optimiza automáticamente las pujas en función del presupuesto diario y de las fechas de vigencia de la campaña.

MAX establece la puja máxima permitida y no está disponible cuando el objetivo se establece en REACH o FOLLOWERS.

TARGET procura que el promedio diario de la puja se mantenga dentro del 20% del valor especificado en bid_amount_local_micro y está disponible cuando el objetivo se establece en REACH o WEBSITE_CLICKS.

Nota: Si se establece en AUTO, se ignorará bid_amount_local_micro.

Nota: Valor predeterminado según el objetivo.

Tipo: enumeración

Valores posibles: AUTO, MAX, TARGET
categories
opcional
Las categorías IAB relevantes para este anunciante. Consulta GET iab_categories.

Nota: Es obligatorio cuando la ubicación del line item se establece en PUBLISHER_NETWORK.

Tipo: string

Ejemplo: IAB3-1
duration_in_days
opcional
El período de tiempo durante el cual se cumple el frequency_cap.

Type: int

Valores posibles: 1, 7, 30
entity_status
opcional
El estado de la línea de pedido.

Type: enum

Possible values: ACTIVE, PAUSED
end_time
opcional
La fecha y hora, expresadas en ISO 8601, en que el line item dejará de publicarse.

Type: string

Ejemplo: 2017-10-05T00:00:00Z
frequency_cap
opcional
El número máximo de veces que un anuncio podría mostrarse a un usuario.

Nota: Solo se admite para los objetivos REACH, ENGAGEMENTS, VIDEO_VIEWS y PREROLL_VIEWS.

Type: int

Example: 5
goal
opcional
La configuración de optimización que se usará para este elemento de línea. La opción APP_PURCHASES está disponible para APP_INSTALL. Las opciones APP_CLICKS y APP_INSTALLS están disponibles para APP_INSTALL y APP_ENGAGEMENTS y pueden requerir usar un socio MACT compatible.

Nota: Valor predeterminado según el objetivo.

Tipo: enum

Valores posibles: APP_CLICKS, APP_INSTALLS, APP_PURCHASES, ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
ios_app_store_identifier
opcional
La parte numérica del identificador de Apple App Store para aplicaciones promocionadas.

Nota: Los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren configurar al menos un identificador de tienda de aplicaciones, ya sea android_app_store_identifier o ios_app_store_identifier.

Tipo: string

Ejemplo: 333903271
nombre
opcional
El nombre del line item.

Tipo: string

Ejemplo: demo
pay_by
opcional
La unidad con la que se cobrará este elemento de línea. Esta configuración solo se puede modificar para elementos de línea que usen el objetivo APP_INSTALLS.

Nota: El pay_by predeterminado se establece automáticamente según el objetivo de la campaña y la unidad de puja del elemento de línea.

El objetivo APP_INSTALLS admite tanto los valores APP_CLICK como IMPRESSION. IMPRESSION es el valor predeterminado.

El objetivo LINK_CLICKS admite los valores LINK_CLICK e IMPRESSION. IMPRESSION es el valor predeterminado, pero no se admite cuando se establece TARGET para bid_strategy.

El objetivo SITE_VISITS admite el valor IMPRESSION.

Tipo: enum

Valores posibles: APP_CLICK, IMPRESSION, LINK_CLICK
start_time
opcional
La fecha y hora, expresadas en ISO 8601, en la que el elemento de línea comenzará a mostrarse.

Type: string

Example: 2017-07-05T00:00:00Z
total_budget_amount_local_micro
opcional
El importe total del presupuesto que se asignará al line item. Se utilizará la moneda asociada al instrumento de financiación especificado. Para USD, 37,50 $ se representa como 37500000.

Type: long

Ejemplo: 37500000
daily_budget_amount_local_micro
opcional
El monto del presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $5.50 se representa como 5500000. Cuando no se proporciona, la campaña gastará de manera uniforme en función del presupuesto total y de la duración del periodo de difusión de la campaña. Solo está disponible cuando budget_optimization está configurado como LINE_ITEM para la campaña principal.

Nota: Este valor debe ser menor o igual que total_budget_amount_local_micro.

Type: long

Example: 5500000
Ejemplo de solicitud PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "line_item_id": "9cqi0",
          "bid_amount_local_micro": 140000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2017-07-10T00:00:00Z",
        "bid_amount_local_micro": 140000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9cqi0",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2017-07-07T17:42:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:51:36Z",
        "campaign_id": "8yn7m",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

DELETE accounts/:account_id/line_items/:line_item_id

Elimina el line item especificado que pertenece a la cuenta actual. Nota: Eliminar un line item no es reversible y los intentos posteriores de eliminar el recurso devolverán HTTP 404. Nota: Cuando se elimina un line item, sus promoted_tweets hijo solo se devuelven en los endpoints GET accounts/:account_id/promoted_tweets y GET accounts/:account_id/promoted_tweets/:promoted_tweet_id si se especifica with_deleted=true en la solicitud. Sin embargo, estos promoted_tweets no se eliminan realmente ("deleted": false en la respuesta). No realizamos eliminaciones en cascada. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
line_item_id
required
Una referencia al line item con el que se opera en la solicitud.

Tipo: string

Ejemplo: 9f2ix
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix Example Response
    {
      "data": {
        "bid_strategy": "MAX",
        "advertiser_user_id": "756201191646691328",
        "name": "Untitled",
        "placements": [],
        "start_time": null,
        "bid_amount_local_micro": 100000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "pay_by": "ENGAGEMENT",
        "product_type": "PROMOTED_TWEETS",
        "end_time": "2017-07-21T00:00:00Z",
        "duration_in_days": 1,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9f2ix",
        "entity_status": "ACTIVE",
        "goal": "ENGAGEMENT",
        "frequency_cap": 5,
        "categories": [],
        "currency": "USD",
        "created_at": "2017-07-14T00:01:50Z",
        "updated_at": "2017-08-09T07:41:08Z",
        "campaign_id": "90r8n",
        "creative_source": "MANUAL",
        "deleted": true
      },
      "request": {
        "params": {
          "line_item_id": "9f2ix",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Categorías seleccionadas para ítems de línea

Encontrarás más detalles sobre el uso en la Guía del objetivo de vistas de video pre-roll

GET accounts/:account_id/line_item_curated_categories

Recupera detalles de algunas o todas las categorías seleccionadas de elementos de línea asociadas con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
count
optional
Especifica la cantidad de registros que se intentarán recuperar por cada solicitud.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories Example Response
    {
      "request": {
        "params": {
          "account_id": "abc1"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "by5pw",
          "curated_category_id": "7op29tp2jzeo",
          "id": "1",
          "created_at": "2018-06-29T04:19:53Z",
          "updated_at": "2018-06-29T04:19:53Z",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Recupera los detalles de una categoría curada de una partida de línea específica asociada a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
line_item_curated_category_id
required
Una referencia a la categoría curada de la partida de línea con la que se opera en la solicitud.

Tipo: string

Ejemplo: 43853bhii885
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav Ejemplo de respuesta
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "yav",
          "account_id": "abc1"
        }
      },
      "data": {
        "line_item_id": "by5pw",
        "curated_category_id": "7op29tp2jzeo",
        "id": "yav",
        "created_at": "2018-06-29T04:19:53Z",
        "updated_at": "2018-06-29T04:19:53Z",
        "deleted": false
      }
    }

POST accounts/:account_id/line_item_curated_categories

Asocia un objeto de curated category con el line item especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
curated_category_id
required
Una referencia a la entidad curated category con la que se opera en la solicitud.

Type: string

Example: 10miy
line_item_id
required
Una referencia al line item con el que se opera en la solicitud.

Type: string

Example: 8v7jo
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o Ejemplo de respuesta
    {
      "request": {
        "params": {
          "curated_category_id": "9ddrgesiap6o",
          "line_item_id": "iqwka",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T17:26:42Z",
        "deleted": false
      }
    }

PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Actualiza la categoría seleccionada de la línea de pedido especificada. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
required
Una referencia a la categoría seleccionada de la línea de pedido con la que se está operando en la solicitud.

Type: string

Example: 1bzq3
curated_category_id
optional
Una referencia a la entidad de categoría seleccionada con la que se está operando en la solicitud.

Type: string

Example: 10miy
line_item_id
optional
Una referencia a la línea de pedido con la que se está operando en la solicitud.

Type: string

Example: 8v7jo
Ejemplo de solicitud PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g Ejemplo de respuesta
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "8tujl1p3yn0g",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

Elimina la categoría seleccionada del elemento de línea indicada. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
line_item_curated_category_id
required
Una referencia a la categoría seleccionada del elemento de línea que estás utilizando en la solicitud.

Tipo: string

Ejemplo: 1bzq3
Ejemplo de solicitud DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq Ejemplo de respuesta
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

Ubicaciones de elementos de línea

GET line_items/placements

Obtiene combinaciones válidas de placement y product_type. URL del recurso https://ads-api.x.com/12/line_items/placements Parámetros
NombreDescripción
product_type
optional
Restringe la respuesta solo a las ubicaciones (placements) válidas para el product_type especificado.

Tipo: enum

Valores posibles: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
Ejemplo de solicitud GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT Ejemplo de respuesta
    {
      "data": [
        {
          "product_type": "PROMOTED_ACCOUNT",
          "placements": [
            [
              "ALL_ON_TWITTER"
            ],
            [
              "TWITTER_TIMELINE"
            ]
          ]
        }
      ],
      "request": {
        "params": {
          "product_type": "PROMOTED_ACCOUNT"
        }
      }
    }

Creatividades multimedia

GET accounts/:account_id/media_creatives

Obtén detalles de algunos o todos los creativos multimedia asociados con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
campaign_id
optional
Limita la respuesta solo a los creativos multimedia asociados con la campaña especificada.

Tipo: string

Ejemplo: 8gdx6
count
optional
Especifica el número de registros que se intentarán recuperar por cada solicitud.

Tipo: int

Valor predeterminado: 200
Mín., máx.: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
line_item_ids
optional
Limita la respuesta solo a los creativos multimedia asociados con los elementos de línea especificados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Tipo: string

Ejemplo: 8v7jo
media_creative_ids
optional
Limita la respuesta solo a los creativos multimedia deseados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Tipo: string

Ejemplo: 1bzq3
sort_by
optional
Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Tipo: string

Ejemplo: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3 Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "media_creative_ids": [
            "1bzq3"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8v7jo",
          "landing_url": "https://dev.x.com",
          "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
          "id": "1bzq3",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T06:00:42Z",
          "account_media_id": "10miy",
          "updated_at": "2019-01-11T20:21:26Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/media_creatives/:media_creative_id

Obtiene los detalles de un media creative específico asociado con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
media_creative_id
required
Una referencia al media creative con el que estás trabajando en la solicitud.

Tipo: string

Ejemplo: 43853bhii885
with_deleted
optional
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/media_creatives/1bzq3 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

POST accounts/:account_id/media_creatives

Asocia un objeto account media con el elemento de línea especificado. Usa este endpoint para promocionar anuncios in-stream (cuando el creative_type de account media es PREROLL) o anuncios de imagen (como BANNER o INTERSTITIAL) en Twitter Audience Platform. Nota: Para agregar recursos multimedia al recurso Account Media, usa el endpoint POST accounts/:account_id/media_library. URL del recurso https://ads-api.x.com/12/accounts/:account_id/media_creatives Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
account_media_id
required
Una referencia a la entidad de account media con la que estás trabajando en la solicitud.

Tipo: string

Ejemplo: 10miy
line_item_id
required
Una referencia al elemento de línea con el que estás trabajando en la solicitud.

Tipo: string

Ejemplo: 8v7jo
landing_url
sometimes required
La URL del sitio web al que se dirigirá al usuario. Solo debe usarse con imágenes TAP (o “display creatives”). Este valor se ignorará si se usa con activos prerroll. Para asociar una URL con un activo prerroll, usa el endpoint POST accounts/:account_id/preroll_call_to_actions.

Nota: Obligatorio cuando el objetivo del elemento de línea está configurado como WEBSITE_CLICKS.

Tipo: string

Ejemplo: https://blog.x.com/
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy Ejemplo de respuesta
    {
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "account_media_id": "10miy",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

DELETE accounts/:account_id/media_creatives/:media_creative_id

Elimina el media creative especificado que pertenece a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
media_creative_id
required
Una referencia al media creative con el que operas en la solicitud.

Type: string

Example: 1bzq3
Ejemplo de solicitud DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2021-04-16T21:02:55Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      }
    }

Cuentas promocionadas

GET accounts/:account_id/promoted_accounts

Recupera detalles de algunas o todas las cuentas promocionadas asociadas con uno o más line items dentro de la cuenta actual. Usa GET users/lookup para obtener datos de usuario para las cuentas de usuario identificadas por user_id en la respuesta. Se devolverá un código HTTP 400 si ninguno de los line items especificados está configurado para contener cuentas promocionadas. Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
count
optional
Especifica el número de registros que se intentarán recuperar por cada solicitud independiente.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
line_item_ids
optional
Limita la respuesta únicamente a las cuentas promocionadas asociadas con los line items especificados, mediante una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: 9bpb2
promoted_account_ids
optional
Limita la respuesta únicamente a las cuentas promocionadas deseadas, mediante una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: 19pl2
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2 Example Response
    {
      "request": {
        "params": {
          "promoted_account_ids": [
            "19pl2"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "9bpb2",
          "user_id": "756201191646691328",
          "id": "19pl2",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T05:54:13Z",
          "updated_at": "2017-07-05T05:54:13Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/promoted_accounts/:promoted_account_id

Recupera una referencia específica a una cuenta asociada con un elemento de línea dentro de la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
promoted_account_id
required
Una referencia a la cuenta promocionada con la que estás operando en la solicitud.

Tipo: string

Ejemplo: 19pl2
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Valor predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 Example Response
    {
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

POST accounts/:account_id/promoted_accounts

Asocia una cuenta (user_id) con el elemento de línea especificado. Si el elemento de línea especificado no está configurado para asociarse con Promoted Accounts, se devolverá un error HTTP 400 INCOMPATIBLE_LINE_ITEM. Si el usuario especificado no es apto para ser promocionado, se devolverá un error HTTP 400 y no se promocionará a ningún usuario. Si el usuario proporcionado ya está promocionado, la solicitud se ignorará. Para obtener más información sobre Promoted Accounts, consulta nuestra página de gestión de campañas. Nota: No es posible actualizar (PUT) entidades de Promoted Accounts. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
line_item_id
required
Una referencia al elemento de línea con el que estás operando en la solicitud.

Type: string

Example: 9bpb2
user_id
required
Una referencia al usuario con el que estás operando en la solicitud. Usa GET users/lookup para recuperar un id de usuario para un nombre de pantalla.

Type: long

Example: 756201191646691328
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328 Ejemplo de respuesta
    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      },
      "request": {
        "params": {
          "user_id": "756201191646691328",
          "line_item_id": "9bpb2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/promoted_accounts/:promoted_account_id

Desasocia una cuenta del line item especificado. Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes a la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
promoted_account_id
required
El identificador se refiere a la instancia de una Promoted Account asociada con un line item.

Type: string

Example: 19pl2
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 Example Response
    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-08-23T18:53:15Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

GET accounts/:account_id/promoted_tweets

Recupera referencias a Tweets asociados a elementos de línea en la cuenta actual. Usa el endpoint GET accounts/:account_id/tweets para obtener los objetos Tweet. Usa los valores de tweet_id de cada objeto promoted_tweets. Nota: Cuando los elementos de línea principales se eliminan, los promoted_tweets solo se devuelven si se especifica with_deleted=true en la solicitud. Sin embargo, estos promoted_tweets no se eliminan realmente ("deleted": false en la respuesta). URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
count
optional
Especifica la cantidad de registros que se intenta recuperar por cada solicitud distinta.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
line_item_ids
optional
Limita la respuesta solo a los Tweets asociados con elementos de línea específicos, especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: 96uzp
promoted_tweet_ids
optional
Limita la respuesta solo a los Tweets promocionados deseados, especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: 1efwlo
sort_by
optional
Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 cada 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo Ejemplo de respuesta
    {
      "request": {
        "params": {
          "promoted_tweet_ids": [
            "1efwlo"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "96uzp",
          "id": "1efwlo",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-29T05:06:57Z",
          "updated_at": "2017-06-29T05:08:46Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "880290790664060928",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/promoted_tweets/:promoted_tweet_id

Recupera una referencia específica a un Tweet asociado con un elemento de línea de la cuenta actual. Nota: Cuando se eliminan los elementos de línea padre, solo se devuelven los promoted_tweets si se especifica with_deleted=true en la solicitud. Sin embargo, estos promoted_tweets no se eliminan realmente ("deleted": false en la respuesta). URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
promoted_tweet_id
required
Una referencia al Tweet promocionado con el que estás trabajando en la solicitud.

Type: string

Example: 1efwlo
with_deleted
optional
Incluye los resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo Ejemplo de respuesta
    {
      "request": {
        "params": {
          "promoted_tweet_id": "1efwlo",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "96uzp",
        "id": "1efwlo",
        "entity_status": "ACTIVE",
        "created_at": "2017-06-29T05:06:57Z",
        "updated_at": "2017-06-29T05:08:46Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "880290790664060928",
        "deleted": false
      }
    }

POST accounts/:account_id/promoted_tweets

Asocia uno o más Tweets con el elemento de línea especificado. No todos los Tweets son adecuados para promoción, dependiendo del objetivo de la campaña. Consulta Objective-based Campaigns para obtener más información. Cuando uses el tipo de producto PROMOTED_ACCOUNT, asociar un Tweet con el line_item añadirá ubicaciones en la cronología en dispositivos móviles además de la ubicación estándar de PROMOTED_ACCOUNT. Nota: No es posible actualizar (PUT) entidades de Tweet promocionado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
line_item_id
required
Una referencia al elemento de línea con el que estás trabajando en la solicitud.

Type: string

Example: 8v7jo
tweet_ids
required
Una lista separada por comas de identificadores que corresponden a Tweets específicos. Se pueden proporcionar hasta 50 identificadores.

Type: long

Example: 822333526255120384
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384 Ejemplo de respuesta
    {
      "data": [
        {
          "line_item_id": "8v7jo",
          "id": "1e8i2k",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-24T04:21:36Z",
          "updated_at": "2017-06-24T04:21:36Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "822333526255120384",
          "deleted": false
        }
      ],
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "tweet_ids": [
            822333526255120384
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "total_count": 1
    }

DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id

Desvincula un Tweet del elemento de línea especificado. Nota: Una entidad promoted_tweets eliminada se mostrará como “Paused” en la interfaz de usuario de ads.x.com. De forma similar, “pausar” desde la interfaz desasociará el Tweet de su elemento de línea. Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
promoted_tweet_id
required
El identificador hace referencia a la instancia de un Tweet promocionado asociada con un elemento de línea. Proviene del campo id de un elemento de respuesta de GET accounts/:account_id/promoted_tweets, no del tweet_id del Tweet en cuestión. Se proporciona dentro de la ruta del recurso.

Type: string

Example: 1gp8a5
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5 Example Response
    {
      "data": {
        "line_item_id": "9pl99",
        "id": "1gp8a5",
        "entity_status": "ACTIVE",
        "created_at": "2017-08-17T17:02:21Z",
        "updated_at": "2017-08-18T06:43:48Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "844796297743757315",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_tweet_id": "1gp8a5",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Usuarios aptos para promoción

GET accounts/:account_id/promotable_users

Obtén detalles de algunos o de todos los usuarios promocionables asociados con la cuenta actual. El tipo de usuario promocionable es FULL o RETWEETS_ONLY. Esto controla el tipo de contenido que la cuenta puede promocionar. Los anunciantes deben obtener permiso para promocionar el contenido de otro usuario y contactar a Twitter para que lo agreguen a su cuenta como usuario promocionable RETWEETS_ONLY. Siempre que los permisos estén configurados correctamente, puedes hacer solicitudes a los endpoints de productos promocionados que hacen referencia directamente al ID del Tweet que deseas promocionar. Puedes usar el endpoint POST accounts/:account_id/promoted-tweets para promocionar Tweets publicados y el endpoint POST accounts/:account_id/scheduled-promoted-tweets para promocionar los Tweets programados de otra cuenta de Twitter Ads. No tienes que hacer retweet del Tweet de destino. Cuando promocionas un Tweet con este enfoque, el tweet_id que se devuelve será diferente del ID del Tweet que se proporcionó. En segundo plano, el Tweet se está retuiteando como un Tweet sin difusión (nullcasted) y luego se promociona. El tweet_id que se devuelve corresponde a este nuevo Tweet. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promotable_users Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada para las promociones. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud independiente.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información.

Type: string

Example: 8x7v00oow
promotable_user_ids
optional
Limita la respuesta solo a los usuarios promocionables deseados, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Type: string

Example: l310s
sort_by
optional
Ordena por el atributo admitido, en orden ascendente o descendente. Consulta Sorting para más información.

Type: string

Example: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente fijados en 200 por cada 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s Ejemplo de respuesta
    {
      "request": {
        "params": {
          "promotable_user_ids": [
            "l310s"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "user_id": "756201191646691328",
          "id": "l310s",
          "created_at": "2016-07-21T22:42:09Z",
          "updated_at": "2016-07-21T22:42:09Z",
          "deleted": false,
          "promotable_user_type": "FULL"
        }
      ]
    }

GET accounts/:account_id/promotable_users/:promotable_user_id

Recupera un usuario promocionable específico asociado a la cuenta actual. El tipo de usuario promocionable es FULL o RETWEETS_ONLY. Esto controla el tipo de contenido que se permite promocionar desde la cuenta. Los anunciantes deben obtener permiso para promocionar el contenido de otro usuario. Siempre que los permisos estén configurados correctamente, puedes hacer solicitudes a los endpoints de productos promocionados que hacen referencia directamente al ID del Tweet que quieres promocionar. No es necesario que retuitees el Tweet de destino. Cuando promocionas un Tweet con este enfoque, el tweet_id que se devuelve será diferente del ID del Tweet que se proporcionó. En segundo plano, el Tweet se está retuiteando como un Tweet nullcasted (sin distribución orgánica) y luego se promociona. El tweet_id que se devuelve corresponde a este nuevo Tweet. Resource URL https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
promotable_user_id
optional
Una referencia al usuario promocionable sobre el que estás operando en la solicitud.

Type: string

Example: l310s
with_deleted
optional
Incluye los resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s Example Response
    {
      "request": {
        "params": {
          "promotable_user_id": "l310s",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "user_id": "2417045708",
        "id": "l310s",
        "created_at": "2017-03-10T17:51:24Z",
        "updated_at": "2017-03-10T17:51:24Z",
        "deleted": false,
        "promotable_user_type": "RETWEETS_ONLY"
      }
    }

Publishers

GET publishers

Recupera una lista con los datos de los publishers de categorías de contenido Se pueden encontrar más detalles en la Guía del objetivo de vistas de video prerroll Resource URL https://ads-api.x.com/12/publishers Parameters Sin parámetros de solicitud Example Request GET https://ads-api.x.com/12/publishers Example Response
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "PeoplesSports",
          "user_id": "1353868435021721602",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "NewYork_Jack",
          "user_id": "1331177123436851206",
          "monetization_restricted": true,
          "content_category_ids": [
            "sk"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "twispatv",
          "user_id": "1331165719128461314",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "LAThieves",
          "user_id": "1316808678897455105",
          "monetization_restricted": true,
          "content_category_ids": [
            "s0"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Quicktake_EE",
          "user_id": "1305900477427724290",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "BR"
          ],
          "promotion_eligible_country_codes": [
            "BR"
          ],
          "username": "eufloribella",
          "user_id": "1300812459054436354",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "EG"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "Egypt2021EN",
          "user_id": "1296077573399678977",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "ClubShayShay",
          "user_id": "1283068366706454529",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "hiaahsanshow",
          "user_id": "1253421442143641601",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "TH"
          ],
          "promotion_eligible_country_codes": [
            "TH"
          ],
          "username": "HoneKrasae",
          "user_id": "1240684293719904256",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Sportskind",
          "user_id": "1232708694418300930",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "almeerathShow",
          "user_id": "1229410512762437633",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "SeeYourVoiceFOX",
          "user_id": "1225490734653947904",
          "monetization_restricted": true,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "AUProSports",
          "user_id": "1219303449768185859",
          "monetization_restricted": false,
          "content_category_ids": [
            "se"
          ]
        }
      ]
    }

Recomendaciones

GET accounts/:account_id/recommendations

Estado: Beta cerrada Obtiene recomendaciones de campaña asociadas con esta cuenta publicitaria. Actualmente hay un límite de 1 recomendación por instrumento de financiación. Resource URL https://ads-api.x.com/5/accounts/:account_id/recommendations Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
Example Request GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations Example Response
    "request": {
      "params": {
        "account_id": "18ce54d4x5t"
      }
    },
    "total_count": 1,
    "data": [
      {
        "funding_instrument_id": "gpvzb",
        "id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t",
        "status": "PENDING",
        "message": "Recommendation for testing",
        "created_at": "2016-11-14T23:07:54Z",
        "updated_at": "2016-11-14T23:07:54Z"
      }
    ]

GET accounts/:account_id/recommendations/:recommendation_id

Estado: Beta cerrada Recupera una recomendación de campaña específica asociada con esta cuenta de anuncios. La recomendación de campaña contiene un conjunto completo de cambios sugeridos para la estructura de la campaña, representados como un árbol de objetos. El árbol de la respuesta está diseñado para funcionar junto con los endpoints de la Batch API, pero también se puede asignar a endpoints de actualización individuales según corresponda (Create para POST, Update para PUT, Delete para DELETE). Resource URL https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
recommendation_id
required
Una referencia al id de recomendación con la que se opera en la solicitud.

Tipo: string

Ejemplo: 62ce8zza1q0w
Example Request GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w Example Response
{
    "request": {
      "params": {
        "recommendation_id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t"
      }
    },
    "data_type": "recommendations",
      "data": {
      "changes": [
        {
          "entity_type": "campaigns",
          "params": {
            "start_time": "2016-11-08T22:00:00Z",
            "daily_budget_amount_local_micro": 2200000,
            "end_time": "2016-11-16T07:59:00Z",
            "total_budget_amount_local_micro": 12000000,
            "id": "64m0d"
          },
          "operation_type": "Update",
          "dependent_entities": [
            {
              "entity_type": "line_items",
              "params": {
                "name": "Campaña de recomendaciones",
                "placements": [
                  "TWITTER_TIMELINE"
                ],
                "bid_amount_local_micro": 1430000,
                "id": "6f5kq",
                "include_sentiment": "ALL"
              },
              "operation_type": "Update",
              "dependent_entities": [
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6p"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "resultados electorales",
                    "targeting_value": "resultados electorales",
                    "targeting_type": "PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftp"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Hombre",
                    "targeting_value": 1,
                    "targeting_type": "GENDER"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "San Francisco-Oakland-San Jose CA, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101fto"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "91125952589766656"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "Segmentación de audiencia de socios",
                    "targeting_value": "v2cx",
                    "targeting_type": "NEGATIVE_BEHAVIOR"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "AGE_21_TO_34",
                    "targeting_value": "AGE_21_TO_34",
                    "targeting_type": "AGE"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6o"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991101965843460096"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991127212156096516"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "debate",
                    "targeting_value": "debate",
                    "targeting_type": "NEGATIVE_PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "60004, IL, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6n"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftn"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                }
              ]
            }
          ]
        }
      ],
      "funding_instrument_id": "gpvzb",
      "id": "62ce8zza1q0w",
      "account_id": "18ce54d4x5t",
      "status": "PENDING",
      "message": "Recomendación de prueba",
      "created_at": "2016-11-14T23:07:54Z",
      "updated_at": "2016-11-14T23:07:54Z"
      }
    }

Tweets promocionados programados

GET accounts/:account_id/scheduled_promoted_tweets

Recupera los detalles de algunos o de todos los Tweets promocionados programados asociados con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parameters
NameDescription
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
count
optional
Especifica la cantidad de registros que se intentará recuperar por cada solicitud distinta.

Tipo: int

Predeterminado: 200
Mín., Máx.: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
line_item_ids
optional
Limita la respuesta solo a los Tweets programados asociados con line items específicos, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Tipo: string

Ejemplo: 8xdpe
scheduled_promoted_tweet_ids
optional
Limita la respuesta solo a los Tweets promocionados programados deseados, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs.

Tipo: string

Ejemplo: 1xboq
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Tipo: string

Ejemplo: created_at-asc
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Tipo: boolean

Predeterminado: false
Valores posibles: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por cada 15 minutos.

Tipo: boolean

Predeterminado: false
Valores posibles: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq Example Response
    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_ids": [
            "1xboq"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8xdpe",
          "id": "1xboq",
          "created_at": "2017-06-01T19:53:32Z",
          "updated_at": "2017-06-01T20:00:06Z",
          "scheduled_tweet_id": "870366669373194240",
          "tweet_id": "870369382207070208",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

Recupera un Tweet promocionado programado específico asociado a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
scheduled_promoted_tweet_id
required
Una referencia al Tweet promocionado programado con el que se opera en la solicitud.

Type: string

Example: 1xboq
with_deleted
optional
Incluye los resultados eliminados en la solicitud.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq Ejemplo de respuesta
    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xboq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xboq",
        "created_at": "2017-06-01T19:53:32Z",
        "updated_at": "2017-06-01T20:00:06Z",
        "scheduled_tweet_id": "870366669373194240",
        "tweet_id": "870369382207070208",
        "deleted": false
      }
    }

POST accounts/:account_id/scheduled_promoted_tweets

Asocia un Tweet programado con el elemento de línea especificado. Nota: No es posible actualizar (PUT) entidades de Tweets promocionados programados. URL del recurso https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
line_item_id
required
Una referencia al elemento de línea con el que se opera en la solicitud.

Type: string

Example: 8xdpe
scheduled_tweet_id
required
Una referencia al Tweet programado con el que se opera en la solicitud.

Type: long

Example: 870358555227860992
Ejemplo de solicitud POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992 Ejemplo de respuesta
    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-08T07:25:26Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": false
      },
      "request": {
        "params": {
          "line_item_id": "8xdpe",
          "scheduled_tweet_id": 870358555227860992,
          "account_id": "18ce54d4x5t"
        }
      }
    }

DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

Desasocia un Tweet programado del line item especificado. Nota: scheduled_promoted_tweets solo se puede eliminar antes de la hora scheduled_at del Tweet programado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
scheduled_promoted_tweet_id
required
Una referencia al Tweet promocionado programado con el que se opera en la solicitud. Este es el atributo id de un objeto de respuesta de GET accounts/:account_id/scheduled_promoted_tweets.

Tipo: string

Ejemplo: 1xtfl
Ejemplo de solicitud DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl Ejemplo de respuesta
    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-15T05:14:12Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": true
      },
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xtfl",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Criterios de segmentación

GET accounts/:account_id/targeting_criteria

Obtiene detalles de algunos o de todos los criterios de segmentación asociados con los line items de la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parámetros
NameDescription
account_id
required
Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
line_item_ids
required
Limita la respuesta únicamente a los criterios de segmentación de los line items especificados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id.

Type: string

Example: 8u94t
count
optional
Especifica la cantidad de registros que se intentará recuperar por cada solicitud.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
lang
optional
Código de idioma ISO-639-1. Cuando se indica, se devolverá en la respuesta un atributo adicional localized_name para los objetos en los que haya un nombre localizado disponible.

Type: string

Example: fr
sort_by
optional
Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
targeting_criterion_ids
optional
Limita la respuesta únicamente a los criterios de segmentación deseados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id.

Type: string

Example: dpl3a6
with_deleted
optional
Incluye los resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa menores, actualmente establecidos en 200 por 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t Ejemplo de respuesta
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "8u94t"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8u94t",
          "name": "Custom audience targeting",
          "id": "dpl3a6",
          "operator_type": "EQ",
          "created_at": "2017-05-26T03:29:35Z",
          "targeting_value": "249yj",
          "updated_at": "2017-05-26T03:29:35Z",
          "deleted": false,
          "targeting_type": "CUSTOM_AUDIENCE"
        }
      ]
    }

GET accounts/:account_id/targeting_criteria/:targeting_criterion_id

Recupera un criterio de segmentación específico asociado a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
targeting_criterion_id
required
Una referencia al criterio de segmentación con el que se opera en la solicitud.

Type: string

Example: eijd4y
lang
optional
Un código de idioma ISO-639-1. Cuando se incluye, se devolverá un atributo adicional localized_name en la respuesta para los objetos en los que haya un nombre localizado disponible.

Type: string

Example: fr
with_deleted
optional
Incluir resultados eliminados en la solicitud.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y Example Response
    {
      "request": {
        "params": {
          "targeting_criterion_id": "eijd4y",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "619jl",
        "name": "🤖",
        "id": "eijd4y",
        "created_at": "2017-07-06T16:51:04Z",
        "targeting_value": "🤖",
        "updated_at": "2017-07-06T16:51:04Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      }
    }

POST accounts/:account_id/targeting_criteria

Consulta la página de Targeting Options para encontrar los valores de targeting_value para tipos de segmentación específicos. Recomendamos actualizar todos los datos semanalmente para asegurarte de que estás trabajando con el conjunto más reciente de valores de tipos de segmentación. Cambiamos los valores y los criterios de segmentación disponibles de vez en cuando; aunque la mayoría de estos no cambian con frecuencia, algunos sí lo hacen. No hay ninguna garantía de que estos valores no cambien. Utiliza los tipos de segmentación BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD o UNORDERED_KEYWORD con las palabras clave especificadas en targeting_value. Excluye palabras clave utilizando el parámetro de solicitud operator_type establecido en NE. Consulta targeting keyword types para obtener una descripción detallada de cada tipo. Nota: Solo es posible segmentar un único rango de edad por line item. Nota: Para segmentar una Audiencia personalizada (Custom Audience), esa audiencia debe ser segmentable; es decir, targerable debe ser igual a true. Nota: Cuando se utilice el tipo de segmentación TV_SHOW, debe existir al menos un criterio de segmentación LOCATION en el line item antes de configurar la segmentación TV_SHOW, y todos los LOCATION deben estar dentro de la misma configuración regional que el TV_SHOW al que se está segmentando. Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
line_item_id
required
Una referencia al line item con el que estás trabajando en la solicitud.

Type: string

Example: 69ob
operator_type
required
Especifica la relación que debe tener el criterio de segmentación. Por ejemplo, para excluir palabras clave, utiliza operator_type=NE.

Type: enum

Possible values: EQ, NE, GTE, LT
targeting_type
required
El tipo de segmentación que se aplicará a este line item.

Posibles valores que no se basan en palabras clave incluyen: AGE, DEVICE, EVENT, CAMPAIGN_ENGAGEMENT, CAMPAIGN_ENGAGEMENT_LOOKALIKE, CONVERSATION, ENGAGEMENT_TYPE, FOLLOWERS_OF_USER, GENDER, INTEREST, LANGUAGE, LIVE_TV_EVENT, LOCATION, NETWORK_ACTIVATION_DURATION, NETWORK_OPERATOR, PLATFORM, PLATFORM_VERSION, SIMILAR_TO_FOLLOWERS_OF_USER, TV_SHOW, USER_ENGAGEMENT, USER_ENGAGEMENT_LOOKALIKE, WIFI_ONLY

Nota: Solo es posible segmentar un único rango de AGE por line item.

Posibles valores basados en palabras clave incluyen: BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORD

Posibles valores de audiencia personalizada incluyen: CUSTOM_AUDIENCE, CUSTOM_AUDIENCE_EXPANDED

Posibles valores de categoría de App Store instalada: APP_STORE_CATEGORY, APP_STORE_CATEGORY_LOOKALIKE

Posible exclusión de app para Twitter Audience Platform (TAP): APP_LIST (solo puede utilizarse con operator_type=NE)
targeting_value
required
Especifica a qué usuario, qué interés, qué ubicación, qué evento, qué plataforma, qué versión de plataforma, qué dispositivo, qué palabra clave o frase, qué género, qué audiencia personalizada, qué categoría de App Store o qué exclusión de una lista de apps se aplicará esta segmentación, según el targeting_type seleccionado.

Type: string

Example: 174958347
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology Ejemplo de respuesta
    {
      "data": {
        "line_item_id": "619jl",
        "name": "technology",
        "id": "fbyjlr",
        "created_at": "2017-09-06T07:31:21Z",
        "targeting_value": "technology",
        "updated_at": "2017-09-06T07:31:21Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      },
      "request": {
        "params": {
          "line_item_id": "619jl",
          "targeting_type": "BROAD_KEYWORD",
          "targeting_value": "technology",
          "account_id": "18ce54d4x5t"
        }
      }
    }

POST batch/accounts/:account_id/targeting_criteria

Permite la creación en lote de nuevos Targeting Criteria con una sola solicitud. Batch Requests
  • El tamaño máximo actual de un lote es 500.
  • Todos los parámetros se envían en el cuerpo de la solicitud y se requiere un Content-Type de application/json.
  • Las solicitudes por lotes fallan o tienen éxito juntas como un grupo y todas las respuestas de la API, tanto de error como de éxito, preservan el orden de los elementos de la solicitud inicial.
Batch Responses Las respuestas de la API por lotes devuelven una colección ordenada de elementos. Por lo demás, son idénticas en estructura a sus endpoints correspondientes de elemento único. Batch Errors
  • Los errores a nivel de solicitud (p. ej., tamaño máximo de lote excedido) se muestran en la respuesta bajo el objeto errors.
  • Los errores a nivel de elemento (p. ej., falta un parámetro obligatorio de Targeting Criteria) se muestran en la respuesta bajo el objeto operation_errors.
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria Parameters
NameDescription
operation_type
required
El tipo de operación por elemento que se está ejecutando.

Type: enum

Possible values: Create, Delete
params
required
Un objeto JSON que contiene todos los parámetros para los objetos de Targeting Criteria. Para obtener una lista de parámetros de Targeting Criteria obligatorios y opcionales, consulta aquí.

Además, este endpoint admite un parámetro operator_type que funciona junto con ciertos valores de targeting_type. Los valores posibles para este parámetro son EQ para igual a, GTE para mayor o igual que, LT para menor que y NE para distinto de.
Example Request POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria
    [
      {
        "operation_type":"Create",
        "params":{
          "line_item_id":"6f9an",
          "targeting_type":"LOCATION",
          "targeting_value":"5122804691e5fecc"
        }
      },
      {
        "operation_type":"Delete",
        "params":{
          "targeting_criterion_id":"al2rua"
        }
      }
    ]
Ejemplo de respuesta
    {
      "data_type": "targeting_criterion",
      "data": [
        {
          "line_item_id": "6f9an",
          "name": "San Francisco-Oakland-San Jose CA, US",
          "id": "al7vt2",
          "location_type": "CITY",
          "operator_type": "EQ",
          "created_at": "2016-11-11T22:59:50Z",
          "targeting_value": "5122804691e5fecc",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": false,
          "targeting_type": "LOCATION"
        },
        {
          "line_item_id": "6keuo",
          "name": "accounts",
          "id": "al2rua",
          "operator_type": "EQ",
          "created_at": "2016-11-11T17:50:19Z",
          "targeting_value": "accounts",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": true,
          "targeting_type": "BROAD_KEYWORD"
        }
      ],
      "request": [
        {
          "params": {
            "line_item_id": "6f9an",
            "targeting_type": "LOCATION",
            "targeting_value": "5122804691e5fecc",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        },
        {
          "params": {
            "targeting_criterion_id": "al2rua",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Delete"
        }
      ]
    }

DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id

Elimina el criterio de segmentación especificado que pertenece a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
targeting_criterion_id
required
Una referencia al criterio de segmentación con el que se está operando en la solicitud.

Type: string

Example: dpl3a6
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6 Example Response
    {
      "data": {
        "line_item_id": "8u94t",
        "name": "Custom audience targeting",
        "id": "dpl3a6",
        "created_at": "2017-05-26T03:29:35Z",
        "targeting_value": "249yj",
        "updated_at": "2017-08-30T18:38:58Z",
        "deleted": true,
        "targeting_type": "CUSTOM_AUDIENCE"
      },
      "request": {
        "params": {
          "targeting_criterion_id": "dpl3a6",
          "account_id": "18ce54d4x5t"
        }
      }
    }

Opciones de segmentación

GET targeting_criteria/app_store_categories

Consulta los criterios de segmentación disponibles basados en categorías de tiendas de aplicaciones para productos promocionados. Las categorías de tiendas de aplicaciones están disponibles solamente para iOS App Store y Google Play Store. La segmentación por categoría de aplicaciones instaladas permite segmentar a los usuarios en función de las categorías de apps que han instalado o en las que han indicado interés. URL del recurso https://ads-api.x.com/12/targeting_criteria/app_store_categories Parámetros
NombreDescripción
q
optional
Una consulta opcional para acotar los criterios de segmentación. Omite este parámetro para recuperar todos los resultados.

Tipo: string

Ejemplo: music
os_type
optional
Limita los resultados a una tienda de aplicaciones específica.

Tipo: enum

Valores posibles: ANDROID, IOS
Solicitud de ejemplo GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS Respuesta de ejemplo
    {
      "data": [
        {
          "name": "Games: Music",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qouq",
          "os_type": "IOS"
        },
        {
          "name": "Music",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qov2",
          "os_type": "IOS"
        }
      ],
      "request": {
        "params": {
          "q": "music",
          "os_type": "IOS"
        }
      }
    }

GET targeting_criteria/conversations

Descubre los criterios de segmentación por conversación disponibles para productos promocionados. URL del recurso https://ads-api.x.com/12/targeting_criteria/conversations Parámetros
NameDescription
conversation_type
optional
Una consulta opcional para limitar los resultados a un determinado tipo de conversación.

Tipo: enum

Valores posibles: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud.

Tipo: int

Predeterminado: 200
Mín., máx.: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Paginación para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "count": 2
        }
      },
      "next_cursor": "1f7m7",
      "data": [
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a1",
          "name": "NFL",
          "conversation_type": "SPORTS"
        },
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a2",
          "name": "NBA",
          "conversation_type": "SPORTS"
        }
      ]
    }

GET targeting_criteria/devices

Consulta los criterios de segmentación disponibles basados en dispositivos para Productos Promocionados. La segmentación por dispositivo está disponible para Tweets Promocionados. Resource URL https://ads-api.x.com/12/targeting_criteria/devices Parameters
NameDescription
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud distinta.

Type: int

Default: 200
Min, Max: 1, 1000
q
optional
Una consulta opcional para acotar criterios de segmentación. Omite este parámetro para recuperar todos los criterios.

Type: string

Example: apple
Example Request GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone Example Response
    {
      "data": [
        {
          "name": "iPhone 3GS",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1q",
          "targeting_type": "DEVICE"
        },
        {
          "name": "iPhone 4",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1r",
          "targeting_type": "DEVICE"
        }
      ],
      "request": {
        "params": {
          "q": "iphone",
          "count": 2
        }
      }
    }

GET targeting_criteria/events

Descubre los criterios de segmentación basados en eventos disponibles para Promoted Products. Solo se puede segmentar un evento por línea de pedido. Nota: Los eventos a menudo existen en varias zonas horarias, lo que provoca complicaciones al considerar los horarios de eventos desde perspectivas entre zonas horarias. Para simplificar esto, todos los valores de start_time y end_time de eventos en este endpoint se representan en UTC±00:00, independientemente de la configuración regional y la zona horaria del evento. Se debe tener en cuenta este diseño al consultar e interactuar con los valores de start_time y end_time de eventos. Por ejemplo, el Día de la Independencia de EE. UU. se representa como start_time=2017-07-04T00:00:00Z y end_time=2017-07-05T00:00:00Z en UTC±00:00, y así se evita el problema de que esta festividad exista en varias zonas horarias dentro de EE. UU. URL del recurso https://ads-api.x.com/12/targeting_criteria/events Parámetros
NombreDescripción
event_types
required
Una consulta opcional para acotar a ciertos tipos de eventos.

Tipo: enum

Valores posibles: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS
count
optional
Especifica la cantidad de registros que se intentarán recuperar por cada solicitud distinta.

Tipo: int

Predeterminado: 200
Mín., Máx.: 1, 1000
country_codes
optional
Una consulta opcional para limitar la búsqueda de criterios de segmentación a países específicos mediante el código de país ISO de 2 letras. Si no se especifica este parámetro, se devuelven todos los eventos.

Tipo: string
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Paginación para más información.

Tipo: string

Ejemplo: 8x7v00oow
end_time
optional
La hora, expresada en formato ISO 8601, en que finalizará la campaña.

Tipo: string

Ejemplo: 2017-10-05T00:00:00Z
start_time
optional
La hora, expresada en formato ISO 8601, en que la línea de pedido comenzará a publicarse.

Nota: De forma predeterminada, se usa la hora actual.

Tipo: string

Ejemplo: 2017-07-05T00:00:00Z
Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/events?count=1 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "count": 1
        }
      },
      "data_type": "events",
      "data": [
        {
          "reach": {
            "total_reach": null
          },
          "name": "New Year's",
          "start_time": "2017-12-31T00:00:00Z",
          "top_users": [],
          "top_tweets": [],
          "top_hashtags": [],
          "gender_breakdown_percentage": {},
          "end_time": "2018-01-02T00:00:00Z",
          "country_code": null,
          "device_breakdown_percentage": {},
          "targeting_value": "1ex",
          "is_global": true,
          "event_type": "HOLIDAY",
          "country_breakdown_percentage": {}
        }
      ],
      "next_cursor": "uww0"
    }

GET targeting_criteria/interests

Descubre los criterios de segmentación basados en intereses disponibles para Promoted Products. Los intereses cambian con poca frecuencia; sin embargo, te sugerimos actualizar esta lista al menos una vez por semana. URL del recurso https://ads-api.x.com/12/targeting_criteria/interests Parámetros
NameDescription
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud distinta.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
q
optional
Una consulta opcional para acotar los criterios de segmentación. Omite este parámetro para recuperar todos los criterios.

Type: string

Example: books
Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/interests?q=books Ejemplo de respuesta
    {
      "data": [
        {
          "name": "Books and literature/Biographies and memoirs",
          "targeting_type": "INTEREST",
          "targeting_value": "1001"
        }
      ],
      "request": {
        "params": {
          "q": "books",
          "count": 1
        }
      },
      "next_cursor": "6by4n4"
    }

GET targeting_criteria/languages

Consulta los idiomas disponibles para la segmentación. Resource URL https://ads-api.x.com/12/targeting_criteria/languages Parameters
NameDescription
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud individual.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
q
optional
Consulta opcional para acotar los criterios de segmentación. Omite este parámetro para recuperar todos los registros.

Type: string

Example: english
Example Request GET https://ads-api.x.com/12/targeting_criteria/languages?q=english Example Response
    {
      "data": [
        {
          "name": "English",
          "targeting_type": "LANGUAGE",
          "targeting_value": "en"
        }
      ],
      "request": {
        "params": {
          "q": "english"
        }
      },
      "next_cursor": null
    }

GET targeting_criteria/locations

Obtenga los criterios de segmentación por ubicación disponibles para productos promocionados. La segmentación geográfica está disponible para Cuentas promocionadas y Tweets promocionados a nivel de país, estado/región, ciudad y código postal. La segmentación por código postal debe utilizarse si desea recuperar métricas a nivel de código postal. Nota: Para recuperar ciudades específicas aptas para segmentación, como San Francisco o Nueva York, utilice el enum CITIES con el parámetro de la solicitud location_type. Para segmentar por Designated Market Areas (DMAs), utilice el enum METROS. URL de recurso https://ads-api.x.com/12/targeting_criteria/locations Parámetros
NombreDescripción
count
opcional
Especifica el número de registros que se intentará recuperar por cada solicitud.

Tipo: int

Valor predeterminado: 200
Mín., máx.: 1, 1000
country_code
opcional
Una consulta opcional para limitar la búsqueda de criterios de segmentación a un país específico con el código de país ISO de 2 letras. Omita este parámetro para recuperar resultados para todos los países.

Tipo: string

Ejemplo: JP
cursor
opcional
Especifica un cursor para obtener la siguiente página de resultados. Consulte Paginación para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
location_type
opcional
Limita los resultados a un tipo específico de ubicación. Una segmentación más granular que COUNTRIES puede no estar disponible en todas las ubicaciones.

Tipo: enum

Valores posibles: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES
q
opcional
Una consulta opcional para limitar la búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados.

Tipo: string

Ejemplo: New York
Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles Ejemplo de respuesta
    {
      "data": [
        {
          "name": "Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "3b77caf94bfc81fe",
          "targeting_type": "LOCATION"
        },
        {
          "name": "East Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "67571a7baaa5906b",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Lake Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "ea9bfbd43c93400f",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Gatos, San Francisco-Oakland-San Jose CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "a2de7c70b82b0ca0",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Altos, Monterey-Salinas CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "6a4364ea6f987c10",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Banos, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "b1b6fc646de75904",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Alamitos, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "0799ff0a3c1006e9",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Angeles, US",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "019940ae78c7b3bc",
          "targeting_type": "LOCATION"
        }
      ],
      "request": {
        "params": {
          "location_type": "CITIES",
          "q": "los angeles"
        }
      },
      "next_cursor": null
    }

GET targeting_criteria/network_operators

Descubre los criterios de segmentación disponibles basados en operadores de red para productos promocionados. Este endpoint te permite buscar operadores de telefonía móvil segmentables, como AT&T, Verizon, Sprint, T-Mobile, etc., en múltiples países. Resource URL https://ads-api.x.com/12/targeting_criteria/network_operators Parameters
NameDescription
count
optional
Especifica la cantidad de registros que se intentarán recuperar por cada solicitud distinta.

Type: int

Default: 200
Min, Max: 1, 1000
country_code
optional
Una consulta opcional para limitar una búsqueda de criterios de segmentación a un país específico con el código de país ISO de 2 letras. Si no se especifica este parámetro, solo se devuelven audiencias de socios para Estados Unidos.

Type: string

Default: US
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información.

Type: string

Example: 8x7v00oow
q
optional
Una consulta opcional para limitar una búsqueda de criterios de segmentación. Omite este parámetro para recuperar todos los resultados.

Type: string

Examples: Airpeak
Example Request GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US Example Response
    {
      "data": [
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Advantage",
          "targeting_value": "2l"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Aeris",
          "targeting_value": "1b"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airadigm",
          "targeting_value": "2t"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airlink PCS",
          "targeting_value": "14"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airpeak",
          "targeting_value": "1i"
        }
      ],
      "request": {
        "params": {
          "country_code": "US",
          "count": 5
        }
      },
      "next_cursor": "o7x9iet1a5u608olj4"
    }

GET targeting_criteria/platform_versions

Consulta los criterios de segmentación disponibles basados en versiones de sistemas operativos móviles para Promoted Products. La segmentación por versión de plataforma está disponible para Promoted Accounts y Promoted Tweets. Esto permite segmentar hasta la versión específica (point release) de un sistema operativo móvil, como Android 8.0 o iOS 10.0. URL del recurso https://ads-api.x.com/12/targeting_criteria/platform_versions Parámetros
NombreDescripción
q
optional
Una consulta opcional para acotar una búsqueda de criterios de segmentación. Omite este parámetro para recuperar todos los resultados.

Tipo: string

Ejemplos: jelly bean
Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/platform_versions Ejemplo de respuesta
    {
        "data": [
            {...},
            {
                "name": "Ice Cream Sandwich",
                "number": "4.0",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "17"
            },
            {
                "name": "Jelly Bean",
                "number": "4.1",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "18"
            },
            {...}
        ],
        "data_type": "targeting_criterion",
        "request": {
            "params": {}
        }
    }

GET targeting_criteria/platforms

Descubre los criterios de segmentación disponibles según la plataforma para productos promocionados. URL del recurso https://ads-api.x.com/12/targeting_criteria/platforms Parámetros
NombreDescripción
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud distinta.

Type: int

Default: 200
Min, Max: 1, 1000
q
optional
Una consulta opcional para acotar la búsqueda de criterios de segmentación. Omite este parámetro para recuperar todos los resultados.

Type: string

Examples: ios, blackberry
lang
optional
Uso de un código de idioma ISO-639-1. Cuando se envía, se devolverá en la respuesta un atributo adicional localized_name.

Type: int, string

Example: fr
Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/platforms Ejemplo de respuesta
    {
      "data": [
        {
          "name": "iOS",
          "targeting_type": "PLATFORM",
          "targeting_value": "0"
        },
        {
          "name": "Android",
          "targeting_type": "PLATFORM",
          "targeting_value": "1"
        },
        {
          "name": "BlackBerry phones and tablets",
          "targeting_type": "PLATFORM",
          "targeting_value": "2"
        },
        {
          "name": "Mobile web on other devices",
          "targeting_type": "PLATFORM",
          "targeting_value": "3"
        },
        {
          "name": "Desktop and laptop computers",
          "targeting_type": "PLATFORM",
          "targeting_value": "4"
        }
      ],
      "request": {
        "params": {}
      }
    }

GET targeting_criteria/tv_markets

Descubre los mercados de TV disponibles en los que se pueden segmentar programas de TV. Devuelve los mercados, por configuración regional, que se pueden usar para consultar el endpoint GET targeting_criteria/tv_shows. URL del recurso https://ads-api.x.com/12/targeting_criteria/tv_markets Parámetros Ninguno Ejemplo de solicitud GET https://ads-api.x.com/12/targeting_criteria/tv_markets Ejemplo de respuesta
    {
      "data": [
        {
          "name": "Francia",
          "country_code": "FR",
          "locale": "fr-FR"
        },
        {
          "name": "Chile",
          "country_code": "CL",
          "locale": "es-CL"
        },
        {
          "name": "Alemania",
          "country_code": "DE",
          "locale": "de-DE"
        },
        {
          "name": "Países Bajos",
          "country_code": "NL",
          "locale": "nl-NL"
        },
        {
          "name": "Estados Unidos",
          "country_code": "US",
          "locale": "en-US"
        },
        {
          "name": "Venezuela",
          "country_code": "VE",
          "locale": "es-VE"
        },
        {
          "name": "Brasil",
          "country_code": "BR",
          "locale": "pt-BR"
        },
        {
          "name": "México",
          "country_code": "MX",
          "locale": "es-MX"
        },
        {
          "name": "Colombia",
          "country_code": "CO",
          "locale": "es-CO"
        },
        {
          "name": "Reino Unido",
          "country_code": "GB",
          "locale": "en-GB"
        },
        {
          "name": "Argentina",
          "country_code": "AR",
          "locale": "es-AR"
        },
        {
          "name": "Japón",
          "country_code": "JP",
          "locale": "ja-JP"
        },
        {
          "name": "Canadá",
          "country_code": "CA",
          "locale": "en-CA"
        },
        {
          "name": "España",
          "country_code": "ES",
          "locale": "es-ES"
        },
        {
          "name": "Italia",
          "country_code": "IT",
          "locale": "it-IT"
        },
        {
          "name": "Estados Unidos - Hispano",
          "country_code": "US",
          "locale": "es-US"
        },
        {
          "name": "Irlanda",
          "country_code": "IE",
          "locale": "en-IE"
        }
      ],
      "request": {
        "params": {}
      }
    }

GET targeting_criteria/tv_shows

Obtén los criterios de segmentación disponibles basados en programas de TV para productos promocionados. La segmentación por programas de TV está disponible para Tweets promocionados en ciertos mercados. Consulta el endpoint GET targeting_criteria/tv_markets para ver los mercados disponibles. Nota: Cualquier audiencia que contenga menos de 1,000 usuarios aparecerá con un valor de estimated_users de 1000. Nota: Las opciones de segmentación por canal de TV y género ya no se admiten. Resource URL https://ads-api.x.com/12/targeting_criteria/tv_shows Parameters
NameDescription
locale
required
Un parámetro obligatorio que especifica el tv_market_locale para consultar los programas de TV disponibles. Los mercados de TV se consultan en función del locale devuelto por GET targeting_criteria/tv_markets.

Tipo: string

Ejemplo: en-US
count
optional
Especifica la cantidad de registros que se intentarán recuperar por cada solicitud distinta.

Tipo: int

Predeterminado: 50
Mín., máx.: 1, 50
cursor
optional
Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para obtener más información.

Tipo: string

Ejemplo: 8x7v00oow
q
optional
Una consulta opcional para acotar una búsqueda de criterios de segmentación. Omite este parámetro para recuperar todos los resultados.

Tipo: string

Ejemplos: ios, blackberry
Example Request GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1 Example Response
    {
      "data": [
        {
          "name": "NewsWatch",
          "targeting_value": 10027243420,
          "genre": "PAID",
          "locales": [
            {
              "language": "en",
              "country": "US"
            }
          ]
        }
      ],
      "next_cursor": "c-22838-zdQDJrTxSvOYfQOhb2IlGQ",
      "request": {
        "params": {
          "locale": {
            "countryCode": "US",
            "languageCode": "en"
          },
          "count": 1,
          "q": "news"
        }
      }
    }

Sugerencias de segmentación

GET accounts/:account_id/targeting_suggestions

Obtén hasta 50 sugerencias de segmentación por palabra clave o por usuario para complementar tu selección inicial. Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario que se está autenticando.

Type: string

Example: 18ce54d4x5t
suggestion_type
required
Especifica el tipo de sugerencias que se deben devolver.

Type: enum

Possible values: KEYWORD, USER_ID
targeting_values
required
Conjunto separado por comas de palabras clave o IDs de usuario que se usa para alimentar las sugerencias.

Note: Estos dos tipos de sugerencias no se pueden mezclar.

Example: 756201191646691328
count
optional
Especifica la cantidad de registros que se intentará obtener por cada solicitud independiente.

Type: int

Default: 30
Min, Max: 1, 50
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2" Example Response
    {
      "data": [
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "devs"
        },
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "software"
        }
      ],
      "request": {
        "params": {
          "suggestion_type": "KEYWORD",
          "targeting_values": [
            "developers"
          ],
          "count": 2,
          "account_id": "18ce54d4x5t"
        }
      }
    }

Configuración fiscal

GET accounts/:account_id/tax_settings

Obtén los detalles de la configuración fiscal asociada a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/tax_settings Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings Example Response
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Inc.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

PUT accounts/:account_id/tax_settings

Actualiza la configuración fiscal de la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tax_settings Parámetros
NombreDescripción
account_id
obligatorio
El identificador de la cuenta de referencia. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
address_city
opcional
La ciudad correspondiente a la dirección del titular de la cuenta.

Type: string

Example: San Francisco
address_country
opcional
El código de país de dos letras de la dirección del titular de la cuenta.

Type: string

Ejemplo: US
address_email
opcional
El correo electrónico asociado a la dirección del titular de la cuenta.

Tipo: string

Ejemplo: api@mctestface.com
address_first_name
opcional
El nombre de pila del propietario de la cuenta asociado a la dirección.

Type: string

Example: API
address_last_name
opcional
El apellido del titular de la cuenta asociado a la dirección.

Type: string

Example: McTestface
address_name
opcional
El nombre de la empresa en la dirección del titular de la cuenta.

Type: string

Ejemplo: ABC, Co.
address_postal_code
opcional
El código postal de la dirección del titular de la cuenta.

Type: string

Ejemplo: 94102
address_region
opcional
La región de la dirección del propietario de la cuenta.

Type: string

Ejemplo: California
address_street1
opcional
La línea correspondiente a la calle en la dirección del propietario de la cuenta.

Type: string

Example: 21 March St
address_street2
opcional
La segunda línea de la dirección del propietario de la cuenta.

Type: string

Example: Suite 99
bill_to
opcional
La entidad a la que se le factura.

Type: enum

Valores posibles: ADVERTISER, AGENCY
business_relationship
opcional
Indica si la cuenta pertenece al anunciante o a la agencia.

Type: enum

Possible values: AGENCY, SELF
client_address_city
opcional
La ciudad de la dirección del anunciante.

Configura este valor cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Ejemplo: Toronto
client_address_country
opcional
Código de país de dos letras de la dirección del anunciante.

Establece este valor cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Example: CA
client_address_email
opcional
El correo electrónico asociado a la dirección del anunciante.

Configúralo cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Example: ads@brand.com
client_address_first_name
opcional
El nombre asociado a la dirección del anunciante.

Configura este valor cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Example: Brand
client_address_last_name
opcional
El apellido asociado a la dirección del anunciante.

Establece este valor cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Example: Advertiser
client_address_name
opcional
El nombre de la empresa en la dirección del anunciante.

Configura este campo cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Example: Brand, Inc.
client_address_postal_code
opcional
El código postal de la dirección del anunciante.

Establece este valor cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Ejemplo: M5H 2N2
client_address_region
opcional
La región de la dirección del anunciante.

Define este valor cuando la cuenta de anuncios sea propiedad de una agencia.

Type: string

Ejemplo: Ontario
client_address_street1
opcional
La primera línea de la dirección del anunciante.

Configura este valor cuando la cuenta de anuncios pertenezca a una agencia.

Type: string

Ejemplo: 280 Queen St W
client_address_street2
opcional
La segunda línea de la dirección del anunciante.

Configura esto cuando la cuenta de anuncios pertenezca a una agencia.

Type: string

Ejemplo: The 6
invoice_jurisdiction
opcional
Jurisdicción de facturación.

Type: enum

Valores posibles: LOI_SAPIN, NONE, NOT_SET
tax_category
opcional
Indica si la tributación debe ser individual o empresarial.

Tipo: enum

Valores posibles: BUSINESS_NO_VAT, BUSINESS_WITH_VAT, INDIVIDUAL
tax_exemption_id
opcional
Identificador de exención de IVA.

Tipo: sting

Ejemplo: 12345
tax_id
opcional
ID de registro de IVA.

Tipo: string

Valores posibles: 67890
Ejemplo de solicitud PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co. Ejemplo de respuesta
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "address_name": "ABC Co."
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Co.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

Etiquetas de seguimiento

GET accounts/:account_id/tracking_tags

Obtén detalles de algunas o todas las etiquetas de seguimiento asociadas con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
count
optional
Especifica el número de registros que se intentará recuperar por cada solicitud.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional
Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para obtener más información.

Type: string

Example: 8x7v00oow
line_item_ids
optional
Limita la respuesta solo a las etiquetas de seguimiento asociadas con line items específicos, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID.

Type: string

Example: 96uzp
sort_by
optional
Ordena por el atributo admitido en orden ascendente o descendente. Consulta Sorting para obtener más información.

Type: string

Example: created_at-asc
tracking_tag_ids
optional
Limita la respuesta solo a las etiquetas de seguimiento deseadas, especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 ID.

Type: string

Example: 3m82
with_deleted
optional
Incluye resultados eliminados en tu solicitud.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional
Incluye el atributo de respuesta total_count.

Nota: Este parámetro y cursor son mutuamente excluyentes.

Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82 Example Response
    {
      "request": {
        "params": {
          "tracking_tag_ids": [
            "3m82"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "fdwcl",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "tracking_tag_type": "IMPRESSION_TAG",
          "id": "3m82",
          "created_at": "2019-06-26T17:04:26Z",
          "updated_at": "2019-06-26T17:04:26Z",
          "deleted": false
        }
      ]
    }

GET accounts/:account_id/tracking_tags/:tracking_tag_id

Recupera una etiqueta de seguimiento específica asociada con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
tracking_tag_id
required
Una referencia a la etiqueta de seguimiento con la que operas en la solicitud.

Tipo: string

Ejemplo: 555j
with_deleted
optional
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/tracking_tags/555j Ejemplo de respuesta
    {
      "request": {
        "params": {
          "with_deleted": true,
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2020-08-13T23:02:03Z",
        "deleted": false
      }
    }

POST accounts/:account_id/tracking_tags

Asocia una etiqueta de seguimiento con el elemento de línea especificado. Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, a excepción de GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
line_item_id
required
Una referencia al elemento de línea con el que se opera en la solicitud.

Tipo: string

Ejemplo: 8v7jo
tracking_tag_type
required
El tipo de etiqueta de seguimiento.

Tipo: enum

Valor posible: IMPRESSION_TAG, CLICK_TRACKER
tracking_tag_url
required
La URL de la etiqueta de seguimiento proporcionada por el socio de seguimiento.

Tipo: string

Ejemplo: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 Example Response
    {
      "request": {
        "params": {
          "line_item_id": "fdwcl",
          "tracking_tag_type": "IMPRESSION_TAG",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2019-06-26T17:04:26Z",
        "deleted": false
      }
    }

PUT accounts/:account_id/tracking_tags/:tracking_tag_id

Asocia una etiqueta de seguimiento con el line item especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parámetros
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
tracking_tag_url
required
La URL de la etiqueta de seguimiento proporcionada por el socio de seguimiento.

Tipo: string

Ejemplo: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Ejemplo de solicitud PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 Ejemplo de respuesta
    {
      "request": {
        "params": {
          "tracking_tag_id": "3m82",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2022-01-26T17:04:26Z",
        "deleted": false
      }
    }

DELETE accounts/:account_id/tracking_tags/:tracking_tag_id

Desasocia una etiqueta de seguimiento del line item especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
tracking_tag_id
required
Una referencia a la etiqueta de seguimiento con la que está operando en la solicitud.

Tipo: string

Ejemplo: 555j
Ejemplo de solicitud DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j Ejemplo de respuesta
    {
      "request": {
        "params": {
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2021-08-29T17:12:58Z",
        "deleted": true
      }
    }

Configuración de usuario

(https://app.getpostman.com/run-collection/1d12b9fc623b8e149f87)

GET accounts/:account_id/user_settings/:user_id

Obtiene la configuración del usuario. URL del recurso https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parámetros
NombreDescripción
account_id
required
El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, en general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts.
La cuenta especificada debe estar asociada con el usuario autenticado.

Tipo: string

Ejemplo: 18ce54d4x5t
user_id
required
Una referencia al usuario con el que se opera en la solicitud. Utiliza GET users/lookup para recuperar un id de usuario correspondiente a un nombre de usuario.

Tipo: long

Ejemplo: 756201191646691328
Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328 Respuesta de ejemplo
      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
          }
        },
        "data": {
          "notification_email": "user@domain.com",
          "contact_phone": "",
          "contact_phone_extension": ""
        }
      }

PUT accounts/:account_id/user_settings/:user_id

Actualiza la configuración del usuario. Requiere contexto de usuario. No es accesible para administradores de cuentas. Resource URL https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parameters
NameDescription
account_id
required
El identificador de la cuenta utilizada. Aparece en la ruta del recurso y en GET accounts.
La cuenta especificada debe estar asociada con el usuario autenticado.

Type: string

Example: 18ce54d4x5t
user_id
required
Una referencia al usuario con el que estás operando en la solicitud. Utiliza GET users/lookup para recuperar un id de usuario (user ID) a partir de un screen name.

Type: long

Example: 756201191646691328
notification_email
optional
Correo electrónico que se utilizará para las notificaciones de la cuenta.

Type: string

Example: user@domain.com
contact_phone
optional
Número de teléfono de contacto.

Type: string

Example: 202-555-0128
contact_phone_extension
optional
Extensión para el contacto contact_phone.

Type: string

Example: 1234
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT" Example Response
      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
            "notification_email": "user@domain.com",
            "subscribed_campaign_events": [
              "ACCOUNT_PERFORMANCE",
              "PERFORMANCE_IMPROVEMENT"
            ]
          }
        },
        "data": {
          "notification_email": "user@domain.com",
          "contact_phone": "",
          "Contact_phone_extension": ""
        }
      }