Administración de campañas

API para anunciantes

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

¿Qué puedes promocionar?

Promoted Ads

Las Promoted Ads son anuncios comunes comprados por anunciantes que desean llegar a un público más amplio o impulsar la interacción de sus seguidores existentes.
Las Promoted Ads aparecen claramente etiquetadas como Promoted cuando un anunciante paga por su publicación en X. Por lo demás, las Promoted Ads se comportan como anuncios normales y se pueden volver a publicar, responder, indicar “Me gusta” y más. Tienen reglas de entrega típicas y se crean mediante POST statuses/update.
Los Tweets “solo Promoted”, creados mediante POST accounts/:account_id/tweet, pueden usarse en campañas de Promoted Tweets, pero no se mostrarán a los seguidores ni aparecerán en la cronología pública. Para obtener una lista de tweets solo Promoted de una cuenta determinada, usa GET accounts/:account_id/scoped_timeline.

Cuentas promocionadas

Las Cuentas promocionadas forman parte de Who to Follow, que sugiere cuentas que los usuarios aún no siguen y que podrían resultarles interesantes. Las Cuentas promocionadas ayudan a dar a conocer una variedad aún más amplia de cuentas que podrían gustarles.
Las Cuentas promocionadas para la cronología asocian un Promoted Tweet a una campaña de Cuenta promocionada y se mostrarán en las cronologías 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 de inicio y fin específicas 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 mostramos en la X Ads UI. Las cuentas publicitarias están limitadas a un máximo de 200 campañas activas. Este límite puede aumentarse manualmente hasta 4,000 campañas activas por el X Account Manager del anunciante previa solicitud. 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 line items consumen el presupuesto definido por una campaña. Los line items combinan la puja por interacción, el Tweet o la cuenta que se va a promocionar y las reglas de segmentación.

Analíticas

La X Ads API ofrece un conjunto de endpoints de analíticas para hacer seguimiento y optimizar el rendimiento de los anuncios. Consulte Analíticas y Mejores prácticas de analíticas para obtener más información. Para la métrica de facturación, los datos pueden no estar finalizados hasta tres días después del evento. Antes de ese momento, los datos deben considerarse provisionales. La cifra final facturable siempre será menor que el monto provisional. La cifra facturable se ajusta para descontar el spam y el tráfico relacionado de baja calidad. Consulte Zonas horarias para otras consideraciones sobre el tiempo.

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

El siguiente ejemplo asume que ya instaló, configuró y autorizó su App y usuario usando twurl. twurl es una herramienta de línea de comandos similar a cURL que gestiona correctamente la Autenticación OAuth de X. twurl es una excelente herramienta para probar y depurar rápidamente la funcionalidad de la Ads API (y la REST API). Para ver los encabezados completos de la solicitud y la respuesta, use -t para trazar la llamada, aproximadamente equivalente a la opción -v de cURL. Para este ejemplo, crearemos una campaña de Promoted Ads segmentada por palabra clave.

Obtenga el id de la cuenta.

twurl -H ads-api.x.com /9/accounts/

{
  "request": {
    "params": {
    }
  },
  "data": [
    {
      "name": "Cuenta de prueba para @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": "ACEPTADA",
      "deleted": false
    }
  ],
  "data_type": "account",
  "total_count": 1,
  "next_cursor": null
}

Obtenga el id del instrumento de financiación.

Realice la llamada a la API GET accounts/:account_id/funding_instruments usando el id de la cuenta obtenido en el comando anterior.

twurl -H ads-api.x.com /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
}

Cree una campaña y asígnela al instrumento de financiación.

Especifique una hora de inicio y un presupuesto para la campaña. Para este ejemplo, usaremos un presupuesto de 500 USD y, como límite diario, 50 USD.

twurl -H ads-api.x.com -d "funding_instrument_id=yyyy&name=Mi Primera Campaña&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": "Mi primera campaña",
    "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": "Mi primera campaña",
      "total_budget_amount_local_micro": 500000000
    }
  }
}

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. El elemento de línea incluye el precio de la puja, la segmentación y la parte creativa de la campaña. Para este elemento de línea, promocionaremos Tweets con una puja de 1,50 $.

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": "Sin título",
    "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"
    }
  }
}

Cree un perfil de segmentación asociado con el line item.

Con el line item creado, podemos asignar criterios de segmentación. Queremos segmentar la frase de palabras clave “grumpy cat” en la ubicación del Área de la Bahía de San Francisco. Esto requerirá una consulta del id de ubicación y dos solicitudes POST a targeting_criteria.

twurl -H ads-api.x.com "/9/targeting_criteria/locations?location_type=CITIES&q=San Francisco"

{
  "data": [
    {
      "name": "San Francisco-Oakland-San José CA, EE. UU.",
      "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"
    }
  }
}

Por último, reanuda la línea de pedido.

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

¡Eso es todo! Ahora tenemos en marcha una campaña de Promoted Tweets en Timelines activa, segmentada y con presupuesto.

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 alineadas con sus objetivos de marketing. Para admitir esto, establece el objective adecuado 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. A día de hoy, este campo puede tener los siguientes valores:

APP_ENGAGEMENTS
APP_INSTALLS
FOLLOWERS
ENGAGEMENTS
REACH
VIDEO_VIEWS
PREROLL_VIEWS
WEBSITE_CLICKS

Los objetivos influyen en cómo optimizamos las campañas en nuestras subastas y cómo las facturamos. 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 apps móviles deben contener el objetivo APP_ENGAGEMENTS o APP_INSTALLS. Nota: No se permiten line items con objetivos diferentes dentro de la misma campaña.

Objetivo de campaña	Objetivo de la API	Medios en Tweets	Modelo de precios
Reparticipaciones de app	`APP_ENGAGEMENTS`	Se requiere tarjeta de descarga de app con imagen o video.	CPAC
Instalaciones de app	`APP_INSTALLS`	Se requiere tarjeta de descarga de app con imagen o video.	CPAC o CPI (configurado mediante `charge_by`)
Alcance	`REACH`	Sin restricciones.	CPM
Seguidores	`FOLLOWERS`	El Tweet no es obligatorio, pero se recomienda. No hay restricciones de medios en Tweets para campañas de Seguidores, aunque recomendamos Tweets solo de texto. Más información: https://business.x.com/en/help/campaign-setup/create-a-followers-campaign.html#serve	CPF
Interacciones	`ENGAGEMENTS`	Sin restricciones.	CPE
Reproducciones de video	`VIDEO_VIEWS`	Se requiere tarjeta de conversación de video, video o GIF.	CPV o costo por visualización de 3 s/100%
Reproducciones pre-roll	`PREROLL_VIEWS`	Se requiere video.	CPV o costo por visualización de 3 s/100%
Clics en sitio web	`WEBSITE_CLICKS`	Tarjeta de sitio web recomendada, pero no obligatoria. El Tweet debe tener una tarjeta de sitio web o un enlace al sitio web (no ambos).	CPLC

Instrumentos de financiación

Los instrumentos de financiación son el origen del presupuesto de la campaña. No se pueden crear a través de la Ads API; deben estar establecidos de antemano por el administrador de la cuenta 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 ver los detalles de uno en específico.

Atributos del instrumento de financiación

Descriptivos: account_id, id del instrumento de financiación, type del instrumento de financiación, description e io_header (ID del encabezado de orden de inserción). Ten en cuenta que un único io_header puede estar asociado a varios 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 por una cadena con el formato “%Y-%m-%dT%l:%M:%S%z”. Estado booleano: paused, deleted y cancelled (true o false). Financieros: 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, o 5,500,000. Para representar un “valor entero”, debes multiplicar el micro local 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 corresponden a diferentes métodos de financiación subyacentes y acuerdos de gasto que tenemos con los anunciantes.

Tipos de instrumentos de financiación

Tarjetas de crédito Normalmente utilizadas por anunciantes de autoservicio (sin un administrador de cuentas). Líneas de crédito Se presentan en forma de órdenes de inserción (IO) y las establecen los administradores de cuentas. Líneas de crédito para múltiples handles Los anunciantes pueden financiar campañas con varios handles mediante este tipo de línea de crédito. Esta función la habilita su X Account Manager, asociando los distintos @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. Obtienes los datos enviando una solicitud GET al endpoint funding_instrument. Aquí tienes una respuesta de ejemplo (observa el tipo CREDIT_LINE).

      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 - Línea de Crédito",
            "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 instrumento de financiación es su tipo y el hecho de que está disponible para todas las cuentas asociadas a él. Por supuesto, el crédito restante se ve afectado por todas las campañas financiadas con 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 a través de la API (ni en 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. Se configura a nivel de línea de pedido y las opciones varían según la ubicación. Para establecer nuevos criterios de segmentación, utiliza POST accounts/:account_id/targeting_criteria y PUT accounts/:account_id/targeting_criteria para actualizarlos. Utiliza 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 emplazamiento

Los productos Promoted Tweets y Promoted Accounts pueden estar disponibles en una variedad de emplazamientos. Promoted Trends (PTr) no están disponibles a través de la API. Para conocer las posibles combinaciones de emplazamientos, consulta el endpoint GET line_items/placements. Cada emplazamiento tiene diferentes opciones de segmentación. Ubicación, Plataforma y Género están disponibles para todos. Las demás opciones dependen del tipo de emplazamiento.

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 Wi‑Fi
X Timeline: Segmentación por edad, Dispositivos, Eventos, Seguidores de, Similar a seguidores de, Género, Intereses, Idioma, Ubicaciones, Activación de red, Operadores de red, Tipos de palabras clave no exacta, Tipos de audiencias de socios, Plataforma, Versión de la plataforma, Tipos de retargeting, Audiencias personalizadas, Tipos de segmentación de TV, Solo Wi‑Fi
X Profiles & Tweet Details: Segmentación por edad, Dispositivos, Eventos, Seguidores de, Similar a seguidores de, Género, Intereses, Idioma, Ubicaciones, Activación de red, Operadores de red, Tipos de palabras clave no exacta, Tipos de audiencias de socios, Plataforma, Versión de la plataforma, Tipos de retargeting, Audiencias personalizadas, Tipos de segmentación de TV, Solo Wi‑Fi

Comprender los tipos de segmentación

Segmentación por edad: Segmenta a los usuarios según intervalos de edad específicos. Puedes encontrar una lista de enumeraciones de intervalos de edad en la página de Enumerations. Eventos: Especifica un evento para la segmentación. Solo se puede usar un evento para la segmentación (por elemento de línea). Usa el endpoint GET targeting_criteria/events para encontrar eventos disponibles para la segmentación. Género: Segmenta a hombres (1) o mujeres (2). Deja null para segmentar a todos. Categorías de Apps instaladas: 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 mostrado interés. Consulta GET targeting_criteria/app_store_categories. Intereses: Segmenta a los usuarios por interés. Obtén la lista de intereses desde GET targeting_criteria/interests. Puedes segmentar hasta 100 intereses. Seguidores de: Segmenta a los seguidores de cualquier usuario totalmente promocionable de la cuenta actual (nota: actualmente el titular principal de la cuenta es el único usuario totalmente promocionable de esa cuenta). GET accounts/:account_id/promotable_users para obtener una lista de usuarios promocionables. Similar a Seguidores de: Segmenta a personas con los mismos intereses que los seguidores de usuarios específicos. Puedes usar hasta 100 Users. Ubicaciones: Especifica hasta 2.000 ubicaciones para segmentar. Obtén la lista desde GET targeting_criteria/locations. Existen requisitos adicionales para anuncios que segmentan ciertos países. Consulta Country Targeting and Display Requirements para más información. Palabras clave: Las opciones de segmentación por palabras clave varían según el tipo de ubicación. Puedes usar hasta 1.000 palabras clave para la segmentación (por elemento de línea). Consulta la sección Tipos de palabras clave para ver las opciones. Segmentación por idioma: Segmenta a usuarios que entienden idiomas específicos. Segmentación por operador de red móvil: Permite a los anunciantes segmentar usuarios según su operador móvil, usando el tipo de segmentación NETWORK_OPERATOR de GET targeting_criteria/network_operators. Segmentación por nuevo dispositivo móvil: Llega a 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. Plataformas, Versiones de plataforma, Dispositivos y Solo Wi‑Fi: Permiten segmentar dispositivos móviles según distintos criterios. Plataformas es un tipo de segmentación de alto nivel que abarca categorías amplias de teléfonos. Ejemplos: iOS y Android. Dispositivos permite segmentar a usuarios de dispositivos móviles específicos, por ejemplo iPhone 5s, Nexus 4 o Samsung Galaxy Note. Las versiones de plataforma permiten segmentar a usuarios por versiones específicas de sistemas operativos móviles, hasta la versión puntual. Ejemplos: iOS 7.1 y Android 4.4. Solo Wi‑Fi permite segmentar únicamente a usuarios que usan sus dispositivos en una red Wi‑Fi; si no se establece, se segmentará a usuarios que usan la conexión del operador y Wi‑Fi.

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 SO simultáneamente. Puedo segmentar iPad Air e iOS >= 7.0.
Los usuarios no pueden segmentar plataformas 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 publicitario 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 puede configurarse para aplicarse de forma continua mientras la 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 consultar los programas de TV disponibles. Tweet Engager Retargeting El retargeting de Tweet Engager permite a los anunciantes dirigirse, en todos los dispositivos, a audiencias que previamente han estado expuestas o han interactuado con sus Tweets promocionados u orgánicos en X. Con esta segmentación, los anunciantes pueden hacer seguimiento con personas que vieron o interactuaron con su contenido en X y que tienen más probabilidades de seguir interactuando o convertir con mensajes u ofertas posteriores. Los usuarios serán aptos para la segmentación a los pocos minutos de la exposición o la interacción y seguirán siéndolo hasta 90 días después en el caso de 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. Especifica si deseas segmentar a usuarios expuestos (IMPRESSION) o a usuarios que interactuaron (ENGAGEMENT).
CAMPAIGN_ENGAGEMENT usa un id de campaña como valor de segmentación. Se segmentará a los usuarios que interactuaron con o estuvieron expuestos a esa campaña (según ENGAGEMENT_TYPE).
USER_ENGAGEMENT, que usa el id de usuario promocionado como valor de segmentación para orientar a usuarios que estuvieron expuestos a o interactuaron con contenido orgánico del anunciante (según ENGAGEMENT_TYPE). 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. Pueden estar presentes ambos tipos de segmentación de Tweet Engager y pueden incluirse varias campañas en un mismo elemento de línea. Video Viewer Targeting: La segmentación de espectadores de video se basa en la segmentación de Tweet Engager para permitir a los anunciantes dirigirse a audiencias que previamente han 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 ni a elementos de línea con el objetivo de visualizaciones de video. Tipos de segmentación de Video Viewer:

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, también debe estar presente uno o ambos de los siguientes criterios de segmentación para el elemento de línea cuando se use ENGAGEMENT_TYPE:

CAMPAIGN_ENGAGEMENT usa un id de campaña como valor de segmentación. Se segmentará a los usuarios que vieron un video (según ENGAGEMENT_TYPE) en esa campaña.
USER_ENGAGEMENT, que usa el id de usuario promocionado como valor de segmentación para orientar a usuarios que vieron un video (según ENGAGEMENT_TYPE) en contenido orgánico del anunciante. Debe ser el id de usuario promocionado asociado con la cuenta de Ads.

Tipos de palabras clave Consulta nuestro documento de ayuda sobre keyword targeting para una descripción conceptual.

Broad (valor predeterminado): coincide con todas las palabras, independientemente del orden. No es sensible a mayúsculas, plurales ni tiempos verbales. Se ampliará automáticamente cuando sea posible (p. ej., “car repair” también coincidiría con “automobile fix”). Si deseas segmentar sin expansión, debes agregar un signo + antes de las palabras clave, como “+boat +jet”. Usar palabras clave sin el + aplicará por defecto Broad Match.
Unordered (en desuso): coincide con todas las palabras, independientemente del orden. No es sensible a mayúsculas, plurales ni tiempos verbales.
Phrase: coincide con la cadena exacta de palabras clave; pueden estar presentes otras palabras.
Exact: coincide exactamente con la cadena de palabras clave, y no con ninguna otra.
Negative: evita que coincida con búsquedas que incluyan todas estas palabras clave en algún lugar de la consulta, sin importar el orden en que estén escritas, incluso si hay otras palabras presentes.
Negative Phrase: evita que coincida con búsquedas que incluyan esta cadena exacta de palabras clave en algún lugar de la consulta, incluso si hay otras palabras presentes.
Negative Exact: evita que coincida con búsquedas que coincidan exactamente con estas palabras clave y que no contengan otras palabras.

Segmentación por emoji La segmentación por emoji se admite mediante la segmentación por palabras clave. Para usar la segmentación por emoji, simplemente crea una segmentación por palabras clave con los puntos de código Unicode que representan ese emoji, como U+1F602 (xF0x9Fx98x82 en UTF-8) para el emoji “cara con lágrimas de alegría” (😂). Los emoji que aceptamos pueden confirmarse con la lista de twemoji. Al segmentar un emoji, se incluyen todas sus variaciones. Para un resumen de todos los valores con campos obligatorios/opcionales y 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 Cree campañas que segmenten de forma amplia con criterios de ubicación geográfica, género, idioma y dispositivo/plataforma. Los anunciantes pueden combinar esa segmentación amplia con criterios adicionales (p. ej., intereses, palabras clave, seguidores, audiencias personalizadas, TV). Si no se especifican criterios de segmentación para una partida (line item), esa partida segmentará a todos los usuarios a nivel mundial.


Tipos “principales”	Otros tipos
Seguidores	Ubicaciones
Audiencias personalizadas	Género
Intereses	Idiomas
Palabras clave	Dispositivos y plataformas
TV	Edad

Los criterios de segmentación se combinarán para su grupo de anuncios de la siguiente manera:

Los tipos de segmentación “principales” se combinarán mediante ∪ (es decir, 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 A simple vista: [(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 aplique la segmentación a:

Usuarios de X en EE. UU., Inglaterra y Canadá (Ubicación)
que sean mujeres (Género)
procedentes de una lista de Audiencias personalizadas (“Principal”)
con Palabras clave (“Principal”)

Los criterios de segmentación serán: [US OR GB OR CA] AND [Femenino] AND [Audiencias personalizadas ∪ Palabras clave]

Ejemplos adicionales

Seleccionar género y región, pero sin principal: (Male) AND (US OR GB)
Seleccionar género, región e intereses: (Female) AND (CA) AND (Computers OR Technology OR Startups)
Seleccionar género, región, intereses, Tailored Audiences y palabras clave: (Male) AND (GB) AND (Cars ∪ Tailored Audiences for CRM ∪ autocross)

Ritmo de gasto del presupuesto

Ahora los anunciantes tienen más control sobre la velocidad a la que se consumen sus presupuestos diarios en tus campañas de Cuenta y de Tweet Promocionado. Habilitar la entrega estándar, que es la opción predeterminada, garantiza un ritmo de gasto uniforme a lo largo del día. Al desactivar la entrega estándar, mostraremos impresiones y generaremos interacciones lo más rápido posible hasta que se agote tu presupuesto diario, lo que puede ocurrir bastante temprano en el día según 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 consumir tu presupuesto diario en una campaña lo más rápido posible, establece el parámetro standard_delivery en false para ajustar el ritmo a entrega acelerada (consulta GET accounts/:account_id/campaigns). Notas

El “día” corresponde a la zona horaria de la cuenta de anunciante de X (p. ej., 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 más información sobre presupuestos y ritmo de gasto, consulta las Preguntas frecuentes sobre pujas y subastas.

Puja objetivo

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 de parámetros anteriores (marcadas como heredadas) pueden lograrse estableciendo un parámetro de objetivo equivalente. Puede encontrar más información en el anuncio aquí. A modo de ejemplo:


Objetivo de la campaña	Heredado	Ads API v10+
Instalaciones de App	`bid_type` = `AUTO` `bid_unit` = `APP_INSTALLS` `charge_by` = `APP_CLICKS`	`goal` = `APP_INSTALLS` `bid_strategy` = `AUTO`
Clics en el sitio web	`bid_type` = `TARGET` (Nota: `bid_unit` no era necesario para algunos objetivos de campaña)	`bid_strategy` = `TARGET`

Puja con objetivo

Con la puja con objetivo, puedes especificar un costo objetivo que deseas pagar y la plataforma X Ads optimizará tu campaña para maximizar el rendimiento mientras se mantiene cerca o por debajo de tu costo objetivo. Esta función te ofrece la flexibilidad de llegar a usuarios con mayor probabilidad de realizar la acción deseada (como hacer clic en un enlace, completar un lead o seguir una cuenta), manteniendo 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 opciones de puja). Para los line items con objetivos de campaña compatibles, hemos introducido un nuevo mecanismo de precios para el importe de la puja que te permite especificar un costo objetivo que deseas pagar. Nuestra plataforma de anuncios puja dinámicamente en tu nombre para ayudarte a impulsar más resultados, mientras trabaja para mantener tu costo promedio dentro del 20% de tu objetivo especificado. La configuración bid_strategy en los line items puede establecerse con el valor TARGET para habilitar la puja con objetivo en objetivos de campaña relevantes, como:

WEBSITE_CLICKS
WEBSITE_CONVERSIONS
APP_INSTALLS
APP_ENGAGEMENTS
REACH

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

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

Rusia

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

Instrumentos de financiación gestionados por el socio

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

Configuración inicial del partner

El proceso para configurar inicialmente a un nuevo partner de PMFI Ads API puede tardar hasta 3 semanas desde el intercambio de la información requerida. Para iniciar el proceso, debe compartirse lo siguiente con sus contactos técnicos en X, así como con el contacto de X que gestiona la integración con el partner:

El partner debe compartir su clave pública PGP/GPG. Es necesario intercambiar una clave secreta compartida entre el partner de Ads API y X. Esto se usará 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 el acceso a Ads API. Puede ver y editar sus Apps de X existentes a través del panel de Apps si ha iniciado sesión en su cuenta de X en developer.x.com. Si necesita crear una App de X, deberá 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 un handle corporativo controlado por el partner.

Flujo de incorporación de anunciantes

El flujo de incorporación de anunciantes se realiza a través de un navegador web de la siguiente manera:

El usuario inicia el flujo de incorporación en el sitio web del partner e introduce el handle que desea incorporar.
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, una URL de callback y otros fields documentados a continuación.
Se solicita al usuario que inicie sesión en ads.x.com utilizando la página de inicio de sesión estándar de x.com.
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.
Cuando se completan todas las tareas de incorporación, el usuario es redirigido a la URL de callback proporcionada por el partner del Ads API, con un payload que indica éxito o error. Esto incluye el proceso de autorización de 3 patas.

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:


Nombre	Tipo	Descripción
callback_url	Cadena codificada en URL	el usuario será redirigido a esta URL después de que finalice el proceso de vinculación de la cuenta, independientemente del resultado. Consulta la sección de URL de redirección del partner para conocer los detalles del protocolo
client_app_id	entero	id de App cliente de la X API, usado para identificar al partner administrador
promotable_user_id	entero	user_id de X del @handle cuyas promociones administrará el partner. Se usa para garantizar que sea el mismo que inicia sesión en ads.x.com para completar el proceso de vinculación
fi_description	Cadena codificada en URL (máx. 255 caracteres)	nombre del instrumento de financiación. Esto se mostrará en el campo de descripción en 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 gestionado por el partner. (si existe uno con el mismo nombre, no ocurrirá nada)
timezone	Cadena, en formato Área/Ubicación	Esta será la zona horaria utilizada para determinar el día al que aplican los presupuestos diarios y en la que se agregan los cargos
currency	Código de moneda ISO 4217	Moneda que se utilizará para ingresar pujas y en la que se facturarán los cargos
country	Código de país ISO 3166-1 alfa 2	País de facturación de la cuenta
signature	Código binario codificado en URL y en base64, como se explica a continuación	firma que combina un secreto compartido y los demás 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 mediante el parámetro callback_url en la solicitud de vinculación de cuenta (ver arriba). Los parámetros agregados por ads.x.com son:


Nombre	Tipo	Descripción
status	string	OK 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 utilizada para iniciar sesión en ads.x.com era distinta del promotable_user_id en la solicitud de vinculación 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_id	cadena codificada en URL	id de la cuenta de anuncios de X de la cuenta vinculada
funding_instrument_id	cadena codificada en URL	ID del instrumento de financiación administrado por el socio activo
signature	código binario codificado en URL y en base64, como se explica a continuación	Firma HMAC-SHA1 codificada en Base64 que combina un secreto compartido y los demás parámetros para verificar la autenticidad de la llamada, así como la validez de los parámetros. Para asegurarse de que la URL de callback solo sea válida para el X user_id para el que estaba destinado el proceso de vinculación de cuenta, el X user_id debe anexarse al secreto compartido (usando &) al firmar la solicitud.

Para asegurarse de que la URL de callback solo sea válida para el X user_id para el que estaba destinado el proceso de vinculación de cuenta, el X user_id debe anexarse al secreto compartido (usando &) al firmar la solicitud.

Firma de la solicitud y URLs de callback

Para garantizar que las solicitudes a /link_managed_account y la URL de callback sean válidas, deben firmarse en el origen y ser verificadas por el destinatario antes de que este actúe sobre ellas. 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 usado 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 con ese valor.
Anexe el carácter ‘&’ a la cadena base.
Codifique por porcentaje la URL (sin parámetros) y anéxela a la cadena base.
Anexe el carácter ‘&’ a la cadena base.
Anexe la cadena de consulta codificada por porcentaje, que se construye así:
Codifique por porcentaje cada clave y valor que se firmará.
Ordene la lista de parámetros alfabéticamente por la clave.
Para cada par clave/valor (y con primary_promotable_user_id para la URL de redirección del socio):
Anexe la clave codificada por porcentaje a la cadena de consulta.
Anexe el carácter ‘=’ a la cadena base.
Anexe el valor codificado por porcentaje a la cadena de consulta.
Separe los pares clave=valor codificados por 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 por porcentaje la firma generada en el paso 3 y agréguela a la URL en un parámetro signature

Ejemplos de firma

Firmar una solicitud de vinculación de cuenta URL para 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, es: GET https://ads.x.com/link_managed_account La cadena de consulta, producida por los subpasos de e, es: callback_url=https://managingpartner.com/link_account_callback&client_app_id=12345&fi_description=some name&promotable_user_id=1 Tenga en cuenta que los pares clave-valor están ordenados por nombre de clave. La cadena de consulta con codificación percent-encoding es: 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 agrega (con codificación percent-encoding) al final de la URL original en el parámetro de firma (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 de socio (callback de solicitud de vinculación de cuenta) La URL para 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, es: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“ La cadena de consulta, producida por los subpasos de e, es: account_id=ABC&funding_instrument_id=DEF&status=OK La cadena de consulta con codificación percent-encoding es: 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 el id de usuario de X para el que 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 añade (con codificación por porcentaje) 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 y renovación de claves compartidas

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

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 se pondrán en pausa todos los partner_managed_funding_instruments existentes. 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 puede repetirse si se pierde el token de acceso de la API. La implementación del flujo de incorporación requerirá que el usuario haya iniciado sesión. Si el usuario coincide con el promotable_user_id, se encuentra la cuenta publicitaria asociada y todo es correcto, el usuario será redirigido a la URL de callback, y el socio podrá iniciar el flujo de OAuth para obtener un token de acceso.

Flujo de error no redirigible

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

Actualizaciones continuas del PMFI

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

Ubicaciones

Hay varios lugares donde se pueden mostrar anuncios en X. Esto se configura en el line item 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 line item determinan qué ubicaciones están permitidas. El endpoint GET line_items/placements se puede usar para recuperar las opciones de ubicación válidas para cada tipo de producto. Además, la siguiente tabla enumera las combinaciones válidas de ubicación y objetivo.

Objective	`ALL_ON_TWITTER`	`TWITTER_PROFILE`	`TWITTER_SEARCH`	`TWITTER_TIMELINE`
`APP_ENGAGEMENTS`	✔	✔	✔	✔
`APP_INSTALLS`	✔	✔	✔	✔
`REACH`	✔	✔	✔	✔
`FOLLOWERS`	✔	✔	✔	✔
`ENGAGEMENTS`	✔	✔	✔	✔
`VIDEO_VIEWS`	✔	✔	✔	✔
`PREROLL_VIEWS`	✔	✔	✔	✔
`WEBSITE_CLICKS`	✔	✔	✔	✔

Nota: No es posible especificar solo 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 tener 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 recopila preguntas frecuentes sobre los grupos de anuncios en la X Ads API.

¿Qué es un grupo de anuncios?

Los grupos de anuncios, denominados line items en la Ads API, se encuentran 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 promocionados como anuncios In-stream) asociándolos a 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 conservando la segmentación (posiblemente completamente diferente) y los Tweets asociados a esos line items. Hay un límite de 100 line items por campaña y un límite de 200 campañas activas por cuenta de anuncios. En el conjunto de campañas, hay un límite de 8,000 line items activos por cuenta de anuncios.

¿Por qué deberíamos añadir compatibilidad con Grupos de anuncios?

Los Grupos de anuncios están diseñados para facilitar a los anunciantes la organización, optimización y gestión de sus campañas. La ventaja de los Grupos de anuncios es poder comparar y controlar distintas estrategias de puja, presupuesto, creatividades y segmentación. Al asociar varios Tweets promocionados a un único elemento de línea, la subasta seleccionará el mejor Tweet de ese grupo y, después, el mejor Tweet para esa campaña entre todos los elementos de línea. Si tienes varios Grupos de anuncios con Tweets individuales, se seleccionará el Tweet de ese Grupo de anuncios con mayor probabilidad de obtener mejor rendimiento. El uso de Grupos de anuncios permite dividir la segmentación y las pujas en un número mucho mayor de combinaciones posibles y, en general, segmentar en grupos lógicos. En particular, las herramientas del Ads API podrían basarse en reglas de optimización muy precisas con Grupos de anuncios, algo más difícil de lograr mediante ediciones manuales debido a la mayor escala de combinaciones de elementos de línea y creatividades.

¿Cómo se relaciona el presupuesto del ítem de línea con el presupuesto de la campaña en una campaña de Grupos de anuncios?

El total_budget_amount_local_micro de un ítem de línea no puede exceder el presupuesto total de su campaña principal. De manera similar, el valor de bid_amount_local_micro del ítem de línea no debe exceder daily_budget_amount_local_micro o total_budget_amount_local_micro de la campaña principal. Configurar estos valores de forma incorrecta puede poner la campaña en pausa y dejarla sin posibilidad de entrega. Ten en cuenta que el presupuesto total de la campaña puede ser menor que la suma de los presupuestos de sus ítems de línea secundarios, y la distribución del presupuesto entre los ítems de línea depende en parte de la herramienta de Ads API para optimizarla y ajustarla de forma eficaz, ya que el rendimiento diario de la segmentación (ítem de línea) puede variar significativamente de un día a otro debido a la naturaleza en tiempo real de X.

¿Rinden mejor los Ad Groups que los line items individuales?

El rendimiento de una campaña depende de muchos factores y, en última instancia, el Tweet es el factor decisivo. Un Line Item se considera un factor para determinar si un Tweet siquiera entra en la puja para ser mostrado a un usuario. Los line items que apuntan a los mismos conjuntos de usuarios se consideran con solapamiento de usuarios. Es una práctica recomendada reducir este solapamiento de segmentación entre line items para poder identificar con claridad los conjuntos de usuarios de mejor rendimiento.

Guías

Objetivo de vistas de video con 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 requeridos

Carga de medios por fragmentos (para subir video)
POST accounts/:account_id/media_library (para asociar el video a la cuenta de anuncios)
POST accounts/:account_id/campaigns (crear campaña)
GET content_categories (para obtener la correspondencia entre categorías de contenido y categorías IAB)
GET accounts/:account_id/curated_categories
GET publishers
POST accounts/:account_id/line_item_curated_categories
POST accounts/:account_id/line_items (crear grupo de anuncios)
POST accounts/:account_id/media_creatives (para asociar el video con el grupo de anuncios)
POST accounts/:account_id/preroll_call_to_action (configurar el CTA y la URL de redirección)
POST batch/accounts/:account_id/targeting_criteria (segmentación)

Pasos

Carga el video

La carga del video consta de 2 pasos:

Carga del video

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

Añade el video a la cuenta de anuncios

Una vez que el estado devuelto con el comando STATUS sea succeeded, usarás el media_key devuelto por ese endpoint para añadir el video a la biblioteca de medios del anunciante, utilizando 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
 }
}

Configurar la campaña

Creación de campañas

Cree la campaña y el line item/grupo de anuncios. Los line items deben crearse con el objective VIDEO_VIEWS_PREROLL y el product_type MEDIA. El parámetro categories también debe establecerse con las categorías empresariales 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 configurado con el conjunto correspondiente de categorías IAB, obtenido mediante el endpoint GET content_categories. Cada una de estas categorías de contenido corresponde a una o más categorías IAB. Para utilizar estos valores, los partners deben seleccionar una categoría de contenido adecuada y usar el conjunto completo de iab_categories devuelto en la respuesta para configurar el parámetro categories en el endpoint de line items. Cualquier aplicación parcial de iab_categories hará que se aplique el grupo completo al 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 farmacia",
      "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": "Retail",
      "iab_categories": \[
        "IAB18"
      \]
    },
    {
      "id": "1jr",
      "name": "Viajes",
      "iab_categories": \[
        "IAB20"
      \]
    },
    {
      "id": "1js",
      "name": "Gaming",
      "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": "Automoción",
      "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": "Organizaciones sin fines de lucro",
      "iab_categories": \[
        "IAB11-1",
        "IAB11-2",
        "IAB11-3",
        "IAB11-5"
      \]
    }
  \]
}

Ahora, para establecer el parámetro categories en “Science & Education”, debe configurarse el conjunto completo de iab_categories, es decir, "IAB5", "IAB15", en el elemento de línea, 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 editores

Un anunciante puede optar por segmentar una Categoría de contenido o una Categoría curada, con más detalles a continuación. Nota: Los elementos de línea pueden segmentar Categorías curadas o de contenido, pero no ambas.

Categorías seleccionadas

Las Categorías seleccionadas permiten a los anunciantes segmentar a un grupo predefinido de editores y pueden obtenerse mediante el endpoint GET curated_categories. Estas categorías son específicas por país y, por lo tanto, requieren que el elemento de línea segmente el país correspondiente según el country_code de la categoría. Para usar una de estas categorías, se deben seguir los siguientes pasos en el orden indicado:

El elemento de línea debe segmentar el país correspondiente según el country_code de la Categoría seleccionada
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á a 5 el número de editores que se pueden incluir en la lista de denegación. La lista completa de user_id usados para bloquear editores específicos puede obtenerse desde el endpoint GET publishers. Además, un elemento de línea no puede segmentar 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 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 establecen en el valor 96683cc9126741d

GET https://ads-api.x.com/8/targeting\_criteria/locations?country\_code=US&location_type=COUNTRIES

{
  "data": \[
    {
      "name": "Estados Unidos",
      "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": "Estados Unidos",
      "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 llamadas Categorías estándar, se pueden obtener 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 muestra cómo seleccionar una categoría de contenido específica, id: sr, que corresponde a “Noticias y eventos de actualidad”, y aplicarla al elemento de línea.

Nota: El conjunto completo de iab_categories en la respuesta de GET curated_categories debe segmentarse a través del 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": "Noticias y actualidad",
      "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": "Noticias",
      "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": "Sociedad",
      "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 (video) con el elemento de línea

Usa el endpoint POST accounts/:account_id/media_creatives para asociar el video 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"
   }
 }
}

Configura el CTA y la URL de destino

Es importante tener en cuenta que, a diferencia de la mayoría de las otras campañas en X, el objetivo VIDEO_VIEWS_PREROLL no utiliza Tweets promocionados ni Cards. En su lugar, el creativo de video se asocia con tu grupo de anuncios (line item) y la información del CTA se asocia con 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"
   }
 }
}

Establecer criterios de segmentación

El criterio de segmentación utilizado para los 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. Use CONTENT_PUBLISHER_USER como segmentación negada para evitar que el anuncio se asocie con un conjunto de usuarios. Proporcione el user_id de X o el publisher_user_id de los handles que desea excluir. El endpoint GET publishers se puede usar para recuperar la lista de user_id que se excluirán para Content Categories. El publisher_user_id devuelto en la respuesta de GET curated_categories se puede usar para recuperar una lista de exclusión similar para Curated Categories. Nota: Se puede excluir un máximo de 5 publisher_user_id para Curated Categories y 50 user_id para Content Categories.

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é listo para lanzar la campaña, simplemente quítela de pausa 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

Las analíticas de las campañas VIDEO_VIEWS_PREROLL están disponibles a través de nuestros endpoints de estadísticas.

Segmentación por palabras clave en las líneas de tiempo

La segmentación por palabras clave es fundamental para nuestros productos de Promoted Tweets, ya que brinda a las campañas un mayor alcance. La segmentación por palabras clave en la línea de tiempo permite a las plataformas orientar anuncios a usuarios de X en función de las palabras clave presentes en sus Tweets recientes. Por ejemplo, si un anunciante está segmentando la combinación no ordenada de palabras clave “plan + trip”, y un usuario publica un Tweet: “Estoy empezando a planear mi viaje a Cabo, ¿alguna recomendación?” mientras la campaña está en curso, es posible que ese usuario vea poco después el Promoted Tweet del anunciante.

¿Cómo funciona?

En resumen: desde la perspectiva de la API, este cambio es bastante sencillo: ahora puedes orientar por palabras clave en Tweets promocionados en Timeline. Solo establece targeting_type en unordered_keywords o phrase_keywords para los line items.

Guía de inicio rápido

Crea un nuevo ítem de línea con la ubicación configurada para incluir ALL_ON_TWITTER o TWITTER_TIMELINE POST accounts/:account_id/line_items
Crea los criterios de segmentación para este nuevo ítem de línea con BROAD_KEYWORD y define tus palabras clave. POST accounts/:account_id/targeting_criteria
Puedes actualizar las palabras clave con PUT accounts/:account_id/targeting_criteria
Una vez que tu campaña esté en ejecución, obtén las estadísticas de tu ítem de línea para evaluar el rendimiento. GET stats/accounts/:account_id

Referencia de API

Cuentas

GET accounts

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

Nombre	Descripción
account_ids opcional	Limita la respuesta a los id de cuenta deseados especificando una lista de identificadores separados por comas. Tipo: string Ejemplo: `18ce54d4x5t`
count opcional	Especifica la cantidad de registros a intentar recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la página siguiente de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
q opcional	Consulta opcional para acotar el recurso por `name`. Nota: Realiza coincidencia de prefijo sin distinción de mayúsculas/minúsculas. Tipo: string Longitud mín., máx.: `1`, `255`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye los resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de uso más bajos, actualmente de 200 por cada 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud

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

Recupera una cuenta específica a la que el usuario autenticado tiene acceso. URL del recurso https://ads-api.x.com/12/accounts/:account_id Parámetros

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t Respuesta de ejemplo

       {
         "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 de 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": "Cuenta de prueba",
             "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

Nombre	Descripción
account_id required	Identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
name optional	Nombre de la cuenta. Tipo: string Ejemplo: `API McTestface`
industry_type optional	Industria con la que está asociada 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 SANDBOX Elimina una cuenta de anuncios en el entorno de sandbox. Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id Parameters

Name	Description
account_id required	El identificador de la cuenta usada. 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`

Example Request DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh Example Response

       {
         "data": {
           "name": "Cuenta de prueba",
           "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 los detalles de todas las apps móviles asociadas a la cuenta de anuncios especificada. Resource URL https://ads-api.x.com/12/accounts/:account_id/account_apps Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
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 más información. Type: string Example: `8x7v00oow`
sort_by optional	Ordena por un atributo compatible 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 la solicitud. Type: boolean Default: `false` Possible values: `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 incluyen `total_count` tendrán límites de frecuencia 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/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

Obtiene un resumen de los cambios realizados en el entity_id especificado en la solicitud. Nota: Este endpoint está actualmente en beta y requiere allowlisting. Resource URL https://ads-api.x.com/12/accounts/:account_id/account_history Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Type: string Example: `18ce54d4x5t`
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 siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`
entity_type required	El tipo de entidad para la que se obtendrán datos. Type: enum Example: `PROMOTED_TWEET` Possible values: `CAMPAIGN`, `LINE_ITEM`, `PROMOTED_TWEET`, `TARGETING_CRITERIA`, `PROMOTED_ACCOUNT`
entity_id required	La entidad específica para la que se obtendrán datos. Type: string Example: `8u94t`
start_time required	Limita los datos obtenidos al tiempo de inicio especificado, expresado en ISO 8601. Nota: Debe expresarse en horas exactas (0 minutos y 0 segundos). Type: string Example: `2017-05-19T07:00:00Z`
end_time required	Limita los datos obtenidos al tiempo de finalización especificado, expresado en ISO 8601. Nota: Debe expresarse en horas exactas (0 minutos y 0 segundos). Type: string Example: `2017-05-26T07:00:00Z`
user_id optional	Limita la respuesta a un usuario específico. Type: long Example: `3271358660`

Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1 Example Response

    {
      "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 comerciales de anunciantes

GET advertiser_business_categories

Solicita las categories de negocio de anunciantes válidas para los Grupos de anuncios (line_items) con el fin de describir 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 un conjunto de IAB Categories. Al crear un Grupo de anuncios con el objetivo PREROLL_VIEWS, se debe establecer una o dos advertiser_business_categories para el Grupo de anuncios. Esto puede hacerse configurando el valor del parámetro de solicitud categories en el endpoint de line item con el 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 Resource URL https://ads-api.x.com/12/advertiser_business_categories Parameters Sin parámetros de solicitud Example Request GET https://ads-api.x.com/12/advertiser_business_categories Example Response

{
      "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": "Restauración",
          "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": "Automoción",
          "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"
          ]
        }
      ]
    }

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 una matriz de objetos JSON que contienen los parámetros para los objetos de criterios de segmentación. Una lista de parámetros 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 el encabezado Content-Type: application/json. Nota: Es obligatorio especificar al menos un criterio de segmentación principal; puedes consultar la lista de todos los criterios de segmentación principales en nuestra página de segmentación de campañas. Resource URL https://ads-api.x.com/12/accounts/:account_id/audience_estimate Parameters

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
targeting_criteria obligatorio	Objeto JSON que contiene todos los parámetros para los objetos de criterios de segmentación. Una lista de parámetros de segmentación obligatorios y opcionales está disponible en el endpoint POST accounts/:account_id/targeting_criteria.
operator_type opcional	Especifica la relación que debe tener el criterio de segmentación. Por ejemplo, para aplicar una exclusión, usa `operator_type=NE`. Tipo: enum Valores posibles: `EQ`, `NE` Predeterminado: `EQ`

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

Respuesta de ejemplo

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

Obtiene los permisos del usuario actualmente autenticado (access_token) en relación con la cuenta de anuncios especificada. Estos permisos coinciden con los que se muestran en ads.x.com. Los valores posibles incluyen:

ACCOUNT_ADMIN: Acceso completo para modificar campañas y ver estadísticas, incluida la capacidad de añadir o eliminar usuarios y cambiar la configuración
AD_MANAGER: Acceso completo para modificar campañas y ver estadísticas, pero no puede añadir o eliminar usuarios ni cambiar la configuración
CREATIVE_MANAGER: Acceso para modificar recursos creativos 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ítica orgánica e insights de audiencia, pero sin acceso para crear, modificar o ver campañas
PARTNER_AUDIENCE_MANAGER: Acceso solo mediante API para ver y modificar audiencias de socios de datos, pero sin acceso a campañas, recursos creativos u otros tipos de audiencias.

Además, el permiso TWEET_COMPOSER indica que el usuario autenticado puede crear Tweets nullcasted (o “Promoted-only”) en nombre del anunciante. Esto solo está disponible para usuarios con acceso ACCOUNT_ADMIN, AD_MANAGER o CREATIVE_MANAGER. Resource URL https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access Parameters None Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access Example Response

    {
      "data": {
        "user_id": "2417045708",
        "permissions": [
          "ACCOUNT_ADMIN",
          "TWEET_COMPOSER"
        ]
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      }
    }

Reglas de puja

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

Name	Description
currency optional	Tipo de divisa por la que filtrar los resultados, identificado mediante ISO-4217. Es una cadena de tres letras como “USD” o “EUR”. Omite este parámetro para recuperar todas las reglas de puja. Type: string Example: `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

Obtén detalles de algunas o todas las campañas asociadas a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/campaigns Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
campaign_ids opcional	Limita la respuesta a las campañas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id. Tipo: string Ejemplo: `8wku2`
count opcional	Especifica la cantidad de registros que se intentarán recuperar por solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
funding_instrument_ids opcional	Limita la respuesta a las campañas bajo instrumentos de financiación específicos especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 id. Tipo: string Ejemplo: `lygyi`
q opcional	Una consulta opcional para limitar el recurso por `name`. Tipo: string Longitud mín., máx.: `1`, `255`
sort_by opcional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_draft opcional	Incluye resultados de campañas en borrador en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyen `total_count` tendrán límites de frecuencia más bajos, actualmente establecidos en 200 por 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2 Respuesta de ejemplo

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

Recupera una campaña específica asociada a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parámetros

Name	Description
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 al usuario autenticado. Type: string Example: `18ce54d4x5t`
campaign_id required	Referencia a la campaña con la que se opera en la solicitud. Type: string Example: `8wku2`
with_deleted optional	Incluir resultados eliminados en la solicitud. Type: boolean Default: `false` Possible values: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2 Respuesta de ejemplo

    {
      "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 campaña nueva asociada con la cuenta actual. Nota: Existe un límite predeterminado de 200 campañas activas por cuenta. Sin embargo, no hay límite para la cantidad de campañas inactivas. Este límite se puede aumentar hasta 8,000 campañas activas. Para habilitar el límite superior, el anunciante debe solicitarlo a su X Account Manager. Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns Parameters

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
funding_instrument_id required	El identificador del instrumento de financiación bajo el cual se creará la campaña. Tipo: string Ejemplo: `lygyi`
name required	El nombre de la campaña. Longitud máxima: 255 caracteres. Tipo: string Ejemplo: `demo`
budget_optimization optional	Selecciona el tipo de optimización de presupuesto que se aplicará. Tipo: enum Predeterminado: `CAMPAIGN` Valores posibles: `CAMPAIGN`, `LINE_ITEM`
daily_budget_amount_local_micro sometimes required	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. Nota: Debe ser menor o igual que `total_budget_amount_local_micro` y es obligatorio para la mayoría de los tipos de Funding Instrument. Tipo: long Ejemplo: `5500000`
entity_status optional	El estado de la campaña. Tipo: enum Predeterminado: `ACTIVE` Valores posibles: `ACTIVE`, `DRAFT`, `PAUSED`
purchase_order_number optional	El número de referencia de la orden de compra. Usa este campo para facilitar la conciliación de facturas. Longitud máxima: 50 caracteres. Tipo: string Ejemplo: `D00805843`
standard_delivery optional	Habilita la entrega estándar o acelerada. Consulta Budget Pacing para obtener más información sobre entrega estándar versus acelerada. Solo disponible cuando `budget_optimization` está establecido en `CAMPAIGN`. Tipo: boolean Predeterminado: `true` Valores posibles: `true`, `false`
total_budget_amount_local_micro optional	El monto total del 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. Tipo: long Ejemplo: `37500000`

Example Request

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

Example Response

    {
      "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 crear nuevas campañas por lotes con una sola solicitud. Solicitudes por lotes

El tamaño máximo de lote actual es 40.
Todos los parámetros se envían en el cuerpo de la solicitud y se requiere Content-Type: application/json.
Las solicitudes por lotes fallan o se completan correctamente en conjunto, 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, su estructura es idéntica a la de sus endpoints correspondientes de un solo elemento. Errores por lotes

Los errores a nivel de solicitud (p. ej., exceder el tamaño máximo del lote) se muestran en la respuesta bajo el objeto errors.
Los errores a nivel de elemento (p. ej., falta de un parámetro obligatorio de campaña) 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

Nombre	Descripción
operation_type obligatorio	Tipo de operación por elemento que se está realizando. Tipo: enum Valores posibles: `Create`, `Delete`, `Update`
params obligatorio	Objeto JSON que contiene todos los parámetros de los objetos de campaña. Para ver la 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":"campañas por lotes",
          "funding_instrument_id":"lygyi",
          "daily_budget_amount_local_micro":140000000,
          "entity_status":"PAUSED",
          "budget_optimization":"CAMPAIGN"
        }
      }
    ]

Respuesta de ejemplo

    {
      "data": [
        {
          "name": "campañas en lote",
          "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": "campañas en lote",
            "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 a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
campaign_id required	Referencia a la campaña con la que se opera 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 importe de presupuesto diario que se asignará a la campaña. Se usará la divisa asociada al instrumento de financiación especificado. Para USD, 5,50 $ se representa como 5500000. Cuando no se proporciona, la campaña gastará de manera uniforme según el presupuesto total y durante la duración del periodo de la campaña. Note: 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 orden de compra. 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 disponible cuando `budget_optimization` está configurado 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 usará la divisa asociada al instrumento de financiación especificado. Para USD, 37,50 $ 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 perteneciente a la cuenta actual. Nota: La eliminación de una campaña es irreversible y los intentos posteriores de eliminar el recurso devolverán HTTP 404. Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters

Name	Description
account_id required	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
campaign_id required	Referencia a la campaña con la que se opera en la solicitud. Tipo: string Ejemplo: `8yn7m`

Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m Example Response

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

Solicite las categories de contenido válidas para configurarlas como targeting_criteria de un elemento de línea. Cada content_category se asigna a una o más IAB Categories. 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 devuelto por la solicitud content_categories. De no hacerlo, se producirá un error de validación. Los detalles del publisher de cada una de estas categorías de contenido se pueden obtener mediante el endpoint GET publishers. Puede encontrar más información en la Guía del objetivo de Video Views Pre-roll. Resource URL https://ads-api.x.com/12/content_categories Parameters No hay parámetros de solicitud Example Request GET https://ads-api.x.com/12/content_categories Example Response

{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Automotriz (Autos, Camionetas, Carreras)",
          "id": "ru",
          "iab_categories": [
            "IAB2"
          ],
          "publishers_in_last_thirty_days": 12,
          "videos_monetized_in_last_thirty_days": 316
        },
        {
          "name": "Comedia",
          "id": "sk",
          "iab_categories": [
            "IAB1-4"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 174
        },
        {
          "name": "Creadores Digitales",
          "id": "sl",
          "iab_categories": [
            "IAB25-1"
          ],
          "publishers_in_last_thirty_days": 110,
          "videos_monetized_in_last_thirty_days": 1257
        },
        {
          "name": "Entretenimiento y Cultura Pop",
          "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": "Noticias Financieras y Empresariales",
          "id": "sn",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ],
          "publishers_in_last_thirty_days": 29,
          "videos_monetized_in_last_thirty_days": 1461
        },
        {
          "name": "Comida y Bebidas",
          "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": "Música",
          "id": "sq",
          "iab_categories": [
            "IAB1-6"
          ],
          "publishers_in_last_thirty_days": 31,
          "videos_monetized_in_last_thirty_days": 518
        },
        {
          "name": "Noticias y Actualidad",
          "id": "sr",
          "iab_categories": [
            "IAB12",
            "IAB14"
          ],
          "publishers_in_last_thirty_days": 125,
          "videos_monetized_in_last_thirty_days": 5507
        },
        {
          "name": "Política",
          "id": "s4",
          "iab_categories": [
            "IAB11"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 1402
        },
        {
          "name": "Ciencia y Educación",
          "id": "ss",
          "iab_categories": [
            "IAB5",
            "IAB15"
          ],
          "publishers_in_last_thirty_days": 7,
          "videos_monetized_in_last_thirty_days": 132
        },
        {
          "name": "Deportes",
          "id": "se",
          "iab_categories": [
            "IAB17"
          ],
          "publishers_in_last_thirty_days": 403,
          "videos_monetized_in_last_thirty_days": 18281
        },
        {
          "name": "Tecnología",
          "id": "sg",
          "iab_categories": [
            "IAB19"
          ],
          "publishers_in_last_thirty_days": 13,
          "videos_monetized_in_last_thirty_days": 1089
        },
        {
          "name": "Televisión",
          "id": "sh",
          "iab_categories": [
            "IAB1-7"
          ],
          "publishers_in_last_thirty_days": 58,
          "videos_monetized_in_last_thirty_days": 1307
        },
        {
          "name": "Deportes Electrónicos y Videojuegos",
          "id": "s0",
          "iab_categories": [
            "IAB9-30"
          ],
          "publishers_in_last_thirty_days": 109,
          "videos_monetized_in_last_thirty_days": 1844
        }
      ],
      "total_count": 15
    }

Categorías curadas

GET accounts/:account_id/curated_categories

Obtén 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 pre-roll de vistas de video. Resource URL https://ads-api.x.com/12/accounts/:account_id/curated_categories Parameters

Name	Description
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 al usuario autenticado. Type: string Example: `18ce54d4x5t`
country_codes required	Limita la respuesta 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 ids. Type: string Example: `US`
cursor optional	Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`

Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US Example Response

{
      "request": {
        "params": {
          "country_codes": [
            "US"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Baloncesto",
          "description": "Muestra anuncios junto al mejor contenido diario de baloncesto, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten videos de baloncesto en temporada y fuera de ella.",
          "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": "Muestra anuncios junto al mejor contenido diario de gaming exclusivamente de una lista de algunos de los creadores digitales más grandes y populares 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": "Muestra anuncios junto al mejor contenido diario de béisbol, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten cobertura destacada 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": "Muestra anuncios 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 en temporada y fuera de ella.",
          "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": "Cultura y estilo de vida masculino",
          "description": "Muestra tu anuncio junto a contenido de cuentas seleccionadas según los perfiles de sus seguidores para ayudarte a alcanzar una audiencia mayoritariamente masculina, incluyendo algunas de las principales cuentas que comparten contenido de tecnología, noticias y estilo de vida.",
          "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": "Cultura y estilo de vida femenino",
          "description": "Muestra tu anuncio junto a contenido de cuentas seleccionadas según los perfiles de sus seguidores para ayudarte a alcanzar una audiencia mayoritariamente femenina, incluyendo algunas de las principales cuentas que comparten contenido de cultura pop, noticias y estilo de vida.",
          "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": "Contenido alegre",
          "description": "Muestra tu anuncio junto a una lista de cuentas seleccionadas por el volumen de contenido positivo y optimista, y las conversaciones que han generado de manera consistente en 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": "Fútbol",
          "description": "Muestra tu anuncio junto al mejor contenido diario de fútbol, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten cobertura destacada de fútbol.",
          "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. Resource URL https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
curated_category_id required	Una referencia a la categoría seleccionada (Curated Category) con la que se opera en la solicitud. Tipo: string Ejemplo: `9ddrgesiap6o`

Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o Example Response

    {
      "request": {
        "params": {
          "id": "9ddrgesiap6o",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "Fútbol",
        "description": "Publica junto al mejor contenido diario de fútbol, incluyendo equipos universitarios, equipos profesionales y las principales cuentas de medios deportivos que comparten la cobertura más importante de fútbol.",
        "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
      }
    }

Funcionalidades

GET accounts/:account_id/features

Obtiene la colección de funcionalidades otorgadas a las que esta cuenta de anuncios puede acceder. Las funcionalidades se indican mediante una clave descriptiva y solo se exponen en este endpoint si se introducen en beta o en un lanzamiento limitado y están disponibles en la Ads API. Las funcionalidades que no cumplan este criterio 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 lanzamientos beta. Los desarrolladores de la API no pueden solicitar acceso a funcionalidades en nombre de un anunciante. Estas solicitudes solo pueden ser realizadas por el anunciante a su gestor de cuenta de X. Resource URL https://ads-api.x.com/12/accounts/:account_id/features Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
feature_keys optional	Parámetro opcional que permite consultar una clave de funcionalidad específica. Las solicitudes pueden incluir varias claves separadas por comas. Note: Solo se incluirán en la respuesta las funcionalidades a las que esta cuenta tenga acceso. Type: enum Possible values: `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ñade una característica a una cuenta de sandbox. La lista actualizada de características de la cuenta se puede obtener mediante el endpoint GET accounts/:account_id/features. Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parameters

Name	Description
account_id required	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `gq180y`
feature_keys required	Una lista separada por comas de características de cuenta para añadir a la cuenta. Type: enum Possible values: `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`

Example Request POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING Example Response

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

SANDBOX SOLO Quita una función de una cuenta de sandbox. La lista actualizada de funciones de la cuenta puede obtenerse mediante el endpoint GET accounts/:account_id/features. URL del recurso https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parámetros

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `gq180y`
feature_keys obligatorio	Lista separada por comas de funciones de cuenta que se quitará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 detalles de algunos o de todos los instrumentos de financiación asociados a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments Parameters

Name	Description
account_id required	Identificador de la cuenta. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
count optional	Especifica la cantidad de registros a 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 más información. Type: string Example: `8x7v00oow`
funding_instrument_ids optional	Limita la respuesta a los instrumentos de financiación deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `lygyi`
sort_by optional	Ordena por un atributo compatible 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 la solicitud. Type: boolean Default: `false` Possible values: `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 frecuencia 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/funding_instruments Example Response

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "start_time": "2016-07-22T04:24:04Z",
          "description": "Visa que termina 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 a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta con financiación. 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`
funding_instrument_id obligatorio	Referencia al instrumento de financiación con el que se opera en la solicitud. Tipo: string Ejemplo: `lygyi`
with_deleted opcional	Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi Respuesta de ejemplo

    {
      "request": {
        "params": {
          "funding_instrument_id": "lygyi",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "start_time": "2016-07-22T04:24:04Z",
        "description": "Visa que termina 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
      }
    }

POST accounts/:account_id/funding_instruments

SOLO SANDBOX Cree un instrumento de financiación en el entorno de sandbox. No hay riesgo de incurrir en costes al usar un instrumento de financiación en sandbox. Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments Parameters

Name	Description
account_id required	El identificador de la cuenta con apalancamiento. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `gq1844`
currency required	La divisa, expresada según ISO-4217. Type: string Example: `USD`
start_time required	La fecha en que el instrumento de financiación pasa a estar activo y disponible, expresada según ISO 8601. Type: string Example: `2017-05-19T07:00:00Z`
type required	El tipo de instrumento de financiación que se creará. Type: enum Possible values: `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 según ISO 8601. Type: string Example: `2017-05-26T07:00:00Z`
credit_limit_local_micro optional	El crédito total disponible para este instrumento de financiación. Note: Solo aplicable a algunos tipos de instrumentos de financiación. Type: long Example: `37500000`
funded_amount_local_micro optional	El importe total del presupuesto asignado a este instrumento de financiación. Note: Solo aplicable a algunos tipos de instrumentos de financiación. Type: long Example: `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": "(todavía 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 de sandbox. URL del recurso https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id Parámetros

Name	Description
account_id obligatorio	El identificador de la cuenta apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `gq1844`
funding_instrument_id obligatorio	Referencia al instrumento de financiación con el que se opera 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 válidas de la App para grupos de anuncios (line_items). URL del recurso https://ads-api.x.com/12/iab_categories Parámetros

Nombre	Descripción
count opcional	Especifica la cantidad de registros a intentar recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de categorías. Consulta Paginación para más información. Tipo: string Ejemplo: `gc-ddf4a`
with_total_count opcional	Incluye el atributo `total_count` en la respuesta. Nota: Este parámetro y `cursor` son mutuamente excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/iab_categories?count=2 Respuesta de ejemplo

    {
      "data": [
        {
          "id": "IAB1",
          "parent_id": null,
          "name": "Arte y entretenimiento"
        },
        {
          "id": "IAB1-1",
          "parent_id": "IAB1",
          "name": "Libros y literatura"
        }
      ],
      "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 elementos de línea asociados a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
campaign_ids optional	Limita la respuesta a los elementos de línea de campañas específicas indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `8gdx6`
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 siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`
funding_instrument_ids optional	Limita la respuesta a los elementos de línea de instrumentos de financiación específicos indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `lygyi`
line_item_ids optional	Limita la respuesta a los elementos de línea deseados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `8v7jo`
q optional	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 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 frecuencia 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/line_items?line_item_ids=itttx Example Response

    {
      "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 a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_id obligatorio	Referencia al elemento de línea con el que opera la solicitud. Tipo: string Ejemplo: `8v7jo`
with_deleted opcional	Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx Ejemplo de respuesta

    {
      "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 que pertenece a la cuenta actual. Todos los elementos de línea de una campaña deben tener el mismo product_type y objective. Al usar 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. Configurar android_app_store_identifier o ios_app_store_identifier añadirá automáticamente los criterios de segmentación del elemento de línea que coincidan con la app móvil que se está promocionando; por ejemplo, pasar ios_app_store_identifier añadiría criterios de segmentación de PLATFORM 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. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items Parameters Targeting options

Nombre	Descripción
cuenta_id obligatorio	El identificador de la cuenta con apalancamiento. Aparece dentro del recurso’forma parte de la ruta y, por lo general, es un parámetro obligatorio para todas las solicitudes de la API de Anunciantes, exceptoGET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: cadena Ejemplo:`18ce54d4x5t`
campaña_id requerido	El identificador de la campaña en la que se creará el ítem de línea. Tipo: cadena Ejemplo:`8slvg`
fin_hora requerido	La hora, expresada enISO 8601 (Original), que la partida dejará de entregarse. Tipo: string Ejemplo:`2017-10-05T00:00:00Z`
objetivo requerido	El objetivo de la campaña para este ítem de línea. Tipo: enumeración Valores posibles:`APP_ENGAGEMENTS`,`APP_INSTALLS`,`ALCANCE`,`SEGUIDORES`,`INTERACCIONES`,`VIDEO_VIEWS`,`PREROLL_VIEWS`,`WEBSITE_CLICKS`
ubicaciones de anuncios obligatorio	Las ubicaciones de colocación donde se mostrará este elemento de línea. Especifique una lista de valores de colocación separados por comas. Tipo: enumeración 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`
producto_tipo obligatorio	El tipo de producto promocionado que contendrá este artículo de línea. Tipo: enumeración Valores posibles:`MEDIOS`,`PROMOTED_ACCOUNT`,`PROMOTED_TWEETS`
comenzar_tiempo obligatorio	La hora, expresada enISO 8601 (Versión en español), que la partida comenzará a entregarse. Tipo: cadena Ejemplo:`2017-07-05T00:00:00Z`
anunciante_dominio a veces requerido	El dominio del sitio web de este anunciante, sin el prefijo del protocolo. Nota: Obligatorio cuando el elemento de línea’la colocación de s está configurada en`PUBLISHER_NETWORK`. Tipo: cadena Ejemplo:`x.com`
Android_App_almacenar_identificador a veces obligatorio	El identificador de la Google Play Store para las aplicaciones promocionadas. Nota:`APP_INSTALLS`y`APP_ENGAGEMENTS`los objetivos requieren configurar al menos un identificador de tienda de aplicaciones — ya sea`android_app_store_identifier`o`ios_app_store_identifier`. Tipo: cadena Ejemplo:`com.twitter.android`
oferta_importe_local_micro a veces requerido	El importe de la puja que se asociará a este elemento de línea. Se usará la moneda asociada al instrumento de financiación especificado. Para USD, 5,50 $ se representa como 5500000. Nota: Obligatorio si`bid_strategy`se establece en uno de`MAX`o`DESTINO` Nota: Solo se aceptan valores mayores que cero. Tipo: long Ejemplo:`5500000`
categorías a veces obligatorio	Las categorías de IAB relevantes para este anunciante. ConsulteGET iab_categories. Nota: Obligatorio cuando el elemento de línea’la ubicación de su colocación está configurada en`PUBLISHER_NETWORK`. Tipo: cadena Ejemplo:`IAB3-1`
iOS_App_almacenar_identificador a veces requerido	La parte numérica del identificador de la App Store de Apple para aplicaciones promocionadas. Nota:`APP_INSTALLS`y`APP_ENGAGEMENTS`Los objetivos requieren configurar al menos un identificador de tienda de apps, ya sea`android_app_store_identifier`o`ios_app_store_identifier`. Tipo: cadena Ejemplo:`333903271`
principal_web_evento_tag a veces requerido	El identificador de la etiqueta web de evento principal. Permite un seguimiento más preciso de las interacciones de la campaña asociada a este artículo de línea. Nota: Obligatorio cuando el concepto de línea’el objetivo está establecido en`CONVERSIONES_DEL_SITIO_WEB`. Tipo: cadena Ejemplo:`nvo4z`
anunciante_usuario_id opcional	El identificador de usuario de X del handle que promociona un anuncio `PREROLL_VIEWS`. Solo ciertas aplicaciones cliente pueden usar este parámetro.`PREROLL_VIEWS`anuncio. Solo determinadas aplicaciones cliente pueden usar este parámetro. Tipo: cadena Ejemplo:`312226591`
audiencia_expansión opcional	Se utiliza para ampliar el alcance de las campañas dirigiéndose a usuarios similares a aquellos ya seleccionados. Nota: De forma predeterminada, no se aplicará ninguna expansión. Tipo: enumeración Valores posibles:`AMPLIO`,`DEFINIDO`,`AMPLIADA`
puja_estrategia opcional	El mecanismo de licitación. `AUTO`optimiza automáticamente las pujas en función del presupuesto diario y las fechas de la campaña. `MAX`define la puja máxima permitida ynodisponible cuando el objetivo se establece en`ALCANCE`o`SEGUIDORES`. `TARGET`intenta mantener los promedios diarios de puja dentro del 20 % de lo especificado`bid_amount_local_micro`y está disponible cuando el objetivo se configura en`ALCANCE`,`Seguidores`, O`CLICS_EN_EL_SITIO_WEB`. Nota: Si se configura en`AUTO`,`bid_amount_local_micro`se ignorará. Nota: Predeterminado según el objetivo. Tipo: enumeración Valores posibles:`AUTO`,`MAX`,`DESTINO`
duración_en_días opcional	El período durante el cual se alcanza el `frequency_cap`.`frequency_cap`se consigue. Tipo: int Valores posibles:`1`,`7`,`30`
entidad_estado opcional	El estado del artículo de pedido. Tipo: enumeración Predeterminado:`ACTIVO` Valores posibles:`ACTIVO`,`VERSIÓN PRELIMINAR`,`EN PAUSA`
frecuencia_límite opcional	La cantidad máxima de veces que un anuncio puede mostrarse a un usuario. Nota: Solo se admite para`ALCANCE`,`INTERACCIONES`,`VIDEO_VIEWS`, y`PREROLL_VIEWS`objetivos. Tipo: int Ejemplo:`5`
meta opcional	La configuración de optimización que se usará con este concepto de línea. El`APP_PURCHASES`la opción está disponible para`APP_INSTALL`. El`APP_CLICKS`y`APP_INSTALLS`hay opciones disponibles para ambos`APP_INSTALL`y`APP_ENGAGEMENTS`objetivos y puede requerir usar unsocio de MACT. El`VISITAS_AL_SITIO`la opción solo está disponible con la`WEBSITE_CLICKS`objetivo. Nota: Predeterminado según el objetivo. Tipo: enumeración Valores posibles:`APP_CLICKS`,`APP_INSTALLS`,`APP_PURCHASES`,`INTERACCIONES`,`SEGUIDORES`,`CLICS_ENLACE`,`MAX_REACH`,`PREROLL`,`PREROLL_STARTS`,`ALCANCE_CON_INTERACCIONES`,`VISITAS_AL_SITIO`,`VIDEO_VIEW`,`VIEW_3S_100PCT`,`VIEW_6S`,`VIEW_15S`,`CONVERSIONES_DEL_SITIO_WEB`
nombre opcional	El nombre del artículo de línea. Tipo: cadena Ejemplo:`demo` Longitud mín., máx.:`1`,`255`
pagar_por opcional	La unidad con la que se cobrará este concepto de línea. Esta configuración solo puede modificarse para conceptos de línea que utilicen la`INSTALACIONES_DE_APP`objetivo. Nota: Predeterminado`pagar_antes_de`se configura automáticamente según el objetivo de la campaña y el ítem de línea’unidad de puja de s. El`APP_INSTALLS`el objetivo admite ambos`APP_CLICK`y`IMPRESIÓN`valores.`IMPRESIÓN`es el valor predeterminado. El`CLICS_ENLACE`El objetivo admite ambos.`CLIC_EN_ENLACE`y`IMPRESSION`valores.`IMPRESSION`es el valor predeterminado, pero no se admite al configurar`TARGET`para`bid_strategy`. El`VISITAS_AL_SITIO`compatibilidades del objetivo`IMPRESSION`valores. Tipo: enumeración Valores posibles:`APP_CLICK`,`IMPRESSION`,`CLIC_EN_ENLACE`
estándar_entrega opcional	Activa la distribución estándar o acelerada. ConsultaRitmo de gasto del presupuestopara obtener más información sobre la entrega estándar frente a la acelerada. Disponible solo cuando`optimizacion_presupuesto`está configurado en`LINE_ITEM`para la campaña padre Tipo: booleano Predeterminado:`true` Posibles valores:`true`,`false`
total_presupuesto_importe_local_micro opcional	El importe total del presupuesto que se asignará a la partida. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, 37,50 $ se representa como 37500000. Tipo: long Ejemplo:`37500000`
diario_presupuesto_importe_local_micro a veces requerido	El importe del presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiamiento especificado. Para USD, $5.50 se representa como 5500000. Cuando no se proporcione, la campaña gastará de manera uniforme según el presupuesto total y durante el tiempo de ejecución de la campaña. Solo disponible cuando`budget_optimization`está establecido en`LINE_ITEM`para la campaña padre Nota: Esto debe ser menor o igual que`total_budget_amount_local_micro`. Tipo: long Ejemplo:`5.500.000`

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 crear por lotes 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 fallan o se realizan correctamente juntas como un grupo y todas las respuestas de la API, tanto de error como de éxito, conservan 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 (p. ej., se excedió el tamaño máximo del lote) se muestran en la respuesta bajo el objeto errors.
Los errores a nivel de elemento (p. ej., falta un parámetro obligatorio del line item) se muestran en la respuesta bajo el objeto operation_errors.

URL del recurso https://ads-api.x.com/12/batch/accounts/:account_id/line_items Parámetros

Nombre	Descripción
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 line item. Para ver la lista de parámetros obligatorios y opcionales de line item, consulta aquí.

Ejemplo de solicitud 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 la partida especificada asociada con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parámetros

Nombre	Descripción
cuenta_id obligatorio	El identificador de la cuenta con apalancamiento. Aparece dentro del recurso’s path y, por lo general, es un parámetro obligatorio para todas las solicitudes de la API de Anunciantes, exceptoGET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: cadena Ejemplo:`18ce54d4x5t`
línea_elemento_id obligatorio	Una referencia al elemento de línea con el que opera en la solicitud. Tipo: cadena Ejemplo:`8v7jo`
anunciante_dominio opcional	El dominio del sitio web de este anunciante, sin el protocolo. Nota: Obligatorio cuando el elemento de línea’la ubicación de s está configurada en`PUBLISHER_NETWORK`. Tipo: cadena Ejemplo:`x.com`
anunciante_usuario_id opcional	El identificador de usuario de Twitter del handle que promociona un anuncio de `PREROLL_VIEWS`. Solo ciertas aplicaciones cliente pueden usar este parámetro.`PREROLL_VIEWS`Anuncio de PREROLL_VIEWS. Solo ciertas aplicaciones cliente pueden usar este parámetro. Tipo: cadena Ejemplo:`312226591`
Android_App_almacenar_identificador opcional	El identificador de Google Play de la aplicación promocionada. Nota:`APP_INSTALLS`y`APP_ENGAGEMENTS`los objetivos requieren configurar al menos un identificador de tienda de apps, ya sea`android_app_store_identifier`o`ios_app_store_identifier`. Tipo: cadena Ejemplo:`com.twitter.android`
audiencia_expansión opcional	Se usa para ampliar el alcance de las campañas al segmentar a usuarios similares a los ya segmentados. Tipo: enumeración Valores posibles:`AMPLIA`,`DEFINED`,`AMPLIADO`
oferta_importe_local_micro opcional	El importe de la puja que se asociará con este elemento de línea. Se usará la moneda asociada al instrumento de financiación especificado. En USD, 5,50 $ se representa como 5500000. Nota: Obligatorio si`bid_strategy`se establece en uno de`MAX`o`DESTINO` Nota: Solo se aceptan valores mayores que cero. Tipo: long Ejemplo:`140.000`
oferta_estrategia opcional	El mecanismo de licitación. `AUTO`optimiza automáticamente las pujas según el presupuesto diario y las fechas de la campaña. `MAX`define la puja máxima permitida ynodisponible cuando el objetivo está configurado en`ALCANCE`o`SEGUIDORES`. `DESTINO`intenta que los promedios diarios de puja se mantengan dentro del 20% de lo especificado`bid_amount_local_micro`y está disponible cuando el objetivo se configura en`Alcance`o`WEBSITE_CLICKS`. Nota: Si se configura en`AUTO`,`bid_amount_local_micro`se ignorará. Nota: Valor predeterminado según el objetivo. Tipo: enumeración Valores posibles:`AUTO`,`MAX`,`DESTINO`
categorías opcional	Las categorías de la IAB relevantes para este anunciante. ConsulteGET iab_categories. Nota: Obligatorio cuando el elemento de línea’La ubicación de s está configurada en`PUBLISHER_NETWORK`. Tipo: cadena Ejemplo:`IAB3-1`
duración_en_días opcional	El plazo dentro del cual`frequency_cap`se logra. Tipo: int Valores posibles:`1`,`7`,`30`
entidad_estado opcional	El estado del ítem de línea. Tipo: enumeración Valores posibles:`ACTIVO`,`EN PAUSA`
final_tiempo opcional	La hora, expresada enISO 8601, que el elemento de pedido dejará de entregarse. Tipo: cadena Ejemplo:`2017-10-05T00:00:00Z`
frecuencia_tope opcional	El número máximo de veces que un anuncio puede mostrarse a un usuario. Nota: Solo se admite para`ALCANCE`,`INTERACCIONES`,`VIDEO_VIEWS`, y`PREROLL_VIEWS`objetivos. Tipo: int Ejemplo:`5`
objetivo opcional	La configuración de optimización que se debe usar con este elemento de línea. La`APP_PURCHASES`la opción está disponible para`APP_INSTALL`. El`APP_CLICKS`y`INSTALACIONES_DE_APP`hay opciones disponibles para`APP_INSTALL`y`APP_ENGAGEMENTS`y puede requerir usar unpartner de MACT. Nota: Predeterminado según el objetivo. Tipo: enumeración Posibles valores:`APP_CLICKS`,`APP_INSTALLS`,`APP_PURCHASES`,`ENGAGEMENT`,`SEGUIDORES`,`CLICS_EN_ENLACE`,`MAX_REACH`,`PREROLL`,`PREROLL_STARTS`,`REACH_WITH_ENGAGEMENT`,`VIDEO_VIEW`,`VIEW_3S_100PCT`,`VIEW_6S`,`VIEW_15S`,`WEBSITE_CONVERSIONS`
iOS_App_almacenar_identificador opcional	La parte numérica del identificador de la App Store de Apple para las aplicaciones promocionadas. Nota:`APP_INSTALLS`y`APP_ENGAGEMENTS`Los objetivos requieren configurar al menos un identificador de tienda de apps, ya sea`android_app_store_identifier`o`ios_app_store_identifier`. Tipo: cadena Ejemplo:`333903271`
nombre opcional	El nombre del ítem de línea. Tipo: cadena Ejemplo:`demo`
pago_por opcional	La unidad con la que se cobrará este elemento de línea. Esta configuración solo puede modificarse para elementos de línea que utilicen la`APP_INSTALLS`objetivo. Nota: El valor por defecto`pay_by`se configura automáticamente según el objetivo de la campaña y el line item’unidad de puja del elemento de línea. El`APP_INSTALLS`el objetivo admite ambos`APP_CLICK`y`IMPRESSION`valores.`IMPRESSION`es el valor por defecto. El`CLICS_EN_ENLACE`el objetivo admite ambos`CLICK_ENLACE`y`IMPRESSION`valores.`IMPRESSION`es el valor predeterminado, pero no se admite al configurar`DESTINO`para`bid_strategy`. El`VISITAS_AL_SITIO`el objetivo es compatible con`IMPRESIÓN`valores. Tipo: enumeración Valores posibles:`APP_CLICK`,`IMPRESSION`,`LINK_CLICK`
comenzar_tiempo opcional	La hora, expresada enISO 8601 (Original en inglés), que el elemento de línea comenzará a entregarse. Tipo: cadena Ejemplo:`2017-07-05T00:00:00Z`
total_presupuesto_importe_local_micro opcional	El monto total del presupuesto que se asignará al elemento de línea. Se usará la divisa asociada con el instrumento de financiación especificado. Para USD, $37.50 se representa como 37500000. Tipo: long Ejemplo:`37500000`
diario_presupuesto_importe_local_micro opcional	El importe del presupuesto diario que se asignará a la campaña. Se utilizará la divisa asociada al instrumento de financiación especificado. Para USD, $5.50 se representa como 5500000. Si no se proporciona, la campaña gastará de forma uniforme según el presupuesto total y la duración del período de actividad de la campaña. Disponible solo cuando`optimización_de_presupuesto`está establecido en`LINE_ITEM`para la campaña padre<br /><br />Nota: Esto debe ser menor o igual que el`total_budget_amount_local_micro`.<br /><br />Cantidad diaria de presupuesto que se asignará a la campaña. Se utilizará la moneda asociada al instrumento de financiación especificado. Para USD,$ 5.50 se representa como 5500000. Si no se especifica, la campaña gastará de forma uniforme según el presupuesto total y la duración del periodo de la campaña. Solo disponible cuando `budget_optimization` está configurado en `LINE_ITEM` para la campaña principal Nota: Debe ser menor o igual que `total_budget_amount_local_micro`. Type: long Example: `5500000` Ejemplo:`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 elemento de línea especificado de la cuenta actual. Nota: Eliminar un elemento de línea es irreversible y los intentos posteriores de eliminar el recurso devolverán HTTP 404. Nota: Cuando se elimina un elemento de línea, sus promoted_tweets descendientes 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. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_id obligatorio	Referencia al elemento de línea con el que se opera en la solicitud. Tipo: string Ejemplo: `9f2ix`

Solicitud de ejemplo DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix Respuesta de ejemplo

    {
      "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 de Line Item

Puedes encontrar más detalles de uso en la Guía del objetivo de reproducciones de video con pre‑roll

GET accounts/:account_id/line_item_curated_categories

Recupera los detalles de algunas o todas las categorías seleccionadas de partidas asociadas con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
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 más información. Type: string Example: `8x7v00oow`
sort_by optional	Ordena por un 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`. Note: Este parámetro y `cursor` son excluyentes. Note: Las solicitudes que incluyan `total_count` tendrán límites de frecuencia 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/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

Obtiene los detalles de una categoría curada de partida 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

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_curated_category_id obligatorio	Referencia a la categoría curada de la partida con la que opera en la solicitud. Tipo: string Ejemplo: `43853bhii885`
with_deleted opcional	Incluir resultados eliminados en su solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/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 categoría curada con el line item especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories Parámetros

Nombre	Descripción
account_id `required`	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
curated_category_id `required`	Referencia a la entidad de categoría curada con la que operas en la solicitud. Tipo: string Ejemplo: `10miy`
line_item_id `required`	Referencia al line item con el que operas en la solicitud. Tipo: string Ejemplo: `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 comisariada del ítem de línea especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_curated_category_id obligatorio	Referencia a la categoría comisariada del ítem de línea con la que opera en la solicitud. Tipo: string Ejemplo: `1bzq3`
curated_category_id `optional`	Referencia a la entidad de categoría comisariada con la que opera en la solicitud. Tipo: string Ejemplo: `10miy`
line_item_id `optional`	Referencia al ítem de línea con el que opera en la solicitud. Tipo: string Ejemplo: `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 curada de ítem de línea especificada. URL del recurso https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_curated_category_id obligatorio	Una referencia a la categoría curada de ítem de línea con la que opera 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

Obtén combinaciones válidas de placement y product_type. Resource URL https://ads-api.x.com/12/line_items/placements Parameters

Name	Description
product_type optional	Restringe la respuesta únicamente a las ubicaciones válidas para el tipo de producto especificado. Tipo: enum Valores posibles: `MEDIA`, `PROMOTED_ACCOUNT`, `PROMOTED_TWEETS`

Example Request GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT Example Response

    {
      "data": [
        {
          "product_type": "PROMOTED_ACCOUNT",
          "placements": [
            [
              "ALL_ON_TWITTER"
            ],
            [
              "TWITTER_TIMELINE"
            ]
          ]
        }
      ],
      "request": {
        "params": {
          "product_type": "PROMOTED_ACCOUNT"
        }
      }
    }

Creatividades de medios

GET accounts/:account_id/media_creatives

Recupera detalles de algunos o todos los media creatives asociados con la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
campaign_id optional	Limita la respuesta a los media creatives asociados con la campaña especificada. Type: string Example: `8gdx6`
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 siguiente página de resultados. Consulte Pagination para más información. Type: string Example: `8x7v00oow`
line_item_ids optional	Limita la respuesta a los media creatives asociados con los line items especificados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `8v7jo`
media_creative_ids optional	Limita la respuesta a los media creatives deseados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `1bzq3`
sort_by optional	Ordena por un atributo compatible en orden ascendente o descendente. Consulte Sorting para más información. Type: string Example: `created_at-asc`
with_deleted optional	Incluye resultados eliminados en la solicitud. Type: boolean Default: `false` Possible values: `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 frecuencia 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/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

Recupera los detalles de un media creative específico asociado a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
media_creative_id required	Una referencia al media creative con el que se está operando en la solicitud. Type: string Example: `43853bhii885`
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/media_creatives/1bzq3 Example Response

    {
      "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 de 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 la Twitter Audience Platform. Nota: Para agregar elementos multimedia al recurso Account Media, usa el endpoint POST accounts/:account_id/media_library. Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters

Nombre	Descripción
account_id `required`	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
account_media_id `required`	Una referencia a la entidad de account media con la que operas en la solicitud. Tipo: string Ejemplo: `10miy`
line_item_id `required`	Una referencia al elemento de línea con el que operas en la solicitud. Tipo: string Ejemplo: `8v7jo`
landing_url `sometimes required`	La URL del sitio web al que dirigir al usuario. Solo debe usarse con imágenes TAP (o “display creatives”). Este valor se ignorará si se usa con recursos prerroll. Para asociar una URL con un recurso prerroll, usa el endpoint POST accounts/:account_id/preroll_call_to_actions. Nota: Obligatoria cuando el objetivo del elemento de línea está configurado como `WEBSITE_CLICKS`. Tipo: string Ejemplo: `https://blog.x.com/`

Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy Example Response

    {
      "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. Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
media_creative_id required	Una referencia al media creative con el que está operando en la solicitud. Type: string Example: `1bzq3`

Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3 Example Response

    {
      "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 los detalles de algunas o todas las cuentas promocionadas asociadas con uno o más line items de la cuenta actual. Usa GET users/lookup para obtener datos de usuario de las cuentas identificadas por user_id en la respuesta. Se devolverá un HTTP 400 si ninguno de los line items especificados está configurado para incluir cuentas promocionadas. Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
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 siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`
line_item_ids optional	Limita la respuesta a las cuentas promocionadas asociadas con los line items especificados indicando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `9bpb2`
promoted_account_ids optional	Limita la respuesta a las cuentas promocionadas deseadas indicando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `19pl2`
sort_by optional	Ordena por un atributo compatible 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 incluyan `total_count` tendrán límites de frecuencia 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 a un ítem de línea dentro de la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id Parámetros

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

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 Respuesta de ejemplo

    {
      "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 promoción, se devolverá un HTTP 400 y no se promocionará a ningún usuario. Si el usuario proporcionado ya está promocionado, se ignorará la solicitud. Para obtener más información sobre Promoted Accounts, consulta nuestra página de campaign management. Nota: No es posible actualizar (PUT) las entidades de Promoted Accounts. Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
line_item_id required	Una referencia al elemento de línea con el que operas en la solicitud. Type: string Example: `9bpb2`
user_id required	Una referencia al usuario con el que operas en la solicitud. Usa GET users/lookup para recuperar un id de usuario a partir de un nombre de pantalla (screen name). Type: long Example: `756201191646691328`

Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328 Example Response

    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVO",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACEPTADO",
        "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 elemento de línea especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
promoted_account_id obligatorio	El identificador de la instancia de una Promoted Account asociada a un elemento de línea. Tipo: string Ejemplo: `19pl2`

Solicitud de ejemplo DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 Respuesta de ejemplo

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

Tweets promocionados

GET accounts/:account_id/promoted_tweets

Recupera referencias a Tweets asociados con partidas (line items) de la cuenta actual. Usa el endpoint GET accounts/:account_id/tweets para obtener los objetos Tweet. Usa los valores de tweet_id para cada objeto de promoted_tweets. Nota: Cuando se eliminan las partidas superiores (parent line items), los promoted_tweets solo se devuelven si se especifica with_deleted=true en la solicitud. No obstante, estos promoted_tweets no se eliminan realmente ("deleted": false en la respuesta). Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro requerido para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
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 siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`
line_item_ids optional	Limita la respuesta a los Tweets asociados con partidas específicas indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `96uzp`
promoted_tweet_ids optional	Limita la respuesta a los Tweets promocionados deseados indicando una lista de identificadores separados por comas. 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 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 frecuencia 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/promoted_tweets?promoted_tweet_ids=1efwlo Example Response

    {
      "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 a un ítem de línea de la cuenta actual. Nota: Cuando se eliminan los ítems de línea padre, 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). Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
promoted_tweet_id required	Referencia al Tweet promocionado con el que se opera en la solicitud. Type: string Example: `1efwlo`
with_deleted optional	Incluye resultados eliminados en la solicitud. Type: boolean Default: `false` Possible values: `true`, `false`

Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo Example Response

    {
      "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 su promoción, según el objetivo de la campaña. Consulta Campañas basadas en objetivos para obtener más información. Al usar 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 Tweets promocionados. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la API de Anunciantes, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_id obligatorio	Una referencia al elemento de línea con el que operas en la solicitud. Tipo: string Ejemplo: `8v7jo`
tweet_ids obligatorio	Una lista separada por comas de identificadores correspondientes a Tweets específicos. Se pueden proporcionar hasta 50 id. Tipo: long Ejemplo: `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

Desasocia un Tweet del elemento de línea especificado. Nota: Una entidad de promoted_tweets eliminada se mostrará como “Paused” en la interfaz de ads.x.com. Del mismo modo, al “pausar” desde la interfaz se 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

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
promoted_tweet_id required	El identificador hace referencia a la instancia de un Promoted Tweet asociada a 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 en 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 promocionables

GET accounts/:account_id/promotable_users

Recupera los detalles de algunos o todos los usuarios promocionables asociados a la cuenta actual. El tipo de usuario promocionable puede ser FULL o RETWEETS_ONLY. Esto determina el tipo de contenido que la cuenta puede promocionar. Los anunciantes deben obtener permiso para promocionar el contenido de otro usuario y contactar con X para que lo añadan a su cuenta como usuario promocionable RETWEETS_ONLY. Si los permisos están configurados correctamente, puedes realizar solicitudes a los endpoints del producto promocionado que hacen referencia directa 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 Scheduled Tweets de otra cuenta de X Ads. No es necesario que hagas retweet del Tweet objetivo. Cuando promocionas un Tweet con este enfoque, el tweet_id que se devuelve será diferente del ID del Tweet proporcionado. En segundo plano, el Tweet se retuitea como un Tweet nullcasted y luego se promociona. El tweet_id devuelto corresponde a este nuevo Tweet. Resource URL https://ads-api.x.com/12/accounts/:account_id/promotable_users Parameters

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en 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 al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la página siguiente de resultados. Consulta Pagination para más información. Tipo: string Ejemplo: `8x7v00oow`
promotable_user_ids opcional	Limita la respuesta a los usuarios promocionables deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `l310s`
sort_by opcional	Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para más información. Tipo: string Ejemplo: `created_at-asc`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyen `total_count` tendrán límites de frecuencia más bajos, actualmente establecidos en 200 por 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s Example Response

    {
      "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 puede ser FULL o RETWEETS_ONLY. Esto determina el tipo de contenido que la cuenta puede promocionar. Los anunciantes deben obtener permiso para promocionar el contenido de otro usuario. Si los permisos están configurados correctamente, puedes realizar solicitudes a los endpoints de productos promocionados que hacen referencia directamente al ID del Tweet que deseas promocionar. No es necesario retuitear el Tweet de destino. Cuando promocionas un Tweet con este enfoque, el tweet_id devuelto será diferente del ID del Tweet proporcionado. En segundo plano, el Tweet se retuitea como un Tweet nullcast y luego se promociona. El tweet_id devuelto corresponde a este nuevo Tweet. URL del recurso https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id Parámetros

Nombre	Descripción
account_id requerido	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro requerido para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
promotable_user_id opcional	Referencia al usuario promocionable sobre el que operas en la solicitud. Tipo: string Ejemplo: `l310s`
with_deleted opcional	Incluye los resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Ejemplo de solicitud GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s Ejemplo de respuesta

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

Obtiene una lista con los detalles de los editores de la categoría de contenido Puedes encontrar más información en la Guía del objetivo de prerroll de reproducciones de video URL del recurso https://ads-api.x.com/12/publishers Parámetros Sin parámetros de solicitud Ejemplo de solicitud GET https://ads-api.x.com/12/publishers Ejemplo de respuesta

{
      "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 Obtén recomendaciones de campaña asociadas a esta cuenta de anuncios. Actualmente, hay un límite de 1 recomendación por instrumento de financiación. URL del recurso https://ads-api.x.com/5/accounts/:account_id/recommendations Parámetros

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

Ejemplo de solicitud GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations Ejemplo de respuesta

    "request": {
      "params": {
        "account_id": "18ce54d4x5t"
      }
    },
    "total_count": 1,
    "data": [
      {
        "funding_instrument_id": "gpvzb",
        "id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t",
        "status": "PENDING",
        "message": "Recomendación para pruebas",
        "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 a esta cuenta de anuncios. La recomendación de campaña contiene un conjunto completo de cambios sugeridos para la estructura de la campaña, representada como un árbol de objetos. El árbol de respuesta está diseñado para funcionar junto con los endpoints de la Batch API, pero también puede adaptarse 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

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta utilizada. Aparece en 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 al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
recommendation_id obligatorio	Referencia al ID de la 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 para 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": "Masculino",
                    "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 José CA, EE. UU.",
                    "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 partners",
                    "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, EE. UU.",
                    "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 a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parameters

Name	Description
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`
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 siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`
line_item_ids optional	Limita la respuesta a los Tweets programados asociados con line items específicos indicando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `8xdpe`
scheduled_promoted_tweet_ids optional	Limita la respuesta a los Tweets promocionados programados deseados indicando una lista de identificadores separada por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `1xboq`
sort_by optional	Ordena por un atributo admitido en orden ascendente o descendente. Consulta Sorting para más información. Type: string Example: `created_at-asc`
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`. Note: Este parámetro y `cursor` son mutuamente excluyentes. Note: Las solicitudes que incluyan `total_count` tendrán límites de frecuencia 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/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

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
scheduled_promoted_tweet_id obligatorio	Referencia al Tweet promocionado programado con el que se opera en la solicitud. Tipo: string Ejemplo: `1xboq`
with_deleted opcional	Incluye resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: `false` Valores posibles: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq Respuesta de ejemplo

    {
      "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 line item especificado. Nota: No es posible actualizar (PUT) las entidades de Tweet promocionado programado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parámetros

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

Solicitud de ejemplo

POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992

Respuesta de ejemplo

    {
      "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 elemento de línea especificado. Nota: scheduled_promoted_tweets solo se puede eliminar antes de la hora scheduled_at del Tweet programado. Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: `18ce54d4x5t`
scheduled_promoted_tweet_id required	Una referencia al Tweet promocionado programado con el que está operando en la solicitud. Corresponde al atributo `id` de un objeto de respuesta de GET accounts/:account_id/scheduled_promoted_tweets. Type: string Example: `1xtfl`

Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl Example Response

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

Recupera los detalles de algunos o 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

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
line_item_ids obligatorio	Limita la respuesta solo a los criterios de segmentación de los line items especificados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `8u94t`
count opcional	Especifica la cantidad de registros a intentar recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
cursor opcional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
lang opcional	Código de idioma ISO-639-1. Cuando se envía, se devuelve un atributo adicional `localized_name` en la respuesta para los objetos que dispongan de un nombre localizado. Tipo: string Ejemplo: `fr`
sort_by opcional	Ordena por un atributo compatible en orden ascendente o descendente. Consulta Ordenación para más información. Tipo: string Ejemplo: `created_at-asc`
targeting_criterion_ids opcional	Limita la respuesta solo a los criterios de segmentación deseados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Tipo: string Ejemplo: `dpl3a6`
with_deleted opcional	Incluye resultados eliminados en tu solicitud. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`
with_total_count opcional	Incluye el atributo de respuesta `total_count`. Nota: Este parámetro y `cursor` son excluyentes. Nota: Las solicitudes que incluyan `total_count` tendrán límites de uso más bajos, actualmente establecidos en 200 por cada 15 minutos. Tipo: boolean Predeterminado: `false` Valores posibles: `true`, `false`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t Respuesta de ejemplo

    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "8u94t"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8u94t",
          "name": "Segmentación por audiencia personalizada",
          "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

Name	Description
account_id required	Identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
targeting_criterion_id required	Referencia al criterio de segmentación con el que operas en la solicitud. Type: string Example: `eijd4y`
lang optional	Código de idioma ISO-639-1. Si se proporciona, se devolverá un atributo adicional `localized_name` en la respuesta para los objetos que tengan un nombre localizado disponible. Type: string Example: `fr`
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/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 Targeting Options para encontrar targeting_value para tipos de segmentación específicos. Recomendamos actualizar todos los datos semanalmente para asegurarte de trabajar con el conjunto más reciente de valores de segmentación. Actualizamos los valores y los criterios de segmentación disponibles de vez en cuando; aunque la mayoría no cambia con frecuencia, algunos sí. No podemos garantizar que estos valores no cambien. Usa los tipos de segmentación BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD o UNORDERED_KEYWORD con las palabras clave indicadas en targeting_value. Excluye palabras clave usando el parámetro de solicitud operator_type con el valor NE. Consulta targeting keyword types para una descripción detallada de cada tipo. Nota: Solo es posible segmentar un único grupo de edad por elemento de línea. Nota: Para segmentar una Custom Audience, esa audiencia debe ser seleccionable para segmentación; es decir, targetable debe ser igual a true. Nota: Al usar el tipo de segmentación TV_SHOW, debe existir al menos un criterio de segmentación LOCATION en el elemento de línea antes de configurar la segmentación TV_SHOW, y todas las LOCATION deben estar dentro de la misma configuración regional que el TV_SHOW al que se quiere segmentar. Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
line_item_id required	Referencia al elemento de línea con el que estás operando 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, usa `operator_type=NE`. Type: enum Possible values: `EQ`, `NE`, `GTE`, `LT`
targeting_type required	El tipo de segmentación que se aplicará a este elemento de línea. Possible non-keyword-based values include: `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 grupo de `AGE` por elemento de línea. Possible keyword-based values include: `BROAD_KEYWORD`, `EXACT_KEYWORD`, `PHRASE_KEYWORD`, `UNORDERED_KEYWORD` Possible custom audience values include: `CUSTOM_AUDIENCE`, `CUSTOM_AUDIENCE_EXPANDED` Possible installed app store category values: `APP_STORE_CATEGORY`, `APP_STORE_CATEGORY_LOOKALIKE` Possible Twitter Audience Platform (TAP) app exclusion: `APP_LIST` (may only be used with `operator_type=NE`)
targeting_value required	Especifica a qué usuario, interés, ubicación, evento, plataforma, versión de plataforma, dispositivo, palabra clave o frase, género, custom audience, categoría de tienda de apps o 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 por lotes de nuevos criterios de segmentación con una sola solicitud. Solicitudes por lotes

El tamaño máximo actual del 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 se completan correctamente 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.

Los errores a nivel de solicitud (p. ej., exceder el tamaño máximo del lote) se muestran en la respuesta bajo el objeto errors.
Los errores a nivel de elemento (p. ej., falta un parámetro obligatorio de criterios de segmentación) se muestran en la respuesta bajo el objeto operation_errors.

URL del recurso https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria Parámetros

Nombre	Descripción
operation_type obligatorio	Tipo de operación por elemento que se ejecuta. Tipo: enum Valores posibles: `Create`, `Delete`
params obligatorio	Objeto JSON que contiene todos los parámetros de los objetos de criterios de segmentación. Para ver la lista de parámetros obligatorios y opcionales de criterios de segmentación, consulte 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` (igual a), `GTE` (mayor o igual que), `LT` (menor que) y `NE` (distinto de).

Solicitud de ejemplo 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"
        }
      }
    ]

Respuesta de ejemplo

    {
      "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. URL del recurso https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parámetros

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

Solicitud de ejemplo DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6 Respuesta de ejemplo

    {
      "data": {
        "line_item_id": "8u94t",
        "name": "Segmentación por audiencia personalizada",
        "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"
        }
      }
    }

GET targeting_criteria/app_store_categories

Descubre los criterios de segmentación disponibles basados en categorías de tiendas de apps para Productos promocionados. Las categorías de tiendas de apps están disponibles únicamente para la App Store de iOS y Google Play. La segmentación por categoría de apps instaladas permite orientar a usuarios según las categorías de las apps que han instalado o en las que han mostrado interés. Resource URL https://ads-api.x.com/12/targeting_criteria/app_store_categories Parameters

Name	Description
q optional	Consulta opcional para acotar un criterio de segmentación. Omite este parámetro para recuperar todos. Type: string Example: `music`
os_type optional	Acota los resultados a una tienda de apps específica. Type: enum Possible values: `ANDROID`, `IOS`

Example Request GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS Example Response

    {
      "data": [
        {
          "name": "Juegos: Música",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qouq",
          "os_type": "IOS"
        },
        {
          "name": "Música",
          "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. Resource URL https://ads-api.x.com/12/targeting_criteria/conversations Parameters

Name	Description
conversation_type optional	Consulta opcional para acotar a un tipo específico de conversación. Type: enum Possible values: `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. Type: int Default: `200` Min, Max: `1`, `1000`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Example: `8x7v00oow`

Example Request GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2 Example Response

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

Descubra los criterios de segmentación por dispositivo disponibles para Promoted Products. La segmentación por dispositivo está disponible para Promoted Tweets. Resource URL https://ads-api.x.com/12/targeting_criteria/devices Parameters

Name	Description
count optional	Especifica la cantidad de registros a intentar recuperar por cada solicitud. Type: int Default: `200` Min, Max: `1`, `1000`
q optional	Consulta opcional para limitar un criterio de segmentación. Omita este parámetro para recuperar todos. 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 Productos Promocionados. Solo se puede segmentar un evento por línea de pedido. Nota: Los eventos suelen abarcar varias zonas horarias, lo que complica la consideración de sus horarios desde perspectivas con zonas horarias distintas. Para simplificar, todos los valores de start_time y end_time de eventos en este endpoint se representan en UTC±00:00, independientemente de la ubicación y la zona horaria del evento. Debe tenerse 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, evitando así el problema de que este festivo exista en múltiples zonas horarias dentro de EE. UU. Resource URL https://ads-api.x.com/12/targeting_criteria/events Parameters

Name	Description
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á recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., Máx.: `1`, `1000`
country_codes optional	Una consulta opcional para acotar la búsqueda de criterios de segmentación a países específicos con 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 siguiente página de resultados. Consulta Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
end_time optional	La hora, expresada en ISO 8601, en la que finalizará la campaña. Tipo: string Ejemplo: `2017-10-05T00:00:00Z`
start_time optional	La hora, expresada en ISO 8601, en la que la línea de pedido comenzará a publicarse. Nota: De forma predeterminada, es la hora actual. Tipo: string Ejemplo: `2017-07-05T00:00:00Z`

Example Request GET https://ads-api.x.com/12/targeting_criteria/events?count=1 Example Response

    {
      "request": {
        "params": {
          "count": 1
        }
      },
      "data_type": "events",
      "data": [
        {
          "reach": {
            "total_reach": null
          },
          "name": "Año Nuevo",
          "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

Descubra los criterios de segmentación por intereses disponibles para Promoted Products. Los intereses cambian con poca frecuencia; sin embargo, le sugerimos actualizar esta lista al menos una vez por semana. URL del recurso https://ads-api.x.com/12/targeting_criteria/interests Parámetros

Nombre	Descripción
count optional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud independiente. Tipo: int Predeterminado: `200` Mín., Máx.: `1`, `1000`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulte Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
q optional	Consulta opcional para acotar los criterios de segmentación. Omita este parámetro para recuperar todos. Tipo: string Ejemplo: `books`

Solicitud de ejemplo GET https://ads-api.x.com/12/targeting_criteria/interests?q=books Respuesta de ejemplo

    {
      "data": [
        {
          "name": "Libros y literatura/Biografías y memorias",
          "targeting_type": "INTEREST",
          "targeting_value": "1001"
        }
      ],
      "request": {
        "params": {
          "q": "libros",
          "count": 1
        }
      },
      "next_cursor": "6by4n4"
    }

GET targeting_criteria/languages

Descubra los idiomas disponibles para la segmentación. Resource URL https://ads-api.x.com/12/targeting_criteria/languages Parameters

Name	Description
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 siguiente página de resultados. Consulte Pagination para más información. Type: string Example: `8x7v00oow`
q optional	Consulta opcional para acotar el criterio de segmentación. Omita este parámetro para recuperar todos. 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

Descubra los criterios de segmentación por ubicación disponibles para Promoted Products. La segmentación geográfica está disponible para Promoted Accounts y Promoted Tweets a nivel de país, estado/región, ciudad y código postal. Debe utilizar la segmentación por código postal si desea obtener analíticas a nivel de código postal. Nota: Para obtener ciudades específicas segmentables, como San Francisco o New York, use el enum CITIES con el parámetro de solicitud location_type. Para segmentar Designated Market Areas (DMAs), use el enum METROS. Resource URL https://ads-api.x.com/12/targeting_criteria/locations Parameters

Name	Description
count optional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: `200` Min, Max: `1`, `1000`
country_code optional	Consulta opcional para limitar la búsqueda de criterios de segmentación a un país específico mediante el código de país ISO de 2 letras. Omita este parámetro para obtener resultados de todos los países. Type: string Example: `JP`
cursor optional	Especifica un cursor para obtener la siguiente página de resultados. Consulte Pagination para más información. Type: string Example: `8x7v00oow`
location_type optional	Limita los resultados por un tipo específico de ubicación. Una segmentación más granular que `COUNTRIES` puede no estar disponible en todas las ubicaciones. Type: enum Possible values: `COUNTRIES`, `REGIONS`, `METROS`, `CITIES`, `POSTAL_CODES`
q optional	Consulta opcional para limitar la búsqueda de criterios de segmentación. Omita este parámetro para obtener todos los resultados. Type: string Example: `New York`

Example Request GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles Example Response

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

Descubra los criterios de segmentación disponibles basados en operadores de red para Productos Promocionados. Este endpoint le permite consultar operadores segmentables, como AT&T, Verizon, Sprint, T-Mobile, etc., en varios países. URL del recurso https://ads-api.x.com/12/targeting_criteria/network_operators Parámetros

Nombre	Descripción
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
country_code opcional	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. Si no se especifica este parámetro, solo se devuelven audiencias de socios para Estados Unidos. Tipo: string Predeterminado: `US`
cursor opcional	Especifica un cursor para obtener la página siguiente de resultados. Consulte Paginación para más información. Tipo: string Ejemplo: `8x7v00oow`
q opcional	Consulta opcional para acotar una búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados. Tipo: string Ejemplos: `Airpeak`

Solicitud de ejemplo GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US Respuesta de ejemplo

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

Descubra los criterios de segmentación disponibles basados en la versión del sistema operativo móvil para los Productos Promocionados. La segmentación por versión de plataforma está disponible para Promoted Accounts y Promoted Tweets. Esto permite segmentar hasta la versión puntual 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

Nombre	Descripción
q opcional	Consulta opcional para acotar la búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados. Tipo: string Ejemplos: `jelly bean`

Solicitud de ejemplo GET https://ads-api.x.com/12/targeting_criteria/platform_versions Respuesta de ejemplo

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

Descubra los criterios de segmentación disponibles basados en plataforma para Productos Promocionados. URL del recurso https://ads-api.x.com/12/targeting_criteria/platforms Parámetros

Nombre	Descripción
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Tipo: int Predeterminado: `200` Mín., máx.: `1`, `1000`
q opcional	Consulta opcional para acotar la búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados. Tipo: string Ejemplos: `ios`, `blackberry`
lang opcional	Código de idioma ISO-639-1. Si se incluye, la respuesta devolverá un atributo adicional localized_name. Tipo: int, string Ejemplo: `fr`

Solicitud de ejemplo GET https://ads-api.x.com/12/targeting_criteria/platforms Respuesta de ejemplo

    {
      "data": [
        {
          "name": "iOS",
          "targeting_type": "PLATFORM",
          "targeting_value": "0"
        },
        {
          "name": "Android",
          "targeting_type": "PLATFORM",
          "targeting_value": "1"
        },
        {
          "name": "Teléfonos y tablets BlackBerry",
          "targeting_type": "PLATFORM",
          "targeting_value": "2"
        },
        {
          "name": "Web móvil en otros dispositivos",
          "targeting_type": "PLATFORM",
          "targeting_value": "3"
        },
        {
          "name": "Computadoras de escritorio y portátiles",
          "targeting_type": "PLATFORM",
          "targeting_value": "4"
        }
      ],
      "request": {
        "params": {}
      }
    }

GET targeting_criteria/tv_markets

Descubra 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. Resource URL https://ads-api.x.com/12/targeting_criteria/tv_markets Parameters Ninguno Example Request GET https://ads-api.x.com/12/targeting_criteria/tv_markets Example Response

    {
      "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 - Hispanos",
          "country_code": "US",
          "locale": "es-US"
        },
        {
          "name": "Irlanda",
          "country_code": "IE",
          "locale": "en-IE"
        }
      ],
      "request": {
        "params": {}
      }
    }

GET targeting_criteria/tv_shows

Descubre los criterios de segmentación disponibles basados en programas de TV para Promoted Products. La segmentación por programas de TV está disponible para Promoted Tweets en determinados mercados. Consulta el endpoint GET targeting_criteria/tv_markets para ver los mercados disponibles. Nota: Cualquier audiencia que tenga menos de 1.000 usuarios aparecerá con un valor de estimated_users de 1000. Nota: Las opciones de segmentación por canal y género de TV ya no están disponibles. Resource URL https://ads-api.x.com/12/targeting_criteria/tv_shows Parameters

Name	Description
locale required	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. Type: string Example: `en-US`
count optional	Especifica la cantidad de registros que se intentarán recuperar por cada solicitud. Type: int Default: `50` Min, Max: `1`, `50`
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	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`

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. URL del recurso https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions Parámetros

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
suggestion_type obligatorio	Especifica el tipo de sugerencias que se devolverán. Tipo: enum Valores posibles: `KEYWORD`, `USER_ID`
targeting_values obligatorio	Colección separada por comas de palabras clave o IDs de usuario utilizada para generar las sugerencias. Nota: No se pueden mezclar estos dos tipos de sugerencias. Ejemplo: `756201191646691328`
count opcional	Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Tipo: int Predeterminado: `30` Mín., Máx.: `1`, `50`

Solicitud de ejemplo

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"

Respuesta de ejemplo

    {
      "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 asociados con la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tax_settings Parámetros

Nombre	Descripción
account_id obligatorio	El identificador de la cuenta en uso. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings Respuesta de ejemplo

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

Nombre	Descripción
cuenta_id obligatorio	El identificador de la cuenta apalancada. Aparece dentro del recurso’la ruta s y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, exceptoGET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: cadena Ejemplo:`18ce54d4x5t`
dirección_ciudad opcional	La ciudad del propietario de la cuenta’dirección del titular de la cuenta. Tipo: cadena Ejemplo:`San Francisco`
dirección_país opcional	El código de país de dos letras del titular de la cuenta’dirección del titular de la cuenta. Tipo: cadena Ejemplo:`EE. UU.`
dirección_correo electrónico opcional	El correo electrónico asociado al propietario de la cuenta’dirección del titular de la cuenta. Tipo: cadena Ejemplo:`api@mctestface.com`
dirección_primero_nombre opcional	El nombre del propietario de la cuenta’dirección del titular de la cuenta. Tipo: cadena Ejemplo:`API`
dirección_última_nombre opcional	El apellido del titular de la cuenta’dirección de s. Tipo: cadena Ejemplo:`McTestface`
dirección_nombre opcional	Nombre de la empresa del propietario de la cuenta’dirección de s. Tipo: cadena Ejemplo:`ABC, S. A.`
dirección_postal_código opcional	El código postal del titular de la cuenta’dirección del titular de la cuenta. Tipo: cadena Ejemplo:`94102`
dirección_región opcional	La región del propietario de la cuenta’dirección del propietario de la cuenta. Tipo: cadena Ejemplo:`California`
dirección_Dirección (línea 1) opcional	La línea de dirección (calle) del titular de la cuenta’dirección de s. Tipo: cadena Ejemplo:`21 de Marzo St.`
dirección_calle 2 opcional	La segunda línea de la dirección del titular de la cuenta’dirección del propietario de la cuenta. Tipo: cadena Ejemplo:`Suite 99`
factura_a opcional	La entidad facturada. Tipo: enumeración Posibles valores:`ANUNCIANTE`,`AGENCIA`
empresa_relación opcional	Si la cuenta pertenece al anunciante o a la agencia. Tipo: enumeración Valores posibles:`AGENCIA`,`SELF`
cliente_dirección_ciudad opcional	La ciudad del anunciante’dirección del usuario. Configura esto cuando la cuenta de anuncios pertenezca a una agencia. Tipo: cadena Ejemplo:`Toronto`
cliente_dirección_país opcional	El código de país de dos letras del anunciante’dirección del anunciante. Configura esto cuando la cuenta publicitaria pertenezca a una agencia. Tipo: cadena Ejemplo:`CA`
cliente_dirección_correo electrónico opcional	El correo electrónico asociado al anunciante’dirección del usuario. Configúrelo cuando la cuenta publicitaria pertenezca a una agencia. Tipo: string Ejemplo:`ads@brand.com`
cliente_dirección_primero_nombre opcional	El nombre del anunciante’dirección de s. Configura esto cuando la cuenta publicitaria pertenezca a una agencia. Tipo: cadena Ejemplo:`Marca`
cliente_dirección_último_nombre opcional	Apellido del anunciante’dirección de s. Configura esto cuando la cuenta de anuncios pertenezca a una agencia. Tipo: cadena Ejemplo:`Anunciante`
cliente_dirección_nombre opcional	El nombre de la compañía del anunciante’dirección del anunciante. Establece esto cuando la cuenta publicitaria pertenezca a una agencia. Tipo: cadena Ejemplo:`Brand, S. A.`
cliente_dirección_postal_código opcional	El código postal del anunciante’dirección del remitente. Establécelo cuando la cuenta de anuncios pertenezca a una agencia. Tipo: cadena Ejemplo:`M5H 2N2`
cliente_dirección_región opcional	La región del anunciante’la dirección del anunciante. Establézcalo cuando la cuenta publicitaria pertenezca a una agencia. Tipo: cadena de texto Ejemplo:`Ontario`
cliente_dirección_dirección1 opcional	La dirección (línea de calle) del anunciante’dirección del usuario. Establece esto cuando la cuenta publicitaria pertenezca a una agencia. Tipo: cadena Ejemplo:`280 Queen St W`
cliente_dirección_línea de dirección 2 opcional	La segunda línea de dirección del anunciante’dirección del anunciante. Configúrelo cuando la cuenta publicitaria pertenezca a una agencia. Tipo: cadena Ejemplo:`Los 6`
factura_Jurisdicción opcional	Jurisdicción de facturación. Tipo: enumeración Valores posibles:`LOI_SAPIN`,`NONE`,`NO_DEFINIDO`
impuesto_categoría opcional	Si la tributación debe ser individual o empresarial. Tipo: enumeración Posibles valores:`BUSINESS_NO_VAT`,`EMPRESA_CON_IVA`,`INDIVIDUAL`
impuesto_exención_id opcional	ID de exención del IVA. Tipo: string Ejemplo:`12345`
impuesto_id opcional	ID de registro de IVA. Tipo: cadena 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

Recupera los detalles de algunas o todas las etiquetas de seguimiento asociadas a la cuenta actual. Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: `18ce54d4x5t`
count optional	Especifica cuántos registros intentar 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 más información. Type: string Example: `8x7v00oow`
line_item_ids optional	Limita la respuesta a las etiquetas de seguimiento asociadas a partidas de línea específicas, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `96uzp`
sort_by optional	Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para más información. Type: string Example: `created_at-asc`
tracking_tag_ids optional	Limita la respuesta a las etiquetas de seguimiento deseadas indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: `3m82`
with_deleted optional	Incluye resultados eliminados en la solicitud. Type: boolean Default: `false` Possible values: `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 incluyen `total_count` tendrán límites de frecuencia más bajos, actualmente fijados 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/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 a la cuenta actual. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parámetros

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

Solicitud de ejemplo GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j Respuesta de ejemplo

    {
      "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. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parámetros

Name	Description
account_id required	El identificador de la cuenta aprovechada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al 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: `8v7jo`
tracking_tag_type required	El tipo de etiqueta de seguimiento. Type: enum Possible value: `IMPRESSION_TAG`, `CLICK_TRACKER`
tracking_tag_url required	La URL de la etiqueta de seguimiento proporcionada por el socio de seguimiento. Type: string Example: `https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309`

Solicitud de ejemplo

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

Respuesta de ejemplo

    {
      "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 ítem de línea especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parámetros

Name	Description
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
tracking_tag_url required	La URL de la etiqueta de seguimiento proporcionada por el partner de seguimiento. Tipo: string Ejemplo: `https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309`

Solicitud de ejemplo

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

Respuesta de ejemplo

    {
      "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 ítem de línea especificado. URL del recurso https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parámetros

Nombre	Descripción
account_id obligatorio	Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
tracking_tag_id obligatorio	Referencia a la etiqueta de seguimiento con la que se opera 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 del usuario

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

GET accounts/:account_id/user_settings/:user_id

Recupera la configuración del usuario. URL del recurso https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parámetros

Nombre	Descripción
account_id required	El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: `18ce54d4x5t`
user_id required	Referencia al usuario con el que operas en la solicitud. Usa GET users/lookup para obtener un id de usuario a partir de un screen name. 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 accesible para administradores de la cuenta. URL del recurso https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parámetros

Nombre	Descripción
account_id obligatorio	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. Tipo: string Ejemplo: `18ce54d4x5t`
user_id obligatorio	Referencia al usuario con el que se opera en la solicitud. Use GET users/lookup para obtener el ID de usuario a partir de un nombre de usuario. Tipo: long Ejemplo: `756201191646691328`
notification_email opcional	Correo electrónico para las notificaciones de la cuenta. Tipo: string Ejemplo: `user@domain.com`
contact_phone opcional	Número de teléfono de contacto. Tipo: string Ejemplo: `202-555-0128`
contact_phone_extension opcional	Extensión para `contact_phone`. Tipo: string Ejemplo: `1234`

Solicitud de ejemplo

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"

Respuesta de ejemplo

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

API de X Ads

Conceptos básicos

Recursos

Medición

​API para anunciantes

​¿Qué puedes promocionar?

​Promoted Ads

​Cuentas promocionadas

​Campañas y Grupos de Anuncios (Line Items)

​Analíticas

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

​Campañas basadas en objetivos

​Instrumentos de financiación

​Atributos del instrumento de financiación

​Detalles de los atributos

​Tipos de instrumentos de financiación

​Segmentación

​Opciones de segmentación por emplazamiento

​Comprender los tipos de segmentación

​Combinaciones de criterios de segmentación

​Ejemplos adicionales

​Ritmo de gasto del presupuesto

​Puja objetivo

​Estrategia de puja

​Puja con objetivo

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

​Rusia

​Instrumentos de financiación gestionados por el socio

​Configuración inicial del partner

​Flujo de incorporación de anunciantes

​Carga útil de redirección de incorporación

​Carga útil de la URL de callback

​Firma de la solicitud y URLs de callback

​Ejemplos de firma

​Uso y renovación de claves compartidas

​creación de partner_managed_funding_instrument

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

​Flujo de error no redirigible

​Actualizaciones continuas del PMFI

​Ubicaciones

​Preguntas frecuentes sobre grupos de anuncios

​¿Qué es un grupo de anuncios?

​¿Cómo creamos un Grupo de anuncios?

​¿Por qué deberíamos añadir compatibilidad con Grupos de anuncios?

​¿Cómo se relaciona el presupuesto del ítem de línea con el presupuesto de la campaña en una campaña de Grupos de anuncios?

​¿Rinden mejor los Ad Groups que los line items individuales?

​Guías

​Objetivo de vistas de video con preroll

​Endpoints requeridos

​Pasos

​Carga el video

​Carga del video

​Añade el video a la cuenta de anuncios

​Configurar la campaña

​Creación de campañas

​Creación de line items

​Selección de editores

​Categorías seleccionadas

​Categorías de contenido

Asociar el contenido multimedia de la cuenta (video) con el elemento de línea

​Configura el CTA y la URL de destino

​Establecer criterios de segmentación

​Lanzar la campaña

​Analítica

​Segmentación por palabras clave en las líneas de tiempo

​¿Cómo funciona?

​Guía de inicio rápido

​Referencia de API

​Cuentas

​GET accounts

​Ejemplo de solicitud

​GET accounts/:account_id

​POST accounts

​PUT accounts/:account_id

​DELETE accounts/:account_id

​Apps de la cuenta

​GET account_apps

​Historial de la cuenta

​GET accounts/:account_id/account_history

​Categorías comerciales de anunciantes

API para anunciantes

¿Qué puedes promocionar?

Promoted Ads

Cuentas promocionadas

Campañas y Grupos de Anuncios (Line Items)

Analíticas

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

Campañas basadas en objetivos

Instrumentos de financiación

Atributos del instrumento de financiación

Detalles de los atributos

Tipos de instrumentos de financiación

Segmentación

Opciones de segmentación por emplazamiento

Comprender los tipos de segmentación

Combinaciones de criterios de segmentación

Ejemplos adicionales

Ritmo de gasto del presupuesto

Puja objetivo

Estrategia de puja

Puja con objetivo

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

Rusia

Instrumentos de financiación gestionados por el socio

Configuración inicial del partner

Flujo de incorporación de anunciantes

Carga útil de redirección de incorporación

Carga útil de la URL de callback

Firma de la solicitud y URLs de callback

Ejemplos de firma

Uso y renovación de claves compartidas

creación de partner_managed_funding_instrument

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

Flujo de error no redirigible

Actualizaciones continuas del PMFI

Ubicaciones

Preguntas frecuentes sobre grupos de anuncios

¿Qué es un grupo de anuncios?

¿Cómo creamos un Grupo de anuncios?

¿Por qué deberíamos añadir compatibilidad con Grupos de anuncios?

¿Cómo se relaciona el presupuesto del ítem de línea con el presupuesto de la campaña en una campaña de Grupos de anuncios?

¿Rinden mejor los Ad Groups que los line items individuales?

Guías

Objetivo de vistas de video con preroll

Endpoints requeridos

Pasos

Carga el video

Carga del video

Añade el video a la cuenta de anuncios

Configurar la campaña

Creación de campañas

Creación de line items

Selección de editores

Categorías seleccionadas

Categorías de contenido

Configura el CTA y la URL de destino

Establecer criterios de segmentación

Lanzar la campaña

Analítica

Segmentación por palabras clave en las líneas de tiempo

¿Cómo funciona?

Guía de inicio rápido

Referencia de API

Cuentas

GET accounts

Ejemplo de solicitud

GET accounts/:account_id

POST accounts

PUT accounts/:account_id

DELETE accounts/:account_id

Apps de la cuenta

GET account_apps

Historial de la cuenta

GET accounts/:account_id/account_history

Categorías comerciales de anunciantes

GET advertiser_business_categories

Estimación de la audiencia

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

Acceso de usuario autenticado

GET accounts/:account_id/authenticated_user_access