API para anunciantes
¿Qué puedes promocionar?
- Los Promoted Ads son anuncios comunes comprados por anunciantes que desean llegar a un grupo más amplio de usuarios o impulsar la interacción de sus seguidores existentes.
- Los Promoted Ads están claramente etiquetados como Promoted cuando un anunciante paga por su ubicación en X. Por lo demás, los Promoted Ads se comportan igual que los anuncios normales y se pueden volver a publicar, responder, dar like y más. Tienen reglas de entrega típicas y se crean usando POST statuses/update.
- Tweets “Promoted-only”, 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 promoted-only de una cuenta determinada, usa GET accounts/:account_id/scoped_timeline.
- Las Cuentas promocionadas forman parte de Who to Follow, que sugiere cuentas que las personas aún no siguen y que podrían resultarles interesantes. Las Cuentas promocionadas ayudan a presentar una variedad aún más amplia de cuentas que podrían gustarles.
- Las Cuentas promocionadas para Timeline asocian un Tweet promocionado con una campaña de Cuenta promocionada y se muestran en las cronologías de los usuarios.
Campañas y grupos de anuncios (line items)
Analytics
Creación de una campaña: paso a paso
-t
para trazar la llamada, aproximadamente equivalente a la opción -v
de cURL.
Para este ejemplo, crearemos una campaña de Promoted Ads dirigida por palabra clave.
- Recupere el id de la cuenta.
- Recupere el id del instrumento de financiación.
- Cree una campaña y asóciela con el instrumento de financiación.
- Crea un elemento de línea asociado a la campaña.
- Cree un perfil de segmentación asociado al line item.
- Por último, reanuda el elemento de línea.
Campañas basadas en objetivos
objective
adecuado en los line items.
El parámetro utilizado en los endpoints de escritura de line item y devuelto en los endpoints de lectura es objective
. Este campo tiene los siguientes valores posibles a día de hoy:
APP_ENGAGEMENTS
APP_INSTALLS
FOLLOWERS
ENGAGEMENTS
REACH
VIDEO_VIEWS
PREROLL_VIEWS
WEBSITE_CLICKS
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 diferentes objetivos dentro de la misma campaña.
Objetivo de la campaña | Objetivo de la API | Contenido multimedia en Tweets | Modelo de precios |
---|---|---|---|
Reenganche de la app | APP_ENGAGEMENTS | Se requiere tarjeta de descarga de app con imagen o video. | CPAC |
Instalaciones de la app | APP_INSTALLS | Se requiere tarjeta de descarga de app con imagen o video. | CPAC o CPI (configurado con charge_by ) |
Alcance | REACH | Sin restricciones. | CPM |
Seguidores | FOLLOWERS | Tweet no obligatorio, pero recomendado. No hay restricciones de contenido multimedia en los Tweets para campañas de Seguidores, aunque recomendamos Tweets solo de texto. Más información | 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 vista de 3 s/100% |
Vistas de pre-roll | PREROLL_VIEWS | Se requiere video. | CPV o costo por vista de 3 s/100% |
Clics en el sitio web | WEBSITE_CLICKS | Tarjeta de sitio web recomendada, pero no obligatoria. El Tweet debe incluir una tarjeta de sitio web o un enlace al sitio web (no ambos). | CPLC |
Instrumentos de financiación
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
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). Tenga en cuenta que un único io_header
puede estar asociado con múltiples instrumentos de financiación.
Capacidad de financiación: able_to_fund
y reasons_not_able_to_fund
.
Tiempo: created_at
, updated_at
, start_time
y end_time
, representados 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 divisa se representa en micros. Para USD, $5.50 se codifica como 5.50*1e6, o 5,500,000. Para representar un “valor entero”, debe multiplicar el valor en micros locales por 1e6 (1_000_000) para todas las divisas.
Detalles de los atributos
credit_limit_local_micro
solo es válido para instrumentos de financiamiento 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 financiamiento de tipo INSERTION_ORDER
y representa el presupuesto asignado.
credit_remaining_local_micro
es válido para instrumentos de financiamiento de tipo CREDIT_LINE
y AGENCY_CREDIT_LINE
. Representa el credit_limit_local_micro
menos el importe ya gastado en ese instrumento de financiamiento. 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 reflejan distintos métodos de financiamiento subyacentes y acuerdos de gasto que tenemos con los anunciantes.
Tipos de instrumentos de financiación
CREDIT_LINE
type).
Segmentación
Opciones de segmentación por emplazamiento
- X Search: Segmentación por edad, Dispositivos, Eventos, Género, Tipos de palabras clave (todos), Idioma, Ubicaciones, Activación de red, Operadores de red, Plataforma, Versión de 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 exactas, Tipos de audiencias de socios, Plataforma, Versión de plataforma, Tipos de remarketing, Audiencias personalizadas, Tipos de segmentación en 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 exactas, Tipos de audiencias de socios, Plataforma, Versión de plataforma, Tipos de remarketing, Audiencias personalizadas, Tipos de segmentación en TV, Solo Wi‑Fi
Comprender los tipos de segmentación
NETWORK_OPERATOR
de GET targeting_criteria/network_operators.
Segmentación por dispositivo móvil nuevo: Llega a los usuarios según la fecha en que accedieron por primera vez a X desde su dispositivo, usando el tipo de segmentación NETWORK_ACTIVATION_DURATION
con operator_type de LT
para menor que y GTE
para mayor o igual que.
Platforms, Platform Versions, Devices y solo WiFi: Permite segmentar dispositivos móviles en una variedad de dimensiones. Platforms es un tipo de segmentación de alto nivel que puede abarcar categorías amplias de teléfono. Ejemplos de valores: iOS
y Android
. Devices permite segmentar a usuarios de dispositivos móviles específicos, por ejemplo, iPhone 5s
, Nexus 4
o Samsung Galaxy Note
. Platform versions permite segmentar a usuarios de versiones de sistemas operativos móviles específicos, hasta la versión puntual. Ejemplos: iOS 7.1 y Android 4.4. Solo WiFi permite segmentar únicamente a quienes usan sus dispositivos en una red WiFi; si no se configura, se segmentará a usuarios que usen tanto la conexión del operador como WiFi.
- Los usuarios pueden segmentar plataformas y dispositivos si no hay superposición. Puedo segmentar BlackBerry como plataforma y 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 que sean más amplias que los dispositivos. No puedo segmentar iOS e iPad Air.
TV_SHOW
. Usa los endpoints GET targeting_criteria/tv_markets y GET targeting_criteria/tv_shows para determinar los programas de TV disponibles.
Tweet Engager Retargeting
El retargeting de usuarios que interactuaron con Tweets permite a los anunciantes segmentar audiencias en múltiples dispositivos que previamente estuvieron expuestas o interactuaron con sus Tweets promocionados u orgánicos en X. Con esta segmentación, los anunciantes pueden volver a impactar a las personas que vieron o interactuaron con el contenido del anunciante en X y que probablemente sigan interactuando o conviertan con mensajes u ofertas posteriores. Los usuarios serán aptos para la segmentación a los pocos minutos de la exposición o interacción y seguirán siéndolo hasta 90 días después en el caso de interacciones y 30 días en el caso de exposiciones.
Tipos de segmentación de usuarios que interactuaron con Tweets:
ENGAGEMENT_TYPE
, que aceptaIMPRESSION
oENGAGEMENT
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 esta campaña (segúnENGAGEMENT_TYPE
).USER_ENGAGEMENT
, que usa el id de usuario promocionado como valor de segmentación para llegar a usuarios que estuvieron expuestos o interactuaron con el contenido orgánico de un anunciante (segúnENGAGEMENT_TYPE
). Debe ser el id de usuario promocionado asociado con la cuenta de Ads.
ENGAGEMENT_TYPE
es obligatorio, además de al menos un valor válido de CAMPAIGN_ENGAGEMENT
o USER_ENGAGEMENT
. Ambos tipos de segmentación de usuarios que interactuaron con Tweets pueden estar presentes y se pueden segmentar varias campañas en una misma partida.
Video Viewer Targeting: la segmentación de espectadores de video amplía la segmentación de usuarios que interactuaron con Tweets para permitir a los anunciantes segmentar audiencias que previamente vieron parte o la totalidad de un video en X. Los anunciantes pueden segmentar videos orgánicos, promocionados o ambos. Los videos promocionados no se limitan a campañas o partidas con el objetivo de vistas de video.
Tipos de segmentación de espectadores de video:
VIDEO_VIEW
para usuarios que hicieron clic para reproducir el video o vieron 3 segundos de reproducción automáticaVIDEO_VIEW_PARTIAL
para usuarios que vieron el 50% del videoVIDEO_VIEW_COMPLETE
para usuarios que vieron al menos el 95% del video
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únENGAGEMENT_TYPE
) en esta campaña.USER_ENGAGEMENT
, que usa el id de usuario promocionado como valor de segmentación para llegar a usuarios que vieron un video (segúnENGAGEMENT_TYPE
) en el contenido orgánico de un anunciante. Debe ser el id de usuario promocionado asociado con la cuenta de Ads.
- Broad (valor predeterminado): hace coincidir todas las palabras, independientemente del orden. No distingue entre mayúsculas, plurales ni tiempo verbal. Se ampliará automáticamente cuando sea posible (p. ej., “car repair” también coincidiría con “automobile fix”). Si quieres segmentar sin ampliación, debes añadir un signo + antes de las palabras clave, como “+boat +jet”. Usar palabras clave sin el + será Broad Match de forma predeterminada.
- Unordered (en desuso): hace coincidir todas las palabras, independientemente del orden. No distingue entre mayúsculas, plurales ni tiempo verbal.
- Phrase: hace coincidir la cadena exacta de palabras clave; pueden estar presentes otras palabras clave.
- Exact: hace coincidir exactamente la cadena de palabras clave, y no ninguna otra.
- Negative: evita hacer coincidir búsquedas que incluyan todas estas palabras clave en alguna parte de la query, sin importar el orden en que estén escritas, incluso si hay otras palabras presentes.
- Negative Phrase: evita hacer coincidir búsquedas que incluyan esta cadena exacta de palabras clave en alguna parte de la query, incluso si hay otras palabras presentes.
- Negative Exact: evita hacer coincidir búsquedas que coincidan exactamente con estas palabras clave y no contengan otras palabras.
Combinaciones de criterios de segmentación
Tipos “principales” | Otros tipos |
Seguidores | Ubicaciones |
Audiencias personalizadas | Género |
Intereses | Idiomas |
Palabras clave | Dispositivos y plataformas |
TV | Edad |
- Los tipos de segmentación “principales” se combinarán mediante ∪ (es decir, unión lógica).
- Los otros tipos de segmentación se combinarán con AND.
- Los mismos tipos se combinarán con OR.
- Usuarios de X en EE. UU., Inglaterra y Canadá (Ubicación)
- que sean mujeres (Género)
- derivado de una lista de Audiencias personalizadas (“principal”)
- con Palabras clave (“principal”)
Ejemplos adicionales
- Seleccione género y ubicación geográfica, pero sin primaria: (Hombre) AND (US OR GB)
- Seleccione género, ubicación geográfica e intereses: (Mujer) AND (CA) AND (Computadoras OR Tecnología OR Startups)
- Seleccione género, ubicación geográfica, intereses, Audiencias personalizadas y palabras clave: (Hombre) AND (GB) AND (Autos ∪ Audiencias personalizadas para CRM ∪ autocross)
Ritmo de gasto del presupuesto
standard_delivery
en false
para configurar el ritmo en 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 mejorará el eCPE/CPF para los anunciantes, con una cobertura más uniforme a lo largo del día.
Puja específica
Estrategia de puja
Objetivo de la campaña | Heredado | X Ads API v10+ |
App Installs | bid_type = AUTO bid_unit = APP_INSTALLS charge_by = APP_CLICKS | goal = APP_INSTALLS bid_strategy = AUTO |
Website Clicks | bid_type = TARGET (Nota: bid_unit no era necesario para algunos objetivos de campaña) | bid_strategy = TARGET |
Puja objetivo
bid_strategy
en los elementos de línea se puede establecer con el valor TARGET
para habilitar la puja objetivo en objetivos de campaña pertinentes, como:
WEBSITE_CLICKS
WEBSITE_CONVERSIONS
APP_INSTALLS
APP_ENGAGEMENTS
REACH
Requisitos de segmentación por país y de visualización
Rusia
Instrumentos de financiación gestionados por partners
Configuración inicial del 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 utilizará para verificar data durante el flujo de incorporación.
- El
app_id
oconsumer_secret
de la X App que se utilizará para el acceso a la Ads API. Puede ver y editar sus X Apps existentes a través del App dashboard si ha iniciado sesión en su cuenta de X en developer.x.com. Si necesita crear una X App, deberá tener una cuenta de desarrollador aprobada. X permite una App para producción+sandbox y una App opcional solo para sandbox. La X App debe crearse en un handle corporativo de X controlado por el partner.
Flujo de incorporación de anunciantes
- 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 una carga útil firmada. Esta carga útil contiene el
app_id
de la API del partner, eluser_id
de X del handle de X que se va a incorporar, una URL de callback y otros fields documentados más abajo. - Se solicita al usuario que inicie sesión en ads.x.com usando 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 verificaciones.
- Cuando se completan todas las tareas de incorporación, el usuario es redirigido a la URL de callback proporcionada por el partner de X Ads API, con una carga útil que indica éxito o error. Esto incluye el proceso de autorización de 3-legged.
Carga útil de redirección de incorporación
Nombre | Tipo | Descripción |
callback_url | Cadena codificada en URL | el usuario será redirigido a esta URL después de que se complete el proceso de vinculación de la cuenta, independientemente del resultado. Consulte la sección de URL de redirección del partner para conocer los detalles del protocolo |
client_app_id | entero | id de la App cliente de la X API, utilizado para identificar al partner gestor |
promotable_user_id | entero | user_id de X del @handle cuyas promociones gestionará el partner. Se utiliza para asegurarse de que coincide con el usuario 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 pausará y se configurará un nuevo instrumento de financiación del partner gestor (si existe uno con el mismo nombre, no ocurrirá nada) |
timezone | String, en formato Área/Ubicación | Este será el huso horario que se utilizará para determinar el día al que aplican los presupuestos diarios y en el que se agregarán los cargos |
currency | Código de moneda ISO 4217 | Moneda que se utilizará para introducir 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
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 partner USER_MISMATCH la cuenta de X utilizada para iniciar sesión en ads.x.com era diferente del promotable_user_id en la solicitud de vinculación de cuenta INCOMPLETE_SERVING_BILLING_INFO no se especificaron la zona horaria, la moneda o el 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 | URL encoded string | id de la cuenta de anuncios de X de la cuenta vinculada |
funding_instrument_id | URL encoded string | id del instrumento de financiación administrado por el partner activo |
signature | URL encoded, base64 encoded binary code, as explained below | 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 user_id de X para el que estaba destinado el proceso de vinculación de cuenta, se debe anexar el user_id de X al secreto compartido (usando &) al firmar la solicitud. |
user_id
de X para el que estaba destinado el proceso de vinculación de cuenta, se debe anexar el user_id
de X al secreto compartido (usando &) al firmar la solicitud.
Firmar la solicitud y las URL de callback
/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 administrador garantiza que cada parte solo acepte solicitudes enviadas por la contraparte autorizada.
El algoritmo de generación de la firma es similar al utilizado en OAuth.
Crea una cadena base de firma como sigue:
- Convierte el método HTTP a mayúsculas y establece la cadena base igual a ese valor.
- Añade el carácter ‘&’ a la cadena base.
- Codifica en porcentaje la URL (sin parámetros) y añádela a la cadena base.
- Añade el carácter ‘&’ a la cadena base.
- Añade la cadena de consulta codificada en porcentaje, que se construye de la siguiente manera:
- Codifica en porcentaje cada clave y valor que se firmará.
- Ordena la lista de parámetros alfabéticamente por clave.
- Para cada par clave/valor (y con primary_promotable_user_id para la URL de redirección del socio):
- Añade la clave codificada en porcentaje a la cadena de consulta.
- Añade el carácter ‘=’ a la cadena base.
- Añade el valor codificado en porcentaje a la cadena de consulta.
- Separa los pares clave=valor codificados en porcentaje con el carácter ‘&’.
- Usa el algoritmo HMAC-SHA1, utilizando el secreto compartido intercambiado previamente como clave y la cadena base como valor para generar la firma.
- Codifica en Base64 la salida del paso 2, elimina el carácter de nueva línea final, codifica en porcentaje la firma generada en el paso 3 y agrégala a la URL en un parámetro signature
Ejemplos de firma
KBxQMMSpKRrtg9aw3qxK4fTXvUc=
Esta firma luego se agrega (codificada por porcentaje) al final de la URL original en el parámetro signature (paso 4):
https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D
Firma de una URL de redirección de socio (callback de solicitud de vinculación de cuenta) La URL a 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 que consiste en 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 codificada por porcentaje 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 cual se realizó la solicitud de vinculación original, 1 (promotable_user_id
= 1 de arriba), como clave: “secret&1”.
El resultado se codifica en Base64 y se presenta sin el “\n” final (pasos 2 y 3): jDSHDkHJIFXpPLVxtA3a9d4bPjM=
Esta firma se agrega (codificada 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
El algoritmo de firma debe poder ejecutarse con múltiples claves. Esto permitirá utilizar varias claves compartidas y habilitar 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 en la cuenta ningún partner_managed_funding_instrument con el mismo nombre, se creará un nuevo partner_managed_funding_instrument y se pondrán en pausa todos los partner_managed_funding_instruments existentes. Si 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
Flujo de error no redirigible
Actualizaciones continuas del PMFI
Ubicaciones
placements
. Los valores posibles son:
ALL_ON_TWITTER
PUBLISHER_NETWORK
TWITTER_PROFILE
TWITTER_SEARCH
TWITTER_TIMELINE
SPOTLIGHT
TREND
product_type
y el objective
del line item determinan qué ubicaciones están permitidas. El endpoint GET line_items/placements puede usarse para obtener las opciones de ubicación válidas para cada tipo de producto.
Además, la siguiente tabla enumera las combinaciones válidas de ubicación y objetivo.
Objetivo | ALL_ON_TWITTER | TWITTER_PROFILE | TWITTER_SEARCH | TWITTER_TIMELINE |
---|---|---|---|---|
APP_ENGAGEMENTS | ✔ | ✔ | ✔ | ✔ |
APP_INSTALLS | ✔ | ✔ | ✔ | ✔ |
REACH | ✔ | ✔ | ✔ | ✔ |
FOLLOWERS | ✔ | ✔ | ✔ | ✔ |
ENGAGEMENTS | ✔ | ✔ | ✔ | ✔ |
VIDEO_VIEWS | ✔ | ✔ | ✔ | ✔ |
PREROLL_VIEWS | ✔ | ✔ | ✔ | ✔ |
WEBSITE_CLICKS | ✔ | ✔ | ✔ | ✔ |
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
¿Qué es un grupo de anuncios?
¿Cómo creamos un grupo de anuncios?
¿Por qué deberíamos añadir compatibilidad con Ad Groups?
¿Cómo se relaciona el presupuesto del line item con el presupuesto de la campaña en una campaña de Ad Groups?
¿Rinden mejor los grupos de anuncios que los elementos de línea individuales?
Guías
Objetivo de vistas de video en preroll
Endpoints necesarios
- Carga de medios en segmentos (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 CTA y URL de redirección)
- POST batch/accounts/:account_id/targeting_criteria (segmentación)
Pasos
Cargar el vídeo
Carga del medio de video
media_category=amplify_video
en el INIT
inicial usando este endpoint. Cargarás el video en fragmentos. Una vez que STATUS
devuelva un state
de succeeded
, puedes continuar con los siguientes pasos. Puedes encontrar más información sobre la carga de medios con el endpoint de carga segmentada en nuestra Promoted Video Overview.
Agregar el video a la cuenta de anuncios
STATUS
sea succeeded
, utilizarás el media_key
devuelto por ese endpoint para agregar el video a la biblioteca de medios del anunciante, usando el endpoint POST accounts/:account_id/media_library.
Configurar la campaña
Creación de la campaña
objective
= VIDEO_VIEWS_PREROLL
y product_type
= MEDIA
. El parámetro categories
también debe configurarse con las categorías comerciales del anunciante adecuadas.
Creación de elementos de línea
categories
en “Science & Education”, se debe configurar el conjunto completo de iab_categories
, es decir, "IAB5", "IAB15"
, en el elemento de línea, así:
Selección de editores
Categorías curadas
- El line item debe apuntar al país correspondiente según el country_code de la Categoría curada
- Se debe usar el endpoint POST line_item_curated_categories para asociar el line item con un curated_category_id específico.
Categorías de contenido
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 lo contrario, se producirá un error de validación.
Asociar el medio de la cuenta (video) con el elemento de línea
Configura el CTA y la URL de destino
VIDEO_VIEWS_PREROLL
no utiliza Promoted Tweets ni Cards. En su lugar, el contenido de video se asocia a tu grupo de anuncios (line item) y la información del CTA se vincula a una entidad preroll_call_to_action
. El endpoint POST accounts/:account_id/preroll_call_to_action te permite controlar el botón del CTA y la URL de destino.
Establecer criterios de segmentación
CONTENT_PUBLISHER_USER
como segmentación en negativo 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 puede usarse para obtener la lista de user_id que excluir en Content Categories. El publisher_user_id devuelto en la respuesta de GET curated_categories puede usarse para obtener una lista de exclusión similar para Curated Categories.
Nota: Puede excluirse un máximo de 5 publisher_user_id para Curated Categories y 50 user_id para Content Categories.
Lanzar la campaña
Analítica
VIDEO_VIEWS_PREROLL
están disponibles a través de nuestros endpoints de estadísticas.
Segmentación por palabras clave en cronologías
¿Cómo funciona?
targeting_type
en unordered_keywords
o phrase_keywords
para los line items.
Guía rápida
- Crea un nuevo ítem de línea con la ubicación configurada para incluir
ALL_ON_TWITTER
oTWITTER_TIMELINE
POST accounts/:account_id/line_items - Crea los criterios de segmentación para este ítem de línea recién creado con
BROAD_KEYWORD
y define los valores de 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 medir el rendimiento. GET stats/accounts/:account_id
Referencia de la API
Cuentas
https://ads-api.x.com/12/accounts
Parameters
Name | Description |
---|---|
account_ids optional | Limita la respuesta únicamente a los ID de cuenta deseados especificando una lista de identificadores separados por comas. 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. Consulte Pagination para más información. Type: string Example: 8x7v00oow |
q optional | Una query opcional para delimitar el recurso por name . Note: Realiza una coincidencia de prefijo que no distingue mayúsculas de minúsculas. Type: string Min, Max length: 1 , 255 |
sort_by optional | Ordena por un atributo admitido 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 su 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 incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos. Type: boolean Default: false Possible values: true , false |
GET accounts/:account_id
Recupera una cuenta específica a la que tiene acceso el usuario autenticado. Resource URLhttps://ads-api.x.com/12/accounts/:account_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 |
with_deleted optional | Incluye en la solicitud los resultados eliminados. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t
Example Response
https://ads-api-sandbox.x.com/12/accounts
Parameters
Ninguno
Example Request
POST https://ads-api-sandbox.x.com/12/accounts
Example Response
PUT accounts/:account_id
Actualiza el nombre de la cuenta y/o el tipo de industria. URL del recursohttps://ads-api.x.com/12/accounts/:account_id
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. Type: string Ejemplo: 18ce54d4x5t |
name opcional | El nombre de la cuenta. Type: string Ejemplo: API McTestface |
industry_type opcional | La industria con la que está asociada la cuenta. Type: string Valores posibles: AGENCY , BUSINESS_TO_BUSINESS , ONLINE_SERVICES , EDUCATION , FINANCIAL , HEALTH , GOVERNMENT , MEDIA , MOBILE , RESTAURANT , RETAIL , TECHNOLOGY , TRAVEL , OTHER |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY
Respuesta de ejemplo
DELETE accounts/:account_id
Nota: SOLO EN SANDBOX Elimina una cuenta de anuncios en el entorno de sandbox. Resource URLhttps://ads-api-sandbox.x.com/12/accounts/:account_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 |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh
Example Response
Apps de la cuenta
GET account_apps
Recupera los detalles de todas las apps móviles asociadas con la cuenta publicitaria especificada. Resource URLhttps://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 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 |
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 la solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluye el atributo de la respuesta total_count . Note: Este parámetro y cursor son excluyentes. Note: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps
Example Response
Historial de la cuenta
GET accounts/:account_id/account_history
Recupera un resumen de los cambios realizados en elentity_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 recuperarán los 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 recuperarán los datos. Type: string Example: 8u94t |
start_time required | Delimita los datos recuperados al tiempo de inicio especificado, expresado en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Type: string Example: 2017-05-19T07:00:00Z |
end_time required | Delimita los datos recuperados al tiempo de finalización especificado, expresado en ISO 8601. Nota: Debe expresarse en horas completas (0 minutos y 0 segundos). Type: string Example: 2017-05-26T07:00:00Z |
user_id optional | Delimita la respuesta a un usuario específico. Type: long Example: 3271358660 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1
Example Response
Categorías empresariales del anunciante
GET advertiser_business_categories
Solicite lascategories
de negocio válidas para anunciantes en Grupos de anuncios (line_items
) para describir la marca del anunciante a los editores.
Nota: Estas categorías se aplican solo a los line_items
con el objetivo PREROLL_VIEWS
y son independientes de las content_categories
utilizadas para los criterios de segmentación.
Cada advertiser_business_categories
representa una colección de IAB Categories. Al crear un Grupo de anuncios con el objetivo PREROLL_VIEWS
, se debe configurar una o dos advertiser_business_categories
para el Grupo de anuncios. Esto puede hacerse asignando el valor del parámetro de solicitud categories
en el endpoint de line item al conjunto de iab_categories
correspondientes disponibles a través de este endpoint.
Puede encontrar más detalles en la Guía del objetivo 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
Estimación de audiencia
Determine el tamaño aproximado de la audiencia de tus campañas.
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
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 |
targeting_criteria required | Un objeto JSON que contiene todos los parámetros de los objetos de criterios de segmentación. Una lista de parámetros obligatorios y opcionales está disponible en el endpoint POST accounts/:account_id/targeting_criteria. |
operator_type optional | Especifica la relación que debe tener el criterio de segmentación. Por ejemplo, para aplicar segmentación negada, usa operator_type=NE .Type: enum Possible values: EQ , NE Default: EQ |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate
Acceso de usuario autenticado
GET accounts/:account_id/authenticated_user_access
Recupera los permisos del usuario autenticado actualmente (access_token) en relación con la cuenta de anuncios especificada. Estos permisos coinciden con los que se muestran en ads.x.com. Los posibles valores incluyen:ACCOUNT_ADMIN
: Acceso completo para modificar campañas y ver estadísticas, incluida la capacidad de agregar o eliminar usuarios y cambiar la configuraciónAD_MANAGER
: Acceso completo para modificar campañas y ver estadísticas, pero sin posibilidad de agregar o eliminar usuarios ni cambiar la configuraciónCREATIVE_MANAGER
: Acceso para modificar creatividades y ver vistas previas, pero sin acceso para crear o modificar campañasCAMPAIGN_ANALYST
: Acceso para ver campañas y estadísticas, pero sin acceso para crear o modificar campañasANALYST
(“Organic Analyst” en ads.x.com): Acceso para ver analíticas orgánicas e insights de audiencia, pero sin acceso para crear, modificar o ver campañasPARTNER_AUDIENCE_MANAGER
: Acceso solo mediante API para ver y modificar audiencias de socios de datos, pero sin acceso a campañas, creatividades u otros tipos de audiencia.
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
Ninguno
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access
Example Response
Reglas de puja
GET bidding_rules
Recupere las reglas de puja para algunas o todas las divisas. La respuesta indicará las pujas CPE (costo por interacción) mínimas y máximas. Aunque estas reglas de puja cambian rara vez, se sugiere que sus sistemas se actualicen desde estos endpoints al menos mensualmente. Resource URLhttps://ads-api.x.com/12/bidding_rules
Parameters
Nombre | Descripción |
---|---|
currency opcional | Tipo de divisa por el que filtrar los resultados, identificado mediante ISO-4217. Es una cadena de tres letras, por ejemplo, “USD” o “EUR”. Omita este parámetro para recuperar todas las reglas de puja. Type: string Example: USD |
GET https://ads-api.x.com/12/bidding_rules?currency=USD
Example Response
Campañas
GET accounts/:account_id/campaigns
Recupera los detalles de algunas o todas las campañas asociadas con la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns
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 las campañas deseadas especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 8wku2 |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. 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 las campañas bajo instrumentos de financiación específicos especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: lygyi |
q optional | Una query opcional para filtrar el recurso por name .Type: string Min, Max length: 1 , 255 |
sort_by optional | Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para 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 .Note: Este parámetro y cursor son excluyentes.Note: Las solicitudes que incluyan total_count tendrán límites de velocidad más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2
Example Response
GET accounts/:account_id/campaigns/:campaign_id
Recupera una campaña específica asociada a la cuenta actual. URL del recursohttps://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_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 API de anunciantes, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
campaign_id obligatorio | Referencia a la campaña con la que se opera en la solicitud. Type: string Example: 8wku2 |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2
Ejemplo de respuesta
POST accounts/:account_id/campaigns
Crea una nueva campaña asociada con la cuenta actual. Nota: Existe un límite predeterminado de 200 campañas activas por cuenta. Sin embargo, no hay límite en la cantidad de campañas inactivas. Este límite puede aumentarse a 8,000 campañas activas. Para habilitar el límite superior, el anunciante debe solicitarlo a su X Account Manager. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns
Parameters
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. Type: string Example: 18ce54d4x5t |
funding_instrument_id obligatorio | El identificador del instrumento de financiación bajo el cual se creará la campaña. Type: string Example: lygyi |
name obligatorio | El nombre de la campaña. Longitud máxima: 255 caracteres. Type: string Example: demo |
budget_optimization opcional | 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 a veces obligatorio | El monto del presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. 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 instrumentos de financiación.Type: long Example: 5500000 |
entity_status opcional | El estado de la campaña. Type: enum Default: ACTIVE Possible values: ACTIVE , DRAFT , PAUSED |
purchase_order_number opcional | El número de referencia de la reserva. Usa este campo para ayudar con la conciliación de facturas. Longitud máxima: 50 caracteres. Type: string Example: D00805843 |
standard_delivery opcional | Habilita la entrega estándar o acelerada. Consulta Budget Pacing para obtener más información sobre la entrega estándar frente a la acelerada. Solo disponible cuando budget_optimization está establecido en CAMPAIGN .Type: boolean Default: true Possible values: true , false |
total_budget_amount_local_micro opcional | 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. Type: long Example: 37500000 |
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
POST batch/accounts/:account_id/campaigns
Permite crear nuevas campañas en lote 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
deapplication/json
. - Las solicitudes por lotes fallan o se completan correctamente juntas como un grupo, y todas las respuestas de la API, tanto de error como de éxito, preservan el orden de los elementos de la solicitud inicial.
- Los errores a nivel de solicitud (p. ej., tamaño máximo de lote excedido) se muestran en la respuesta bajo el objeto
errors
. - Los errores a nivel de elemento (p. ej., falta un parámetro obligatorio de la campaña) se muestran en la respuesta bajo el objeto
operation_errors
.
https://ads-api.x.com/12/batch/accounts/:account_id/campaigns
Parameters
Name | Description |
---|---|
operation_type required | El tipo de operación por elemento que se está realizando. Type: enum Valores posibles: Create , Delete , Update |
params required | Un 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í. |
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns
PUT accounts/:account_id/campaigns/:campaign_id
Actualiza la campaña especificada asociada a la cuenta actual. Resource URLhttps://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 opera en la solicitud. Type: string Example: 8wku2 |
budget_optimization optional | Seleccione 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 del presupuesto diario que se asignará a la campaña. Se usará la moneda asociada con el instrumento de financiamiento especificado. Para USD, 5,50 $ se representa como 5500000. Si no se proporciona, la campaña gastará de manera uniforme según el presupuesto total y durante todo el 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. Use este campo para facilitar la conciliación de facturas. Longitud máxima: 50 caracteres. Type: string Example: D00805843 |
standard_delivery optional | Habilite la entrega estándar o acelerada. Consulte 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 del presupuesto que se asignará a la campaña. Se usará la moneda asociada con el instrumento de financiamiento especificado. Para USD, 37,50 $ se representa como 37500000. Type: long Example: 140000000 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000
Example Response
DELETE accounts/:account_id/campaigns/:campaign_id
Elimina la campaña especificada que pertenece a la cuenta actual. Nota: Eliminar una campaña es irreversible y los intentos posteriores de eliminar el recurso devolverán HTTP 404. URL del recursohttps://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
Parámetros
Name | Description |
---|---|
account_id obligatorio | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
campaign_id obligatorio | Referencia a la campaña con la que se opera en la solicitud. Type: string Example: 8yn7m |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m
Ejemplo de respuesta
Categorías de contenido
GET content_categories
Solicita lascategories
de contenido válidas que deben establecerse como targeting_criteria
para un line item.
Cada content_category
se asigna a una o más IAB Categories. Esto se puede lograr configurando 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 para cada una de estas categorías de contenido se pueden obtener con el endpoint GET publishers.
Puedes encontrar más detalles en la Guía del objetivo de pre-roll de Video Views.
Resource URL
https://ads-api.x.com/12/content_categories
Parameters
Sin parámetros de solicitud
Example Request
GET https://ads-api.x.com/12/content_categories
Example Response
Categorías seleccionadas
GET accounts/:account_id/curated_categories
Recupera una lista de Curated Categories disponibles para loscountry_codes
especificados.
Cada curated_category
solo está disponible en países específicos indicados por los country_codes
en la respuesta.
Encontrarás más detalles en la Guía del objetivo de Video Views Pre-roll.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/curated_categories
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. 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 siguiente página de resultados. Consulta Pagination para más información. Type: string Example: 8x7v00oow |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US
Example Response
GET accounts/:account_id/curated_categories/:curated_category_id
Recupere los detalles de uncurated_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 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. Type: string Example: 18ce54d4x5t |
curated_category_id required | Referencia a la Curated Category con la que está operando en la solicitud. Type: string Example: 9ddrgesiap6o |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o
Example Response
Características
GET accounts/:account_id/features
Recupera la colección de funcionalidades concedidas a las que puede acceder esta cuenta de anuncios. Las funcionalidades se indican mediante una clave de funcionalidad descriptiva y solo se exponen en este endpoint si se introducen en beta o en un lanzamiento limitado y están disponibles en la X Ads API. Las funcionalidades que no cumplan estos criterios no se expondrán en este endpoint. Nota: Este endpoint ayuda al desarrollo del ecosistema de la X Ads API al mejorar la visibilidad del acceso de los clientes a versiones beta. Los desarrolladores de la API no pueden solicitar acceso a funcionalidades en nombre de un anunciante. Estas solicitudes solo las puede realizar el anunciante a su gestor de cuenta de X. Resource URLhttps://ads-api.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 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. Nota: Solo las funcionalidades a las que esta cuenta tenga acceso se incluirán en la respuesta. Type: enum Possible values: REACH_AND_FREQUENCY_ANALYTICS , REACH_FREQUENCY_CAP , WEBSITE_CLICKS_CPM_BILLING |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features
Example Response
POST accounts/:account_id/features
SOLO SANDBOX Agregar 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 URLhttps://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 agregar 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 |
POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING
Example Response
DELETE accounts/:account_id/features
SOLO SANDBOX Quita una función de una cuenta de sandbox. La lista más reciente de funciones de la cuenta puede recuperarse mediante el endpoint GET accounts/:account_id/features. URL del recursohttps://ads-api-sandbox.x.com/12/accounts/:account_id/features
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. Type: string Example: gq180y |
feature_keys obligatorio | Una lista de funciones de la cuenta, separadas por comas, que se quitarán de 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 |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE
Respuesta de ejemplo
Instrumentos de financiación
GET accounts/:account_id/funding_instruments
Recupera los detalles de algunos o todos los instrumentos de financiación asociados a la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/funding_instruments
Parameters
Name | Description |
---|---|
account_id required | 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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para 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 id. Type: string Example: lygyi |
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 la solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments
Example Response
GET accounts/:account_id/funding_instruments/:funding_instrument_id
Recupera un instrumento de financiación específico asociado a la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id
Parameters
Name | Description |
---|---|
account_id required | El identificador de la cuenta con capacidad de 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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
funding_instrument_id required | Referencia al instrumento de financiación con el que se opera en la solicitud. Type: string Example: lygyi |
with_deleted optional | Incluir resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi
Example Response
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 costos al usar un instrumento de financiación de sandbox. URL del recursohttps://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta apalancada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: gq1844 |
currency obligatorio | La moneda, expresada en ISO-4217. Type: string Example: USD |
start_time obligatorio | La fecha en la que el instrumento de financiación se volverá activo y utilizable, expresada en ISO 8601. Type: string Example: 2017-05-19T07:00:00Z |
type obligatorio | El tipo de instrumento de financiación que se va a crear. Type: enum Possible values: AGENCY_CREDIT_LINE , CREDIT_CARD , CREDIT_LINE , INSERTION_ORDER , PARTNER_MANAGED |
end_time a veces obligatorio | La fecha en la que el instrumento de financiación dejará de estar activo, expresada en ISO 8601. Type: string Example: 2017-05-26T07:00:00Z |
credit_limit_local_micro opcional | El crédito total disponible para este instrumento de financiación. Nota: Solo aplicable a algunos tipos de instrumentos de financiación. Type: long Example: 37500000 |
funded_amount_local_micro opcional | El monto total del presupuesto asignado a este instrumento de financiación. Nota: Solo aplicable a algunos tipos de instrumentos de financiación. Type: long Example: 37500000 |
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
Ejemplo de respuesta
DELETE accounts/:account_id/funding_instruments/:funding_instrument_id
SOLO SANDBOX Elimina un instrumento de financiación en el entorno de sandbox. URL del recursohttps://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | 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 API de Anunciantes, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Type: string Example: gq1844 |
funding_instrument_id obligatorio | Referencia al instrumento de financiación con el que opera en la solicitud. Type: string Example: hxt82 |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82
Ejemplo de respuesta
Categorías de IAB
GET iab_categories
Solicita lascategories
de App válidas 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 que se intentará recuperar por cada solicitud. Type: 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. Type: string Ejemplo: gc-ddf4a |
with_total_count opcional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son mutuamente excluyentes.Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Predeterminado: false Valores posibles: true , false |
GET https://ads-api.x.com/12/iab_categories?count=2
Ejemplo de respuesta
Elementos de línea
GET accounts/:account_id/line_items
Recupera los detalles de algunos o de todos los line items asociados con la cuenta actual. Resource URLhttps://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 line items de campañas específicas especificando 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 line items de instrumentos de financiamiento específicos especificando 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 line items deseados especificando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 8v7jo |
q optional | Una query opcional para limitar el recurso por name .Type: string Min, Max length: 1 , 255 |
sort_by optional | Ordena por un atributo compatible en orden ascendente o descendente. Consulta Sorting para 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_draft optional | Incluye resultados de campañas en borrador en la solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx
Example Response
GET accounts/:account_id/line_items/:line_item_id
Recupera un elemento de línea específico asociado a la cuenta actual. URL del recursohttps://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 está operando en la solicitud. Tipo: string Ejemplo: 8v7jo |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Tipo: boolean Valor predeterminado: false Valores posibles: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx
Ejemplo de respuesta
POST accounts/:account_id/line_items
Crea un elemento de línea asociado a la campaña especificada que pertenece a la cuenta actual. Todos los elementos de línea de una campaña deben tener el mismoproduct_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
.
Definir android_app_store_identifier
o ios_app_store_identifier
añadirá automáticamente los criterios de segmentación para el elemento de línea que coincida con la app móvil que se está promocionando; por ejemplo, proporcionar ios_app_store_identifier
añadiría criterios de segmentación 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.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/line_items
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la API de Advertiser, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
campaign_id obligatorio | El identificador de la campaña bajo la cual crear el elemento de línea. Tipo: string Ejemplo: 8slvg |
end_time obligatorio | La hora, expresada en ISO 8601, en que el elemento de línea dejará de servirse. Tipo: string Ejemplo: 2017-10-05T00:00:00Z |
objective obligatorio | El objetivo de campaña para este elemento de línea. Tipo: enum Valores posibles: APP_ENGAGEMENTS , APP_INSTALLS , REACH , FOLLOWERS , ENGAGEMENTS , VIDEO_VIEWS , PREROLL_VIEWS , WEBSITE_CLICKS |
placements obligatorio | Las ubicaciones de colocación donde este elemento de línea se mostrará. Especifique una lista separada por comas de valores de colocación. Tipo: enum Valores posibles: ALL_ON_TWITTER , PUBLISHER_NETWORK , TAP_BANNER , TAP_FULL , TAP_FULL_LANDSCAPE , TAP_NATIVE , TAP_MRECT ,TWITTER_PROFILE , TWITTER_REPLIES , TWITTER_SEARCH , TWITTER_TIMELINE |
product_type obligatorio | El tipo de producto promocionado que contendrá este elemento de línea. Tipo: enum Valores posibles: MEDIA , PROMOTED_ACCOUNT , PROMOTED_TWEETS |
start_time obligatorio | La hora, expresada en ISO 8601, en que el elemento de línea comenzará a servirse. Tipo: string Ejemplo: 2017-07-05T00:00:00Z |
advertiser_domain a veces obligatorio | El dominio del sitio web para este anunciante, sin la especificación del protocolo. Nota: Obligatorio cuando la colocación del elemento de línea está configurada como PUBLISHER_NETWORK .Tipo: string Ejemplo: x.com |
android_app_store_identifier a veces obligatorio | El identificador de Google App Store para aplicaciones promocionadas. Nota: Los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren configurar al menos un identificador de tienda de aplicaciones: android_app_store_identifier o ios_app_store_identifier .Tipo: string Ejemplo: com.twitter.android |
bid_amount_local_micro a veces obligatorio | El monto de puja que se asociará con este elemento de línea. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $5.50 se representa como 5500000. Nota: Obligatorio si bid_strategy está configurado como MAX o TARGET Nota: Solo se aceptan valores mayores que cero. Tipo: long Ejemplo: 5500000 |
categories a veces obligatorio | Las categorías IAB relevantes para este anunciante. Consulte GET iab_categories. Nota: Obligatorio cuando la colocación del elemento de línea está configurada como PUBLISHER_NETWORK .Tipo: string Ejemplo: IAB3-1 |
ios_app_store_identifier a veces obligatorio | La porción numérica del identificador de Apple App Store para aplicaciones promocionadas. Nota: Los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren configurar al menos un identificador de tienda de aplicaciones: android_app_store_identifier o ios_app_store_identifier .Tipo: string Ejemplo: 333903271 |
primary_web_event_tag a veces obligatorio | El identificador de la etiqueta de evento web principal. Permite un seguimiento más preciso de las interacciones para la campaña relacionada con este elemento de línea. Nota: Obligatorio cuando el objetivo del elemento de línea está configurado como WEBSITE_CONVERSIONS .Tipo: string Ejemplo: nvo4z |
advertiser_user_id opcional | El identificador de usuario de X para el handle que promociona un anuncio PREROLL_VIEWS . Solo ciertas aplicaciones cliente pueden usar este parámetro.Tipo: string Ejemplo: 312226591 |
audience_expansion opcional | Se utiliza para expandir el alcance de las campañas dirigiéndose a usuarios similares a los ya segmentados. Nota: Por defecto, no se aplicará expansión. Tipo: enum Valores posibles: BROAD , DEFINED , EXPANDED |
bid_strategy opcional | El mecanismo de puja.AUTO optimiza automáticamente las pujas basándose en el presupuesto diario y las fechas de duración de la campaña.MAX establece la puja máxima permitida y no está disponible cuando el objetivo está configurado como REACH o FOLLOWERS .TARGET intenta mantener los promedios de puja diarios dentro del 20% del bid_amount_local_micro especificado y está disponible cuando el objetivo está configurado como REACH , FOLLOWERS o WEBSITE_CLICKS .Nota: Si se configura como AUTO , bid_amount_local_micro será ignorado.Nota: Valor por defecto basado en el objetivo. Tipo: enum Valores posibles: AUTO , MAX , TARGET |
duration_in_days opcional | El período de tiempo dentro del cual se alcanza el frequency_cap .Tipo: int Valores posibles: 1 , 7 , 30 |
entity_status opcional | El estado del elemento de línea. Tipo: enum Por defecto: ACTIVE Valores posibles: ACTIVE , DRAFT , PAUSED |
frequency_cap opcional | El número máximo de veces que un anuncio puede ser entregado a un usuario. Nota: Solo compatible con los objetivos REACH , ENGAGEMENTS , VIDEO_VIEWS y PREROLL_VIEWS .Tipo: int Ejemplo: 5 |
goal opcional | La configuración de optimización a usar con este elemento de línea. La opción APP_PURCHASES está disponible para APP_INSTALL . Las opciones APP_CLICKS y APP_INSTALLS están disponibles tanto para los objetivos APP_INSTALL como APP_ENGAGEMENTS y pueden requerir usar un socio MACT compatible.La opción SITE_VISITS solo está disponible con el objetivo WEBSITE_CLICKS .Nota: Valor por defecto basado en el objetivo. Tipo: enum Valores posibles: APP_CLICKS , APP_INSTALLS , APP_PURCHASES ,ENGAGEMENT , FOLLOWERS , LINK_CLICKS , MAX_REACH , PREROLL , PREROLL_STARTS , REACH_WITH_ENGAGEMENT , SITE_VISITS , VIDEO_VIEW , VIEW_3S_100PCT , VIEW_6S , VIEW_15S , WEBSITE_CONVERSIONS |
name opcional | El nombre para el elemento de línea. Tipo: string Ejemplo: demo Longitud mín., máx.: 1 , 255 |
pay_by opcional | La unidad por la cual se cobra este elemento de línea. Esta configuración solo puede modificarse para elementos de línea que utilicen el objetivo APP_INSTALLS .Nota: El pay_by predeterminado se establece automáticamente basado en el objetivo de la campaña y la unidad de puja del elemento de línea.El objetivo APP_INSTALLS admite tanto valores APP_CLICK como IMPRESSION . IMPRESSION es el valor predeterminado.El objetivo LINK_CLICKS admite tanto valores LINK_CLICK como IMPRESSION . IMPRESSION es el valor predeterminado pero no es compatible al establecer TARGET para bid_strategy .El objetivo SITE_VISITS admite valores IMPRESSION .Tipo: enum Valores posibles: APP_CLICK , IMPRESSION , LINK_CLICK |
standard_delivery opcional | Habilita la entrega estándar o acelerada. Consulta Ritmo de Presupuesto para obtener más información sobre la entrega estándar versus acelerada. Solo disponible cuando budget_optimization está establecido en LINE_ITEM para la campaña principalTipo: boolean Predeterminado: true Valores posibles: true , false |
total_budget_amount_local_micro opcional | El monto total del presupuesto que se asignará al elemento de línea. Se utilizará la moneda asociada con el instrumento de financiamiento especificado. Para USD, $37.50 se representa como 37500000. Tipo: long Ejemplo: 37500000 |
daily_budget_amount_local_micro a veces requerido | El monto 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 proporciona, la campaña gastará de manera uniforme basándose en el presupuesto total y la duración del tiempo de vuelo de la campaña. Solo disponible cuando budget_optimization está establecido en LINE_ITEM para la campaña principalNota: Este valor debe ser menor o igual que total_budget_amount_local_micro .Tipo: long Ejemplo: 5500000 |
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
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
deapplication/json
. - Las solicitudes por lotes fallan o se completan correctamente en conjunto como grupo, y todas las respuestas de la API, tanto en caso de error como de éxito, preservan el orden de los elementos de la solicitud inicial.
- Los errores a nivel de solicitud (p. ej., tamaño máximo de lote excedido) se muestran en la respuesta bajo el objeto
errors
. - Los errores a nivel de elemento (p. ej., falta un parámetro obligatorio del line item) se muestran en la respuesta bajo el objeto
operation_errors
.
https://ads-api.x.com/12/batch/accounts/:account_id/line_items
Parámetros
Nombre | Descripción |
---|---|
operation_type obligatorio | El tipo de operación por elemento que se está realizando. Type: enum Valores posibles: Create , Delete , Update |
params obligatorio | Un objeto JSON que contiene todos los parámetros de los objetos de line item. Para obtener la lista de parámetros obligatorios y opcionales de line item, consulte aquí. |
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items
PUT accounts/:account_id/line_items/:line_item_id
Actualiza el ítem de línea especificado asociado a la cuenta actual. URL del recursohttps://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Parámetros
Nombre | Descripción |
---|---|
account_id requerido | El identificador de la cuenta utilizada. Aparece dentro de la ruta del recurso y generalmente es un parámetro requerido para todas las solicitudes de la API de Anunciante, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
line_item_id requerido | Una referencia al elemento de línea con el que estás operando en la solicitud. Tipo: string Ejemplo: 8v7jo |
advertiser_domain opcional | El dominio del sitio web para este anunciante, sin la especificación del protocolo. Nota: Requerido cuando la ubicación del elemento de línea está configurada como PUBLISHER_NETWORK .Tipo: string Ejemplo: x.com |
advertiser_user_id opcional | El identificador de usuario de X para el handle que promociona un anuncio PREROLL_VIEWS . Solo ciertas aplicaciones cliente pueden usar este parámetro.Tipo: string Ejemplo: 312226591 |
android_app_store_identifier opcional | El identificador de Google Play Store para la aplicación promocionada. Nota: Los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren configurar al menos un identificador de tienda de aplicaciones — ya sea android_app_store_identifier o ios_app_store_identifier .Tipo: string Ejemplo: com.twitter.android |
audience_expansion opcional | Se utiliza para expandir el alcance de las campañas dirigiéndose a usuarios similares a los ya segmentados. Tipo: enum Valores posibles: BROAD , DEFINED , EXPANDED |
bid_amount_local_micro opcional | El monto de puja que se asociará con este elemento de línea. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $5.50 se representa como 5500000. Nota: Requerido si bid_strategy está configurado como MAX o TARGET Nota: Solo se aceptan valores mayores que cero. Tipo: long Ejemplo: 140000 |
bid_strategy opcional | El mecanismo de puja.AUTO optimiza automáticamente las pujas basándose en el presupuesto diario y las fechas de duración de la campaña.MAX establece la puja máxima permitida y no está disponible cuando el objetivo está configurado como REACH o FOLLOWERS .TARGET intenta mantener los promedios de puja diarios dentro del 20% del bid_amount_local_micro especificado y está disponible cuando el objetivo está configurado como REACH o WEBSITE_CLICKS .Nota: Si se configura como AUTO , bid_amount_local_micro será ignorado.Nota: Valor predeterminado basado en el objetivo. Tipo: enum Valores posibles: AUTO , MAX , TARGET |
categories opcional | Las categorías IAB relevantes para este anunciante. Ver GET iab_categories. Nota: Requerido cuando la ubicación del elemento de línea está configurada como PUBLISHER_NETWORK .Tipo: string Ejemplo: IAB3-1 |
duration_in_days opcional | El período de tiempo dentro del cual se alcanza el frequency_cap .Tipo: int Valores posibles: 1 , 7 , 30 |
entity_status opcional | El estado del elemento de línea. Tipo: enum Valores posibles: ACTIVE , PAUSED |
end_time opcional | La hora, expresada en ISO 8601, en que el elemento de línea dejará de servirse. Tipo: string Ejemplo: 2017-10-05T00:00:00Z |
frequency_cap opcional | El número máximo de veces que un anuncio puede ser entregado a un usuario. Nota: Solo compatible con los objetivos REACH , ENGAGEMENTS , VIDEO_VIEWS y PREROLL_VIEWS .Tipo: int Ejemplo: 5 |
goal opcional | La configuración de optimización a usar con este elemento de línea. La opción APP_PURCHASES está disponible para APP_INSTALL . Las opciones APP_CLICKS y APP_INSTALLS están disponibles para APP_INSTALL y APP_ENGAGEMENTS y pueden requerir usar un socio MACT compatible.Nota: Valor predeterminado basado en el objetivo. Tipo: enum Valores posibles: APP_CLICKS , APP_INSTALLS , APP_PURCHASES , ENGAGEMENT , FOLLOWERS , LINK_CLICKS , MAX_REACH , PREROLL , PREROLL_STARTS , REACH_WITH_ENGAGEMENT , VIDEO_VIEW , VIEW_3S_100PCT , VIEW_6S , VIEW_15S , WEBSITE_CONVERSIONS |
ios_app_store_identifier opcional | La porción numérica del identificador de Apple App Store para aplicaciones promocionadas. Nota: Los objetivos APP_INSTALLS y APP_ENGAGEMENTS requieren configurar al menos un identificador de tienda de aplicaciones — ya sea android_app_store_identifier o ios_app_store_identifier .Tipo: string Ejemplo: 333903271 |
name opcional | El nombre para el elemento de línea. Tipo: string Ejemplo: demo |
pay_by opcional | La unidad por la cual cobrar este elemento de línea. Esta configuración solo puede modificarse para elementos de línea que usan el objetivo APP_INSTALLS .Nota: El pay_by predeterminado se configura automáticamente basándose en el objetivo de la campaña y la unidad de puja del elemento de línea.El objetivo APP_INSTALLS admite tanto valores APP_CLICK como IMPRESSION . IMPRESSION es el valor predeterminado.El objetivo LINK_CLICKS admite tanto valores LINK_CLICK como IMPRESSION . IMPRESSION es el valor predeterminado pero no es compatible cuando se configura TARGET para bid_strategy .El objetivo SITE_VISITS admite valores IMPRESSION .Tipo: enum Valores posibles: APP_CLICK , IMPRESSION , LINK_CLICK |
start_time opcional | La hora, expresada en ISO 8601, en que el elemento de línea comenzará a servirse. Tipo: string Ejemplo: 2017-07-05T00:00:00Z |
total_budget_amount_local_micro opcional | El monto total del presupuesto que se asignará al elemento de línea. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $37.50 se representa como 37500000. Tipo: long Ejemplo: 37500000 |
daily_budget_amount_local_micro opcional | El monto del presupuesto diario que se asignará a la campaña. Se utilizará la moneda asociada con el instrumento de financiación especificado. Para USD, $5.50 se representa como 5500000. Cuando no se proporciona, la campaña gastará de manera uniforme basándose en el presupuesto total y la duración del período de la campaña. Solo disponible cuando budget_optimization está configurado como LINE_ITEM para la campaña padreNota: Esto debe ser menor o igual que el total_budget_amount_local_micro .Tipo: long Ejemplo: 5500000 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000
Ejemplo de respuesta
DELETE accounts/:account_id/line_items/:line_item_id
Elimina el elemento de línea especificado perteneciente a 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 secundarios solo se devuelven en los endpoints GET accounts/:account_id/promoted_tweets y GET accounts/:account_id/promoted_tweets/:promoted_tweet_id si se especificawith_deleted=true
en la solicitud. Sin embargo, estos promoted_tweets no se eliminan realmente ("deleted": false
en la respuesta). No aplicamos eliminaciones en cascada.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Parameters
Name | Description |
---|---|
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. Type: string Example: 18ce54d4x5t |
line_item_id obligatorio | Una referencia al elemento de línea con el que se opera en la solicitud. Type: string Example: 9f2ix |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix
Example Response
Categorías seleccionadas de Line Item
GET accounts/:account_id/line_item_curated_categories
Recupera los detalles de algunas o todas las categorías seleccionadas de partidas asociadas a la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
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. Type: string Example: 18ce54d4x5t |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud individual. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para 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 los resultados eliminados en tu solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente fijados en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories
Example Response
GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Recupera los detalles de una categoría curada de ítem de línea específica asociada a la cuenta actual. URL del recursohttps://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 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 |
line_item_curated_category_id obligatorio | Referencia a la categoría curada del ítem de línea con la que se opera en la solicitud. Tipo: string Ejemplo: 43853bhii885 |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Tipo: boolean Predeterminado: false Valores posibles: true , false |
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav
Ejemplo de respuesta
POST accounts/:account_id/line_item_curated_categories
Asocia un objeto de curated category con el line item especificado. Resource URLhttps://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 |
curated_category_id required | Una referencia a la entidad curated category con la que opera la solicitud. Type: string Example: 10miy |
line_item_id required | Una referencia al line item con el que opera la solicitud. Type: string Example: 8v7jo |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o
Example Response
PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Actualiza la categoría seleccionada del elemento de línea especificado. URL del recursohttps://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 | Identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
line_item_curated_category_id obligatorio | Referencia a la categoría seleccionada del elemento de línea con la que opera en la solicitud. Type: string Example: 1bzq3 |
curated_category_id optional | Referencia a la entidad de categoría seleccionada con la que opera en la solicitud. Type: string Example: 10miy |
line_item_id optional | Referencia al elemento de línea con el que opera en la solicitud. Type: string Example: 8v7jo |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g
Ejemplo de respuesta
DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Elimina la categoría curada del elemento de línea especificada. URL del recursohttps://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 | 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 API de Advertiser, 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 curada del elemento de línea con la que se opera en la solicitud. Tipo: string Ejemplo: 1bzq3 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq
Ejemplo de respuesta
Ubicaciones de partidas
GET line_items/placements
Obtenga combinaciones válidas deplacement
y product_type
.
URL del recurso
https://ads-api.x.com/12/line_items/placements
Parámetros
Nombre | Descripción |
---|---|
product_type opcional | Limita la respuesta a las ubicaciones válidas para el tipo de producto especificado. Tipo: enum Valores posibles: MEDIA , PROMOTED_ACCOUNT , PROMOTED_TWEETS |
GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT
Respuesta de ejemplo
Creatividades de medios
GET accounts/:account_id/media_creatives
Recupera los detalles de algunos o de todos los media creatives asociados con la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/media_creatives
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, excluyendo GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
campaign_id optional | Limita la respuesta únicamente 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 únicamente a los media creatives asociados con los line items especificados, proporcionando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 8v7jo |
media_creative_ids optional | Limita la respuesta únicamente a los media creatives deseados, proporcionando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 1bzq3 |
sort_by optional | Ordena por un atributo admitido 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 su 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 tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3
Example Response
GET accounts/:account_id/media_creatives/:media_creative_id
Recupera los detalles de un creative de medios específico asociado a la cuenta actual. Resource URLhttps://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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
media_creative_id required | Una referencia al creative de medios con el que 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 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
Example Response
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 elcreative_type
de account media es PREROLL
) o anuncios de imagen (como BANNER
o INTERSTITIAL
) en Twitter Audience Platform.
Nota: Para agregar recursos multimedia al recurso Account Media, usa el endpoint POST accounts/:account_id/media_library.
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 |
account_media_id required | Una referencia a la entidad de account media con la que operas en la solicitud. Type: string Example: 10miy |
line_item_id required | Una referencia al elemento de línea con el que operas en la solicitud. Type: string Example: 8v7jo |
landing_url sometimes required | La URL del sitio web a la 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: Obligatorio cuando el objetivo del elemento de línea está configurado en WEBSITE_CLICKS .Type: string Example: https://blog.x.com/ |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy
Example Response
DELETE accounts/:account_id/media_creatives/:media_creative_id
Eliminar el recurso de media creative especificado perteneciente a la cuenta actual. Resource URLhttps://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 con el usuario autenticado. Type: string Example: 18ce54d4x5t |
media_creative_id required | Referencia al media creative con el que se opera en la solicitud. Type: string Example: 1bzq3 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
Example Response
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. Use GET users/lookup para obtener los datos de las cuentas de usuario identificadas poruser_id
en la respuesta.
Se devolverá un HTTP 400 si ninguno de los line items especificados está configurado para contener cuentas promocionadas.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
Parameters
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 a 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 solo a las cuentas promocionadas asociadas con los line items especificados, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 9bpb2 |
promoted_account_ids optional | Limita la respuesta solo a las cuentas promocionadas deseadas, indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 19pl2 |
sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulte Sorting para más información. Type: string Example: created_at-asc |
with_deleted optional | Incluye resultados eliminados en la respuesta. 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 tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2
Example Response
GET accounts/:account_id/promoted_accounts/:promoted_account_id
Recupera una referencia específica a una cuenta asociada a un elemento de línea dentro de la cuenta actual. URL del recursohttps://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 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_account_id obligatorio | Una referencia a la cuenta promocionada con la que opera en la solicitud. Type: string Example: 19pl2 |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
Ejemplo de respuesta
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, la solicitud se ignorará.
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 en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
line_item_id required | Referencia al elemento de línea con el que operas en la solicitud. Type: string Example: 9bpb2 |
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. Type: long Example: 756201191646691328 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328
Example Response
DELETE accounts/:account_id/promoted_accounts/:promoted_account_id
Desasocia una cuenta del elemento de línea especificado. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_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_account_id required | Identificador de la instancia de una Promoted Account asociada a un elemento de línea. Type: string Example: 19pl2 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
Example Response
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 detweet_id
de cada objeto promoted_tweets.
Nota: Cuando se eliminan las partidas principales, 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 | 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 los Tweets asociados con partidas específicas mediante 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 mediante 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 la solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyan total_count tendrán un límite de tasa más bajo, actualmente de 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo
Example Response
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 especificawith_deleted=true
en la solicitud. No obstante, estos promoted_tweets no están realmente eliminados ("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 obligatorio | Identificador de la cuenta empleada. 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 obligatorio | Referencia al Tweet promocionado con el que opera en la solicitud. Type: string Example: 1efwlo |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo
Example Response
POST accounts/:account_id/promoted_tweets
Asocia uno o más Tweets al ítem de línea especificado. No todos los Tweets son adecuados para promoción, según el objetivo de la campaña. Consulta Objective-based Campaigns para obtener más información. Al usar el tipo de productoPROMOTED_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) las entidades de Tweets promocionados.
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 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 | Referencia al ítem de línea con el que se opera en la solicitud. Type: string Example: 8v7jo |
tweet_ids required | Lista separada por comas de identificadores correspondientes a Tweets específicos. Se pueden proporcionar hasta 50 IDs. Type: long Example: 822333526255120384 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384
Example Response
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, “pausing” desde la interfaz desasociará el Tweet de su elemento de línea. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_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. 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 incluye en la ruta del recurso.Type: string Example: 1gp8a5 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5
Example Response
Usuarios aptos para promoción
GET accounts/:account_id/promotable_users
Recupere los detalles de algunos o de todos los usuarios promocionables asociados con la cuenta actual. El tipo de usuario promocionable puede serFULL
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 a X para que lo agreguen a su cuenta como usuario promocionable RETWEETS_ONLY
.
Siempre que los permisos estén configurados correctamente, puede realizar solicitudes a los endpoints de productos promocionados que hacen referencia directa al ID del Tweet que desea promocionar. Puede usar el endpoint POST accounts/:account_id/promoted-tweets para promocionar Tweets publicados y el endpoint POST accounts/:account_id/scheduled-promoted-tweets para promocionar los Tweets programados de otra cuenta de X Ads.
No es necesario que haga Retweet del Tweet objetivo. Cuando promociona 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.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promotable_users
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 API de anunciantes, 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. Consulte Pagination para más información. Type: string Example: 8x7v00oow |
promotable_user_ids optional | Limite la respuesta a los usuarios promocionables deseados especificando una lista separada por comas de identificadores. Se pueden proporcionar hasta 200 IDs. Type: string Example: l310s |
sort_by optional | Ordena por un atributo admitido en orden ascendente o descendente. Consulte Sorting para más información. Type: string Example: created_at-asc |
with_deleted optional | Incluya resultados eliminados en su solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluya 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 tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s
Example Response
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 serFULL
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 directa al ID del Tweet que deseas promocionar.
No es necesario hacer Retweet del Tweet de destino. Cuando promocionas un Tweet con este enfoque, el tweet_id
devuelto será diferente del ID del Tweet que proporcionaste. En segundo plano, el Tweet se retuitea como un Tweet nullcasted 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 | 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 con el 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 resultados eliminados en la solicitud. Tipo: boolean Predeterminado: false Valores posibles: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s
Respuesta de ejemplo
Publicadores
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
Recomendaciones
GET accounts/:account_id/recommendations
Estado: Beta cerrada Recupera recomendaciones de campañas asociadas a esta cuenta de anuncios. Actualmente hay un límite de 1 recomendación por instrumento de financiación. Resource URLhttps://ads-api.x.com/5/accounts/:account_id/recommendations
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 |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations
Example Response
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 incluye un conjunto completo de cambios sugeridos para la estructura de la campaña, representada como un árbol de objetos. El árbol de la respuesta está diseñado para funcionar junto con los endpoints de la Batch API, pero también puede mapearse a endpoints de actualización individuales según corresponda (Create para POST, Update para PUT, Delete para DELETE). Resource URLhttps://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_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 |
recommendation_id required | Referencia al id de la recomendación con la que opera en la solicitud. Type: string Example: 62ce8zza1q0w |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w
Example Response
Tweets promocionados programados
GET accounts/:account_id/scheduled_promoted_tweets
Recupera los detalles de algunos o todos los Tweets promocionados programados asociados a la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
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. 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 |
line_item_ids optional | Limita la respuesta a los Tweets programados asociados con elementos de línea 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 resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
with_total_count optional | Incluye el atributo de respuesta total_count .Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyan total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq
Example Response
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 recursohttps://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
Parámetros
Nombre | Descripción |
---|---|
account_id obligatorio | El identificador de la cuenta utilizada. Aparece en la ruta del recurso y, por lo general, es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
scheduled_promoted_tweet_id obligatorio | Referencia al Tweet promocionado programado con el que se opera en la solicitud. Tipo: string Ejemplo: 1xboq |
with_deleted opcional | Incluir resultados eliminados en la solicitud. Tipo: boolean Predeterminado: false Valores posibles: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq
Ejemplo de respuesta
POST accounts/:account_id/scheduled_promoted_tweets
Asocia un Tweet programado con el elemento de línea especificado. Nota: No es posible actualizar (PUT) entidades de Tweet promocionado programado. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
Parameters
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 |
line_item_id obligatorio | Referencia al elemento de línea con el que opera en la solicitud. Tipo: string Ejemplo: 8xdpe |
scheduled_tweet_id obligatorio | Referencia al Tweet programado con el que opera en la solicitud. Tipo: long Ejemplo: 870358555227860992 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992
Example Response
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 con DELETE antes de la hora scheduled_at
del Tweet programado.
URL del recurso
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
Parámetros
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 API de Anunciantes, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
scheduled_promoted_tweet_id obligatorio | Una referencia al Tweet promocionado programado con el que opera en la solicitud. Es el atributo id de un objeto de respuesta de GET accounts/:account_id/scheduled_promoted_tweets.Tipo: string Ejemplo: 1xtfl |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl
Ejemplo de respuesta
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 del account actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/targeting_criteria
Parameters
Name | Description |
---|---|
account_id required | El identificador del account utilizado. 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. El account especificado debe estar asociado con el usuario autenticado. Type: string Example: 18ce54d4x5t |
line_item_ids required | Limita la respuesta únicamente a los criterios de segmentación de los line items especificados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: 8u94t |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 200 Min, Max: 1 , 1000 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Example: 8x7v00oow |
lang optional | Un código de idioma ISO-639-1. Cuando se proporciona, se devolverá un atributo adicional localized_name en la respuesta para los objetos con nombre localizado disponible.Type: string Example: fr |
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 |
targeting_criterion_ids optional | Limita la respuesta únicamente a los criterios de segmentación deseados indicando una lista de identificadores separados por comas. Se pueden proporcionar hasta 200 IDs. Type: string Example: dpl3a6 |
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 .Nota: Este parámetro y cursor son excluyentes.Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t
Example Response
GET accounts/:account_id/targeting_criteria/:targeting_criterion_id
Recupera un criterio de segmentación específico asociado a la cuenta actual. Resource URLhttps://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 se opera en la solicitud. Type: string Example: eijd4y |
lang optional | Código de idioma ISO-639-1. Si se incluye, se devolverá un atributo adicional localized_name en la respuesta para los objetos que dispongan de un nombre localizado.Type: string Example: fr |
with_deleted optional | Incluir resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y
Example Response
POST accounts/:account_id/targeting_criteria
Consulta la página Targeting Options para encontrartargeting_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 tipos de segmentación. Cambiamos los valores y los criterios de segmentación disponibles de vez en cuando; aunque la mayoría no cambia con frecuencia, algunos sí. No hay garantía de que estos valores no cambien.
Usa los tipos de segmentación BROAD_KEYWORD
, EXACT_KEYWORD
, PHRASE_KEYWORD
o UNORDERED_KEYWORD
con las palabras clave especificadas en targeting_value
. Excluye palabras clave usando el parámetro de solicitud operator_type
establecido en 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 Audiencia Personalizada, esa audiencia debe ser segmentable; es decir, targerable
debe ser igual a true
.
Nota: Al usar el tipo de segmentación TV_SHOW
, debe haber 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
segmentado.
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 dentro de la ruta del recurso y generalmente es un parámetro obligatorio para todas las solicitudes de la Advertiser API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
line_item_id required | Una 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. Posibles valores no basados en palabras clave: 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 AGE por elemento de línea.Posibles valores basados en palabras clave: BROAD_KEYWORD , EXACT_KEYWORD , PHRASE_KEYWORD , UNORDERED_KEYWORD Posibles valores de audiencia personalizada: CUSTOM_AUDIENCE , CUSTOM_AUDIENCE_EXPANDED Posibles valores de categoría de tienda de apps instalada: APP_STORE_CATEGORY , APP_STORE_CATEGORY_LOOKALIKE Posible exclusión de apps en Twitter Audience Platform (TAP): APP_LIST (solo puede usarse con 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, audiencia personalizada, 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 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology
Respuesta de ejemplo
POST batch/accounts/:account_id/targeting_criteria
Permite crear por lotes nuevos Targeting Criteria con una única 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
deapplication/json
. - Las solicitudes por lotes fallan o se completan juntas como grupo, y todas las respuestas de la API, tanto en caso de error como de éxito, preservan el orden de los elementos de la solicitud inicial.
- Los errores a nivel de solicitud (p. ej., tamaño máximo de lote excedido) se muestran en la respuesta en el objeto
errors
. - Los errores a nivel de elemento (p. ej., falta de un parámetro obligatorio de Targeting Criteria) se muestran en la respuesta en el objeto
operation_errors
.
https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria
Parameters
Name | Description |
---|---|
operation_type required | Tipo de operación por elemento que se está realizando. Type: enum Possible values: Create , Delete |
params required | Objeto JSON que contiene todos los parámetros de los objetos de targeting criteria. Para ver la lista de parámetros obligatorios y opcionales de targeting criteria, 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 para igual a, GTE para mayor o igual que, LT para menor que y NE para distinto de. |
POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria
DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id
Elimina el criterio de segmentación especificado que pertenece a la cuenta actual. URL del recursohttps://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
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 con el usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
targeting_criterion_id required | Referencia al criterio de segmentación con el que se opera en la solicitud. Tipo: string Ejemplo: dpl3a6 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6
Ejemplo de respuesta
Opciones de segmentación
- Categorías de App Store
- Conversaciones
- Dispositivos
- Eventos
- Intereses
- Idiomas
- Ubicaciones
- Operadores de red
- Versiones de la plataforma
- Plataformas
- Mercados de TV
- Programas de TV
GET targeting_criteria/app_store_categories
Descubra los criterios de segmentación disponibles basados en categorías de tiendas de apps para Productos Promocionados. Las categorías de tienda de apps están disponibles solo para App Store (iOS) y Google Play. La segmentación por categoría de apps instaladas permite orientar a los usuarios según las categorías de apps que han instalado o en las que han mostrado interés. Resource URLhttps://ads-api.x.com/12/targeting_criteria/app_store_categories
Parameters
Name | Description |
---|---|
q optional | Una query opcional para acotar un criterio de segmentación. Omita este parámetro para recuperar todo. Type: string Example: music |
os_type optional | Acote los resultados por una tienda de apps específica. Type: enum Possible values: ANDROID , IOS |
GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS
Example Response
GET targeting_criteria/conversations
Descubre los criterios de segmentación disponibles basados en conversaciones para los Productos Promocionados. Resource URLhttps://ads-api.x.com/12/targeting_criteria/conversations
Parameters
Name | Description |
---|---|
conversation_type optional | Parámetro query opcional para acotar a un tipo de conversación específico. Type: enum Valores posibles: ACTORS , ATHLETES , BOOK_GENRES , BOOKS , BRAND_CATEGORIES , BRANDS , CELEBRITIES , COACHES , DIGITAL_CREATORS , ENTERTAINMENT_BRANDS , ENTERTAINMENT_PERSONALITIES , FICTIONAL_CHARACTERS , JOURNALISTS , LIFESTYLES , MOVIE_GENRES , MOVIES , MUSIC_GENRES , MUSICIANS , NEWS_STORIES , NEWS , PERSONS , PLACES , PODCASTS , POLITICAL_AFFILIATIONS , POLITICIANS , PRODUCTS , RADIO_STATIONS , SPORTS_LEAGUES , SPORTS_PERSONALITIES , SPORTS_TEAMS , SPORTS , TRENDS , TV_SHOWS , VIDEO_GAME_PLATFORMS , VIDEO_GAME_PUBLISHERS , VIDEO_GAMES |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Predeterminado: 200 Mín., máx.: 1 , 1000 |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulta Pagination para más información. Type: string Ejemplo: 8x7v00oow |
GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2
Example Response
GET targeting_criteria/devices
Descubra los criterios de segmentación por dispositivo disponibles para Productos Promocionados. La segmentación por dispositivo está disponible para Tweets promocionados. Resource URLhttps://ads-api.x.com/12/targeting_criteria/devices
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 |
q optional | Parámetro query opcional para acotar un criterio de segmentación. Omita este parámetro para recuperar todos. Type: string Example: apple |
GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone
Example Response
GET targeting_criteria/events
Descubra los criterios de segmentación basados en eventos disponibles para los Productos Promocionados. Solo se puede segmentar un evento por cada línea de pedido. Nota: Los eventos suelen abarcar varias zonas horarias, lo que complica la consideración de sus horarios desde perspectivas entre zonas. Para simplificarlo, todos los valores destart_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 esta festividad abarque múltiples zonas horarias dentro de EE. UU.
Resource URL
https://ads-api.x.com/12/targeting_criteria/events
Parameters
Nombre | Descripción |
---|---|
event_types required | Una query opcional para acotar a ciertos tipos de eventos.Type: 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. Type: int Predeterminado: 200 Mín., máx.: 1 , 1000 |
country_codes optional | Una query opcional para acotar la búsqueda de criterios de segmentación a países específicos usando el código de país ISO de 2 letras. Si no se especifica este parámetro, se devuelven todos los eventos.Type: string |
cursor optional | Especifica un cursor para obtener la siguiente página de resultados. Consulte Pagination para más información. Type: string Ejemplo: 8x7v00oow |
end_time optional | La hora, expresada en ISO 8601, en la que finalizará la campaña. Type: 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. Type: string Ejemplo: 2017-07-05T00:00:00Z |
GET https://ads-api.x.com/12/targeting_criteria/events?count=1
Example Response
GET targeting_criteria/interests
Descubra los criterios de segmentación por intereses disponibles para Promoted Products. Los intereses cambian con poca frecuencia; no obstante, recomendamos actualizar esta lista al menos una vez por semana. Resource URLhttps://ads-api.x.com/12/targeting_criteria/interests
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 | Parámetro query opcional para delimitar un criterio de segmentación. Omita este parámetro para recuperar todos los resultados. Type: string Example: books |
GET https://ads-api.x.com/12/targeting_criteria/interests?q=books
Example Response
GET targeting_criteria/languages
Descubra los idiomas disponibles para segmentar. Resource URLhttps://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 individual. 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 | Parámetro query opcional para acotar el criterio de segmentación. Omita este parámetro para recuperar todos.Type: string Example: english |
GET https://ads-api.x.com/12/targeting_criteria/languages?q=english
Example Response
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. Se debe usar la segmentación por código postal si desea obtener analíticas a nivel de código postal. Nota: Para recuperar ciudades específicas segmentables, como San Francisco o Nueva York, use el enumCITIES
con el parámetro de solicitud location_type
.
Para segmentar Designated Market Areas (DMA), 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 | Una query opcional para limitar la búsqueda de criterios de segmentación a un país específico con el código ISO de país 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 página siguiente 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 | Una query opcional para acotar una búsqueda de criterios de segmentación. Omita este parámetro para obtener todos los resultados. Type: string Example: New York |
GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles
Example Response
GET targeting_criteria/network_operators
Descubra los criterios de segmentación disponibles basados en operadores de red para Promoted Products. Este endpoint le permite consultar operadores de telefonía móvil segmentables, como AT&T, Verizon, Sprint, T-Mobile, etc., en múltiples países. Resource URLhttps://ads-api.x.com/12/targeting_criteria/network_operators
Parameters
Name | Description |
---|---|
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud distinta. Type: int Default: 200 Min, Max: 1 , 1000 |
country_code optional | Un parámetro query opcional para acotar una búsqueda de criterios de segmentación a un país específico con el código ISO de 2 letras. Si no se especifica este parámetro, solo se devuelven audiencias de partners para Estados Unidos. Type: string Default: US |
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 | Un parámetro query opcional para acotar una búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados. Type: string Examples: Airpeak |
GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US
Example Response
GET targeting_criteria/platform_versions
Descubra los criterios de segmentación disponibles basados en versiones de sistemas operativos móviles para 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 de mantenimiento de un sistema operativo móvil, como Android 8.0 o iOS 10.0. Resource URLhttps://ads-api.x.com/12/targeting_criteria/platform_versions
Parameters
Name | Description |
---|---|
q optional | Una query opcional para acotar una búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados. Type: string Examples: jelly bean |
GET https://ads-api.x.com/12/targeting_criteria/platform_versions
Example Response
GET targeting_criteria/platforms
Descubra los criterios de segmentación disponibles basados en la plataforma para Promoted Products. Resource URLhttps://ads-api.x.com/12/targeting_criteria/platforms
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 |
q optional | Parámetro query opcional para acotar la búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados. Type: string Examples: ios , blackberry |
lang optional | Código de idioma ISO-639-1. Si se incluye, la respuesta devolverá un atributo adicional localized_name. Type: int, string Example: fr |
GET https://ads-api.x.com/12/targeting_criteria/platforms
Example Response
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. URL del recursohttps://ads-api.x.com/12/targeting_criteria/tv_markets
Parámetros
Ninguno
Ejemplo de solicitud
GET https://ads-api.x.com/12/targeting_criteria/tv_markets
Ejemplo de respuesta
GET targeting_criteria/tv_shows
Descubra 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. Consulte el endpoint GET targeting_criteria/tv_markets para conocer los mercados disponibles. Nota: Cualquier audiencia que contenga menos de 1,000 usuarios aparecerá con un valor deestimated_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
Nombre | Descripción |
---|---|
locale required | Parámetro obligatorio que especifica el tv_market_locale para consultar los programas de TV disponibles. Los mercados de TV se consultan según el locale devuelto por GET targeting_criteria/tv_markets.Type: string Example: en-US |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 50 Min, Max: 1 , 50 |
cursor optional | Especifica un cursor para obtener la página siguiente de resultados. Consulte Pagination para más información. Type: string Example: 8x7v00oow |
q optional | Parámetro query opcional para acotar una búsqueda de criterios de segmentación. Omita este parámetro para recuperar todos los resultados.Type: string Examples: ios , blackberry |
GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1
Example Response
Sugerencias de segmentación
GET accounts/:account_id/targeting_suggestions
Obtenga hasta 50 sugerencias de segmentación por palabras clave o por usuarios para complementar su selección inicial. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/targeting_suggestions
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 |
suggestion_type required | Especifique el tipo de sugerencias que se devolverán. Type: enum Possible values: KEYWORD , USER_ID |
targeting_values required | Conjunto separado por comas de palabras clave o ids de usuario usado para generar las sugerencias. Note: No se pueden mezclar estos dos tipos de sugerencias. Example: 756201191646691328 |
count optional | Especifica la cantidad de registros que se intentará recuperar por cada solicitud. Type: int Default: 30 Min, Max: 1 , 50 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"
Example Response
Configuración fiscal
GET accounts/:account_id/tax_settings
Recupera los detalles de la configuración fiscal asociados a la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/tax_settings
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 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings
Example Response
PUT accounts/:account_id/tax_settings
Actualiza la configuración fiscal de la cuenta actual. URL del recursohttps://ads-api.x.com/12/accounts/:account_id/tax_settings
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 API de Anunciantes, excepto GET accounts. La cuenta especificada debe estar asociada al usuario autenticado. Tipo: string Ejemplo: 18ce54d4x5t |
address_city optional | La ciudad de la dirección del titular de la cuenta. Tipo: string Ejemplo: San Francisco |
address_country optional | El código de país de dos letras de la dirección del titular de la cuenta. Tipo: string Ejemplo: US |
address_email optional | El correo electrónico asociado a la dirección del titular de la cuenta. Tipo: string Ejemplo: api@mctestface.com |
address_first_name optional | El nombre del titular de la cuenta para la dirección. Tipo: string Ejemplo: API |
address_last_name optional | El apellido del titular de la cuenta para la dirección. Tipo: string Ejemplo: McTestface |
address_name optional | El nombre de la empresa en la dirección del titular de la cuenta. Tipo: string Ejemplo: ABC, Co. |
address_postal_code optional | El código postal de la dirección del titular de la cuenta. Tipo: string Ejemplo: 94102 |
address_region optional | La región de la dirección del titular de la cuenta. Tipo: string Ejemplo: California |
address_street1 optional | La primera línea de la dirección (calle) del titular de la cuenta. Tipo: string Ejemplo: 21 March St |
address_street2 optional | La segunda línea de la dirección (calle) del titular de la cuenta. Tipo: string Ejemplo: Suite 99 |
bill_to optional | La entidad a la que se factura. Tipo: enum Valores posibles: ADVERTISER , AGENCY |
business_relationship optional | Indica si la cuenta es propiedad del anunciante o de la agencia. Tipo: enum Valores posibles: AGENCY , SELF |
client_address_city optional | La ciudad de la dirección del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: Toronto |
client_address_country optional | El código de país de dos letras de la dirección del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: CA |
client_address_email optional | El correo electrónico asociado a la dirección del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: ads@brand.com |
client_address_first_name optional | El nombre del anunciante para la dirección. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: Brand |
client_address_last_name optional | El apellido del anunciante para la dirección. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: Advertiser |
client_address_name optional | El nombre de la empresa en la dirección del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: Brand, Inc. |
client_address_postal_code optional | El código postal de la dirección del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: M5H 2N2 |
client_address_region optional | La región de la dirección del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: Ontario |
client_address_street1 optional | La primera línea de la dirección (calle) del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: 280 Queen St W |
client_address_street2 optional | La segunda línea de la dirección (calle) del anunciante. Establécelo cuando la cuenta de anuncios sea propiedad de una agencia. Tipo: string Ejemplo: The 6 |
invoice_jurisdiction optional | Jurisdicción de facturación. Tipo: enum Valores posibles: LOI_SAPIN , NONE , NOT_SET |
tax_category optional | Indica si la tributación debe ser individual o empresarial. Tipo: enum Valores posibles: BUSINESS_NO_VAT , BUSINESS_WITH_VAT , INDIVIDUAL |
tax_exemption_id optional | id de exención de IVA. Tipo: string Ejemplo: 12345 |
tax_id optional | id de registro de IVA. Tipo: string Valores posibles: 67890 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.
Ejemplo de respuesta
GET accounts/:account_id/tracking_tags
Recupera los detalles de algunas o todas las etiquetas de seguimiento asociadas a la cuenta actual. Resource URLhttps://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 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 |
line_item_ids optional | Limita la respuesta a las etiquetas de seguimiento asociadas a elementos de línea específicos 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 admitido 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 .Nota: Este parámetro y cursor son mutuamente excluyentes.Nota: Las solicitudes que incluyen total_count tendrán límites de tasa más bajos, actualmente establecidos en 200 por 15 minutos.Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82
Example Response
GET accounts/:account_id/tracking_tags/:tracking_tag_id
Recupera una etiqueta de seguimiento específica asociada a la cuenta actual. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_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 al usuario autenticado. Type: string Example: 18ce54d4x5t |
tracking_tag_id required | Referencia a la etiqueta de seguimiento con la que se opera en la solicitud. Type: string Example: 555j |
with_deleted optional | Incluye resultados eliminados en la solicitud. Type: boolean Default: false Possible values: true , false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
Example Response
POST accounts/:account_id/tracking_tags
Asocia una etiqueta de seguimiento con el elemento de línea especificado. URL del recursohttps://ads-api.x.com/12/accounts/:account_id/tracking_tags
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 |
line_item_id obligatorio | Una referencia al elemento de línea con el que está operando en la solicitud. Tipo: string Ejemplo: 8v7jo |
tracking_tag_type obligatorio | El tipo de etiqueta de seguimiento. Tipo: enum Valores posibles: IMPRESSION_TAG , CLICK_TRACKER |
tracking_tag_url obligatorio | La URL de la etiqueta de seguimiento proporcionada por el socio de seguimiento. Tipo: string Ejemplo: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 |
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
Ejemplo de respuesta
PUT accounts/:account_id/tracking_tags/:tracking_tag_id
Asocia una etiqueta de seguimiento con el elemento de línea especificado. URL del recursohttps://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 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 |
tracking_tag_url obligatorio | La URL de la etiqueta de seguimiento proporcionada por el socio de seguimiento. Tipo: string Ejemplo: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Ejemplo de respuesta
DELETE accounts/:account_id/tracking_tags/:tracking_tag_id
Desasocia una etiqueta de seguimiento del artículo de línea especificado. URL del recursohttps://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 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 |
tracking_tag_id obligatorio | Una referencia a la etiqueta de seguimiento con la que se está operando en la solicitud. Tipo: string Ejemplo: 555j |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
Respuesta de ejemplo
Configuración del usuario
GET accounts/:account_id/user_settings/:user_id
Recupera la configuración del usuario. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/user_settings/:user_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 Ads API, excepto GET accounts. La cuenta especificada debe estar asociada con el usuario autenticado. Type: string Example: 18ce54d4x5t |
user_id required | Una referencia al usuario con el que se opera en la solicitud. Use GET users/lookup para recuperar un id de usuario a partir de un screen name. Type: long Example: 756201191646691328 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328
Example Response
PUT accounts/:account_id/user_settings/:user_id
Actualiza la configuración del usuario. Requiere contexto de usuario. No está disponible para administradores de cuenta. URL del recursohttps://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 al 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 recuperar el id de un 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 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"
Ejemplo de respuesta