Skip to main content
Una Ad Campaign es el contenedor de nivel superior de los anuncios pagados. Define el objetivo y la estrategia de presupuesto que comparten sus grupos de anuncios y anuncios. Usa la API de Ad Campaigns para crear campañas, listar las campañas de una cuenta, obtener o actualizar la configuración de una campaña y pausar o reanudar la entrega de la campaña. La facturación de anuncios combina el gasto elegible de todas las campañas de la cuenta. Un pago fallido bloquea la entrega con delivery_status: payment_failed y conserva el status activo/en pausa configurado. Corrige el método de pago de la cuenta y reintenta su pago de anuncios una vez para la cuenta. El reintento es asíncrono: que se acepte no confirma el pago. Una liquidación exitosa elimina el bloqueo; las campañas activas pueden reanudarse si por lo demás son elegibles, mientras que las campañas en pausa siguen en pausa. Consulta facturación y reintentos.

Endpoints

Atributos

string
requerido
Identificador único de la campaña publicitaria, con el prefijo adcamp_.
object | null
requerido
El negocio que ejecuta esta campaña, con el nombre y el logo que muestran sus anuncios.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
string | null
requerido
URL de la imagen del logo de la cuenta. null cuando la cuenta no ha establecido uno.
string
requerido
Identificador de ruta pública de la cuenta, usado en la ruta de la tienda whop.com/\{route}.
string
requerido
Nombre visible de la cuenta.
number
requerido
Valor en USD atribuido a los eventos de añadir al carrito. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Eventos de añadir al carrito atribuidos por el píxel de Whop, último clic.
number | null
requerido
El presupuesto de la campaña en USD, la moneda en la que se almacena y se factura. null cuando cada grupo de anuncios establece su propio presupuesto.
number | null
requerido
El mismo presupuesto expresado en budget_currency al tipo de cambio de hoy, para mostrarlo en la moneda de informes de anuncios de la cuenta. null cuando budget_amount lo es.
string
requerido
El código ISO 4217 en el que está budget_amount_local: la preferencia ads_reporting_currency de la cuenta. usd a menos que la cuenta la haya cambiado.
string | null
requerido
Qué nivel posee el presupuesto: toda la campaña (ad_campaign) o cada grupo de anuncios por separado (ad_group).Opciones disponibles: ad_campaign, ad_group
string | null
requerido
Si budget_amount se gasta por día (daily) o durante toda la duración de la campaña (lifetime).Opciones disponibles: daily, lifetime
string
requerido
El tipo de campaña, fijado al crearla. standard ejecuta anuncios de imagen y video; search muestra anuncios de texto en los resultados de búsqueda para las palabras clave de los grupos de anuncios.Opciones disponibles: standard, search
number
requerido
Clics divididos entre impresiones, entre 0 y 1.
number
requerido
El número de clics.
number
requerido
Valor en USD atribuido a los eventos de registro completado. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Eventos de registro completado atribuidos por el píxel de Whop, último clic.
number
requerido
Valor en USD atribuido a los eventos de contacto. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Eventos de contacto atribuidos por el píxel de Whop, último clic.
number | null
requerido
Gasto dividido entre los eventos de añadir al carrito atribuidos; null cuando no son el objetivo y no hay ninguno atribuido.
number
requerido
Gasto dividido entre clics; 0 cuando no hay clics.
number | null
requerido
Gasto dividido entre los eventos de registro completado atribuidos; null cuando no son el objetivo y no hay ninguno atribuido.
number | null
requerido
Gasto dividido entre los eventos de contacto atribuidos; null cuando los contactos no son el objetivo y no hay ninguno atribuido.
number | null
requerido
Gasto dividido entre los leads atribuidos; null cuando los leads no son un objetivo y no hay ninguno atribuido.
number
requerido
Gasto por cada 1.000 impresiones; 0 cuando no hay impresiones.
number | null
requerido
Gasto dividido entre las compras atribuidas; null cuando las compras no son un objetivo y no hay ninguna atribuida.
number | null
requerido
Gasto dividido entre los resultados atribuidos por el píxel de Whop; null cuando no se está optimizando para nada atribuible por Whop.
number | null
requerido
Gasto dividido entre los eventos de agendamiento atribuidos; null cuando los agendamientos no son el objetivo y no hay ninguno atribuido.
number | null
requerido
Gasto dividido entre los eventos de envío de solicitud atribuidos; null cuando no son el objetivo y no hay ninguno atribuido.
number | null
requerido
Gasto dividido entre clics únicos; null cuando no hay clics únicos.
number | null
requerido
Gasto dividido entre los eventos de visualización de contenido atribuidos; null cuando no son el objetivo y no hay ninguno atribuido.
string
requerido
Cuándo se creó la campaña, como marca de tiempo ISO 8601.
number
requerido
Eventos de conversión personalizados (definidos por el comerciante) atribuidos por el píxel de Whop, último clic, en todos los nombres de eventos personalizados.
object
requerido
Conversiones personalizadas atribuidas por el píxel de Whop, indexadas por el nombre de tu evento, con su recuento de último clic como valor. Vacío cuando no hay eventos personalizados con nombre atribuidos. Los eventos personalizados disparados sin nombre se cuentan en custom_conversions pero se omiten aquí, por lo que estos valores suman como máximo custom_conversions.
object
requerido
Valor de conversión atribuido a cada evento personalizado, indexado por nombre de evento como custom_event_counts. Suma el valor pasado a whop.track, normalizado a USD; los eventos disparados sin valor aportan 0.
string
requerido
Si los anuncios de la campaña se están entregando ahora mismo y, si no, por qué. La revisión de contenido es in_review; una campaña que espera para empezar es processing. Los fallos de facturación de la cuenta establecen payment_failed sin cambiar el estado configurado. Un reintento de pago exitoso elimina ese bloqueo y recalcula la entrega. Cuando se aplican varios estados a la vez, se devuelve el de mayor precedencia.Opciones disponibles: payment_failed, all_ads_rejected, draft, paused, in_review, learning, processing, revise_content, issues, scheduled, completed, active
number | null
El costo por resultado, en USD, que el anunciante quiere que logre esta campaña. Solo es un objetivo: no es una puja, un límite de costo ni un límite de puja, y no cambia cómo pujan los anuncios de la campaña. null cuando no hay objetivo establecido.
string | null
requerido
Cuándo deja de entregarse la campaña, como marca de tiempo ISO 8601. null cuando se ejecuta hasta que se pausa, o cuando sus grupos de anuncios establecen su propia programación.
number | null
requerido
Impresiones divididas entre el alcance.
number
requerido
El número de impresiones.
object[]
requerido
Problemas abiertos que afectan a la campaña y a sus grupos de anuncios y anuncios descendientes.

Propiedades

string
requerido
Identificador único del problema.
string
requerido
El tipo de problema: información sobre la entrega, una advertencia o un error que requiere atención.Opciones disponibles: information, warning, error
string
requerido
Una descripción de en qué consiste el problema y cómo puede resolverse.
string | null
requerido
El ID de la campaña, el grupo de anuncios o el anuncio al que está asociado el problema.
string
requerido
El tipo de recurso al que está asociado el problema.Opciones disponibles: ad_campaign, ad_group, ad
string
requerido
Un título breve del problema, orientado al creador: la regla que indica un rechazo de la revisión de contenido, o una etiqueta genérica.
number
requerido
Valor en USD atribuido a los eventos de lead. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Leads atribuidos por el píxel de Whop, último clic.
Vistas de página en tu destino de personas que hicieron clic en el anuncio, registradas por el píxel de Whop. Se cuentan de la misma forma en todas las plataformas de anuncios.
string | null
requerido
El objetivo hacia el que optimiza la campaña. awareness solo aparece en campañas creadas antes de que se retirara; esas campañas no se pueden lanzar.Opciones disponibles: awareness, traffic, engagement, leads, sales
number
requerido
Valor en USD de las compras atribuidas por el píxel.
number
requerido
Compras atribuidas por el píxel de Whop, último clic.
number
requerido
El número de personas únicas que vieron esto.
string | null
requerido
El evento de conversión del píxel de Whop cuyo recuento atribuido representa los resultados: el objetivo de optimización, o el evento atribuido de mayor volumen en las campañas con presupuesto por grupo de anuncios. Null cuando el objetivo no es un evento atribuido por Whop.Opciones disponibles: purchase, lead, schedule, submit_application, contact, complete_registration, view_content, add_to_cart, custom, messaging_conversation
string | null
requerido
El nombre del evento definido por el comerciante cuando result_event es custom; null para los eventos estándar.
number | null
requerido
El recuento atribuido por el píxel de Whop detrás de result_event. Cuando los grupos de anuncios de una campaña optimizan objetivos distintos no hay un único result_event (es null), y esto es en cambio la suma de los resultados atribuidos de cada grupo de anuncios. Null cuando no se está optimizando para nada atribuible por Whop.
number
requerido
Valor de compra dividido entre el gasto, ambos en USD (una proporción independiente de la moneda); 0 cuando no hay gasto.
number
requerido
Valor en USD atribuido a los eventos de agendamiento. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Eventos de agendamiento atribuidos por el píxel de Whop, último clic.
string[]
requerido
Categorías reguladas bajo las que se declara la campaña. Los anuncios de estas categorías están sujetos a restricciones de segmentación adicionales. Vacío cuando no se aplica ninguna.Opciones disponibles: housing, employment, financial_products, politics
number
requerido
El importe cobrado, en spend_currency.
string | null
requerido
El código de moneda ISO 4217 de todas las métricas monetarias.
string | null
requerido
Cuándo empieza a entregarse la campaña, como marca de tiempo ISO 8601. null cuando empieza en cuanto se lanza, o cuando sus grupos de anuncios establecen su propia programación.
string
requerido
El estado del ciclo de vida configurado de la campaña publicitaria. Los fallos de facturación conservan aquí active o paused y establecen delivery_status en payment_failed.Opciones disponibles: active, paused, inactive, payment_failed, draft, duplicating
number
requerido
Valor en USD atribuido a los eventos de envío de solicitud. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Eventos de envío de solicitud atribuidos por el píxel de Whop, último clic.
number | null
requerido
El costo por resultado deseado para target_result_event, en USD. null cuando no se ha establecido ninguno.
string | null
requerido
El evento por el que se calcula target_cost_per_result, como purchase o lead. null cuando la campaña no tiene un único objetivo.
string
requerido
Nombre visible de la campaña publicitaria.
number | null
requerido
Clics únicos divididos entre impresiones, entre 0 y 1.
number
requerido
Personas que hicieron clic, informadas por el píxel de Whop, contadas una vez por persona.
string
requerido
Cuándo se actualizó la campaña por última vez, como marca de tiempo ISO 8601.
number
requerido
Valor en USD atribuido a los eventos de visualización de contenido. Suma el valor enviado con cada evento, normalizado a USD; los eventos sin valor aportan 0.
number
requerido
Eventos de visualización de contenido atribuidos por el píxel de Whop, último clic.
AdCampaign