Servicio de campaña
Una campaña es una manera de organizar un conjunto de parámetros de segmentación dentro de nuestra plataforma en combinación con el servicio de perfil. El objeto de campaña incluye parámetros como fechas de vuelo y creatividades asociadas, mientras que los perfiles tienen como destino parámetros de usuario e inventario, como geografía, segmento, frecuencia, dominio y categoría.
API de REST
| Http (método) | Endpoint | Description |
|---|---|---|
POST |
- https://api.appnexus.com/campaign?advertiser_id=ADVERTISER_ID - https://api.appnexus.com/campaign?advertiser_code=ADVERTISER_CODE (JSON de campaña) |
Agregue una nueva campaña. |
PUT |
-
https://api.appnexus.com/campaign?id=CAMPAIGN_ID& advertiser_id=ADVERTISER_ID - https://api.appnexus.com/campaign?code=CAMPAIGN_CODE& advertiser_code=ADVERTISER_CODE (JSON de campaña) |
Modificar una campaña existente. |
GET |
-
https://api.appnexus.com/campaign?id=CAMPAIGN_ID& advertiser_id=ADVERTISER_ID - https://api.appnexus.com/campaign?code=CAMPAIGN_CODE& advertiser_code=ADVERTISER_CODE |
Consulta una campaña específica para uno de tus anunciantes. |
GET |
- https://api.appnexus.com/campaign?advertiser_id=ADVERTISER_ID - https://api.appnexus.com/campaign?advertiser_code=ADVERTISER_CODE |
Consulta todas las campañas de uno de tus anunciantes. |
GET |
https://api.appnexus.com/campaign?id=1,2,3 | Vea varias campañas por identificador mediante una lista separada por comas. Nota:Filtros útiles - Puedes filtrar las campañas en función de cuándo se hayan servido por primera y última vez. Esto resulta especialmente útil cuando se está aproximando al límite de objetos y es necesario identificar las campañas que se pueden eliminar del sistema. Para obtener más información, consulte Primera ejecución o última ejecución. - Puedes filtrar las campañas que no están sirviendo debido a diversas condiciones. Para obtener más información, consulte Alertas. |
GET |
https://api.appnexus.com/campaign?search=SEARCH_TERM | Busque campañas con identificadores o nombres que contengan determinados caracteres. |
DELETE |
https://api.appnexus.com/campaign?id=CAMPAIGN_ID& advertiser_id=ADVERTISER_ID | Eliminar una campaña. Cautela: La eliminación es permanente y no se puede revertir. Aunque las campañas eliminadas siguen estando disponibles en los informes, ya no tendrá visibilidad sobre su configuración específica (por ejemplo, el presupuesto de costos y la segmentación). |
GET |
https://api.appnexus.com/campaign/meta | Averigüe por qué campos puede filtrar y ordenar. |
Campos JSON
General
| Campo | Tipo | Descripción |
|---|---|---|
id |
Entero | Identificador de la campaña. Obligatorio On: PUT, en la cadena de consulta. |
State |
enumeración | Estado de la campaña. Valores posibles: "active" o "inactive".Predeterminado: "active" |
parent_inactive |
booleano | Si truees , la campaña está inactiva debido a que el elemento de línea principal está inactivo y el de state la campaña se invalida (es decir, si "parent_inactive": "true" y "state": "active", la campaña está inactiva).Nota: Para devolver este campo, advertiser_id debe incluirse en la cadena de consulta.Predeterminado: falseSolo lectura. |
code |
string (100) | Código personalizado para la campaña. El código solo puede contener caracteres alfanuméricos, puntos, caracteres de subrayado o guiones. El código especificado no distingue mayúsculas de minúsculas (los caracteres de mayúsculas y minúsculas se tratan igual). No hay 2 objetos en el mismo nivel (por ejemplo, artículos de línea o campañas) que puedan usar el mismo código por anunciante. Por ejemplo, dos líneas de elementos no pueden usar el código "XYZ", pero un solo elemento de línea y su campaña secundaria pueden. |
name |
string (255) | Nombre de la campaña. Obligatorio activado: POST |
short_name |
string (50) | Nombre utilizado por imp bus. |
advertiser_id |
Entero | Id. del anunciante al que pertenece la campaña. Obligatorio On: POST/PUT, en la cadena de consulta. |
profile_id |
Entero | Puede asociar un valor opcional profile_id a esta campaña. Un perfil es un conjunto genérico de reglas para el inventario de destino. Para obtener más información, consulte El servicio de perfiles. |
line_item_id |
Entero | Identificador del elemento de línea al que está asociada la campaña. Cautela: No se pueden asociar más de 500 campañas a un solo elemento de línea. Obligatorio activado: POST |
start_date |
Timestamp | Fecha y hora en que la campaña debe empezar a servir. Null corresponde a "inmediatamente". Este valor refleja la zona horaria del anunciante. Predeterminado: null |
end_date |
Timestamp | Fecha y hora en que la campaña debe dejar de servir. Null corresponde a "indefinidamente". Este valor refleja la zona horaria del anunciante. Predeterminado: null |
creatives |
matriz | Lista de identificadores o códigos creativos asociados a la campaña. La actualización solo requiere que se pase el identificador o el código, pero GET la solicitud incluirá más campos creativos para mayor comodidad. Para obtener más información, consulte Creativos y el ejemplo siguiente. |
creative_groups |
matriz de identificadores | Es posible que desee cubos de un grupo de creativos y, a continuación, agregarlos a una campaña todo a la vez. Cree grupos a través del servicio de elementos de línea. |
timezone |
enumeración | Zona horaria de la campaña. Para más información y valores aceptados, consulte Zonas horarias de API. Si no se establece ninguna zona horaria, este valor predeterminado será la zona horaria del anunciante, que tiene como valor predeterminado la zona horaria del miembro, que tiene como valor predeterminado EST5EDT. Los presupuestos diarios de la campaña se restablecen a medianoche en la zona horaria de la campaña, por lo que este campo determina esa hora. Nota: Las PUT llamadas al advertiser servicio que incluyan set_child_timezone=true en la cadena de consulta harán que cualquier configuración de zona horaria de los objetos de nivel inferior (por ejemplo, pedidos de inserción, elementos de línea, campañas) se invalide con el valor de zona horaria más reciente para ese anunciante.Predeterminado: La zona horaria del anunciante. |
last_modified |
Timestamp | Hora de la última modificación de esta campaña. |
supply_type |
string | Los tipos de suministro destinados a esta campaña, tal y como se define en el supply_type_targets campo del perfil asociado. Esta cadena puede contener uno o varios de los siguientes valores, separados por comas: web, mobile_web y mobile_app.Solo lectura. |
supply_type_action |
enumeración | Si los tipos de suministro están "incluidos" o "excluidos" de la selección de destino, tal como se define en el supply_type_action campo del perfil asociado.Solo lectura. |
inventory_type |
enumeración | Tipo de inventario destinado a esta campaña. Valores posibles: "real_time", "direct"o "both".
"Real-time" incluye todo el inventario de terceros no administrado por la red que se ha habilitado para revender, incluidos los asociados de suministro externos, como Microsoft Advertising Exchange y Google Ad Manager.
"Direct" incluye solo el inventario administrado por la red.Predeterminado: "real_time" |
roadblock_creatives |
booleano | Solo sirve esta campaña si todos los creativos adjuntos a ella pueden servir en una carga de página. Nota: El bloqueo de carreteras solo está habilitado para el inventario directo. Si intenta establecer roadblock_creativestrue en para un inventory_type valor distinto directde , la API devolverá un error. |
roadblock_type |
enumeración | Hay varios tipos de obstáculos disponibles. Los valores permitidos son "no_roadblock", "normal_roadblock" (donde el número de creatividades es mayor o igual que el número de ubicaciones), "partial_roadblock" (donde el número de creatividades es menor o igual que el número de ubicaciones) y "exact_roadblock" (donde el número de creatividades es igual al número de ubicaciones disponibles).Predeterminado: "no_roadblock" |
stats |
objeto | El stats objeto ha quedado en desuso (a partir del 17 de octubre de 2016). Use el servicio de informes para obtener información estadística en su lugar. |
all_stats |
matriz | El stats objeto ha quedado en desuso (a partir del 17 de octubre de 2016). Use el servicio de informes para obtener información estadística en su lugar. |
comments |
string | Comentarios sobre la campaña. |
labels |
matriz de objetos | Las etiquetas opcionales aplicadas a la campaña. Una etiqueta está disponible actualmente: "Test/Control". Para obtener más información, vea Etiquetas a continuación. Propina: Puede informar sobre las etiquetas de campaña con los informes Análisis de red, Análisis de anunciantes de red y Análisis de anunciantes . Por ejemplo, si usa la etiqueta "Test/Control" para especificar el grupo de usuarios de destino (tal como se define en el campo user_group_targets del perfil asociado), podría ejecutar el informe de Network Analytics filtrado por "user_group_for_campaign" para centrarse en las campañas destinadas a un grupo de usuarios determinado o agrupado por "user_group_for_campaign" para clasificar el rendimiento de los grupos de usuarios. |
broker_fees |
matriz | Las tarifas que la red debe pagar a los agentes al servir un anuncio. Estas tarifas se suman al costo del inventario y suelen ser para los datos, la publicación de anuncios o el hospedaje creativo. Pueden ser un porcentaje del costo de los medios o un CPM plano. Para obtener más detalles, vea Cuotas de broker a continuación. |
click_url |
string (1000) | Dirección URL de la página de aterrizaje (opcional) para imágenes de terceros y creatividades flash. |
valuation |
objeto | Objeto que contiene varios campos relacionados con los objetivos de rendimiento y el margen mínimo. Para obtener más información, consulte Valoración a continuación. |
remaining_days |
Entero | El número de días entre hoy y el end_date de la campaña. Nota: Esto será null si start_date es en el futuro o si start_date está establecido o end_date no.Solo lectura. |
total_days |
Entero | Número de días entre y start_dateend_date para la campaña. Nota: Será null si start_date no se establece o end_date .Solo lectura. |
first_run |
Timestamp | La fecha y hora en que la campaña se sirvió por primera vez, actualizada cada hora. Este valor refleja la zona horaria UTC. Para incluir esta información en una respuesta GET, pase flight_info=true la cadena de consulta. Para obtener más información sobre cómo filtrar los elementos de línea en función de cuándo se han proporcionado por primera vez, consulte Primera ejecución o última ejecución a continuación.Solo lectura. |
last_run |
Timestamp | La fecha y hora en que la campaña se sirvió por última vez, actualizada cada hora. Este valor refleja la zona horaria UTC. Para incluir esta información en una respuesta GET, pase flight_info=true la cadena de consulta. Para obtener más información sobre cómo filtrar los elementos de línea en función de cuándo se sirvieron por última vez, consulte Primera ejecución o última ejecución a continuación.Solo lectura. |
alerts |
objeto | Las condiciones que impiden que la campaña sirva. Hay dos tipos de alertas: pausas y advertencias. Las pausas se consideran intencionadas y controladas por el usuario, mientras que las advertencias se consideran involuntarias. Por ejemplo, "El estado está establecido en inactivo" se considera una pausa, mientras que "No hay creatividades asociadas a esta campaña" se considera una advertencia. Para recuperar campañas basadas en pausas o advertencias, debe pasar determinados parámetros de cadena de consulta en la solicitud GET. Para obtener más información, incluida una lista completa de posibles pausas y advertencias, consulte Alertas a continuación. Solo lectura. |
creative_distribution_type |
enumeración | Cuando varias creatividades del mismo tamaño se trafican a través de un elemento de línea, la configuración de este campo se usa para determinar la estrategia de rotación creativa que se usará. Tenga en cuenta que las creatividades deben administrarse en la campaña para poder usar este campo. Valores permitidos: - aun: Valor predeterminado. Use nuestro algoritmo de optimización creativa estándar, donde la valoración de cada creatividad se calcula de forma independiente y se elige la creatividad mejor valorada para servir. - ponderado: La rotación creativa se basa en un peso proporcionado por el usuario. - Optimizado para ctr: La creatividad con el CTR más alto ofrece el máximo. Predeterminado: "even" |
is_archived |
booleano | Solo lectura. Indica si la campaña se ha archivado automáticamente debido a que no se usa. Una vez establecido en true, el valor no se puede cambiar y las únicas llamadas que se pueden realizar en el objeto de campaña son GET y DELETE.Nota: Si una campaña se archiva automáticamente, también se archivará su perfil. Si el elemento de línea principal de la campaña se archiva automáticamente, también se archivarán todas las campañas (así como sus perfiles) en ese elemento de línea. Una vez archivados, las únicas llamadas que se pueden realizar en estos objetos son GET y DELETE. Además, una vez archivada, es posible que la campaña no esté asociada a ningún elemento de línea.Predeterminado: false |
archived_on |
Timestamp | Solo lectura. Fecha y hora en que se archivó la campaña (es decir, cuando el is_archived campo se estableció en true).Predeterminado: null |
creatives ejemplo
[{"id": 233,"state":"active","code":"abc","name":"test","width":200,"height":200,
"audit_status":"pending","is_expired":true,
"is_prohibited":false,"is_self_audited:true,
"format":"image","pop_window_maximize":false}]
Precios y presupuestos
| Campo | Tipo | Descripción |
|---|---|---|
lifetime_budget |
double | El presupuesto de duración en dólares (costo multimedia). Null corresponde a "unlimited". Cautela: Si lifetime_budget se establece en null (ilimitado) y los presupuestos de duración de los artículos de línea y del pedido de inserción también se establecen en null, se puede producir un sobrespendido grave.Predeterminado: null |
lifetime_budget_imps |
Entero | Presupuesto de duración en impresiones. Null corresponde a "unlimited". Predeterminado: null |
daily_budget |
double | El presupuesto diario en dólares (costo multimedia). Null corresponde a "unlimited". Predeterminado: null |
daily_budget_imps |
Entero | El presupuesto diario en impresiones. Null corresponde a "unlimited". Predeterminado: null |
learn_budget |
double | El presupuesto de dólar de por vida (costo multimedia) asignado al aprendizaje. Null corresponde a "unlimited". Predeterminado: null |
learn_budget_imps |
Entero | Presupuesto de impresiones de duración asignado al aprendizaje. Null corresponde a "unlimited". Predeterminado: null |
learn_budget_daily_cap |
double | El número máximo de dólares (costo multimedia) que se pueden asignar al aprendizaje por día. Null corresponde a "unlimited". Predeterminado: null |
learn_budget_daily_imps |
Entero | Número máximo de impresiones que se pueden asignar al aprendizaje por día. Null corresponde a "unlimited". Predeterminado: null |
enable_pacing |
booleano | Si truees , el gasto presupuestado diario de la campaña se distribuye uniformemente a lo largo de cada día. Esto solo es aplicable si daily_budget se establece. Para obtener más información sobre el ritmo diario, consulte "Daily Pacing" (Ritmo diario) en la documentación de la interfaz de usuario.Predeterminado: false |
lifetime_pacing |
booleano | Si truees , la campaña intentará gastar su presupuesto total de por vida uniformemente en las fechas de los vuelos de la campaña. Si es true, no se puede establecer un daily_budget, no se puede establecer en enable_pacing false y primero debe establecer un lifetime_budget, un start_datey un end_date para la campaña.Predeterminado: false |
lifetime_pacing_span |
Entero | En caso de que se produzca un evento de suspensión, esto indica el número de días en los que se distribuirá la cantidad infraestinada. El valor predeterminado de null indica un valor de tres (3) días.Predeterminado: null |
priority |
Entero | En el caso de una campaña destinada al inventario directo (inventory_type es "direct"), ya que ya ha pagado por el inventario, no es necesario introducir una estrategia de compra. Sin embargo, puedes establecer la prioridad de la campaña para ponderar la campaña con respecto a otras campañas directas dentro de tu cuenta. La campaña con la prioridad más alta siempre ganará, incluso si una campaña de menor prioridad puja más. Para obtener más información sobre cómo administrar la prioridad, vea "Prioridad de puja" en la documentación de la interfaz de usuario.Predeterminado: 5 |
cadence_modifier_enabled |
booleano | Si truees , las pujas se ajustarán hacia arriba y hacia abajo en función de la frecuencia y la recencia del usuario. Por lo general, las pujas aumentan para las impresiones de baja frecuencia y disminuyen para los usuarios de alta frecuencia y recenencia. Esta característica se basa en la idea de que la eficacia de un anuncio difiere cuando un usuario no ha visto el anuncio antes, no lo ha visto muchas veces o no lo ha visto recientemente. Para obtener más información, consulte "Modificador de cadencia y factor de caos" en la documentación de la interfaz de usuario.Predeterminado: false |
expected_pacing |
double |
Obsolescente. Nota: El stats objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016). |
total_pacing |
double |
Obsolescente. Nota: El stats objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016). |
has_pacing_dollars |
enumeración |
Obsolescente. Nota: El stats objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016). |
has_pacing_imps |
enumeración |
Obsolescente. Nota: El stats objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016). |
imps_pacing_percent |
Entero |
Obsolescente. Nota: El stats objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016). |
media_cost_pacing_percent |
Entero |
Obsolescente. Nota: El stats objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016). |
Estrategias de puja
| Campo | Tipo | Descripción |
|---|---|---|
cpm_bid_type |
enumeración | Posibles valores: - "base": puja por un importe fijo.- "average": precio medio estimado de la oferta (EAP), una estimación del precio que es probable que gane alrededor del 50% de las impresiones de nuestros vendedores de plataforma en función de las ofertas históricas y su éxito o fracaso. Dado que los vendedores fuera de la plataforma (por ejemplo, Google Ad Manager, Rubicon, etc.) realizan una subasta secundaria, la oferta EAP no garantiza necesariamente la mitad de las impresiones fuera de la plataforma.- "clearing": Precio claro estimado de la oferta (ECP), una estimación del precio que es probable que obtenga la mayoría de las impresiones de los vendedores de nuestra plataforma en función de las ofertas históricas y su éxito o fracaso. Dado que los vendedores fuera de la plataforma (por ejemplo, Google Ad Manager, Rubicon, etc.) realizan una subasta secundaria, la oferta de ECP no garantiza necesariamente que se ganen impresiones fuera de la plataforma.- "predicted": varía las pujas en función de la probabilidad de un clic o una conversión para cada parte del inventario. Para predecir el CPC, use cpc_goal. Para predecir CPA, consulte Píxeles a continuación.- "margin": ofrece un margen de % de los ingresos que el anunciante le paga. Consulte bid_margin.- "custom_model": calcule el precio de la oferta en función de un modelo predictivo personalizado. Establezca el modelo que se va a usar en el bid_model objeto . Para obtener más información, consulte Modelos personalizados.Nota: Solo se puede establecer en cpm_bid_type"custom_model" cuando inventory_type es "rtb".- "none": ninguno solo está disponible si paga por clic o por conversión, y esto provocará que no pueda pujar por CPM.Obligatorio en: POST, a menos que inventory_type se establezca en "direct". |
base_bid |
double | Una oferta de CPM. Puede modificarse mediante cadence_modifer.Obligatorio en: POST, si cpm_bid_type es "base". |
min_bid |
double | Establezca una oferta mínima que se aplicará a los modelos de precios variables (consulte cpm_bid_type). |
max_bid |
double | Establezca una puja máxima que se aplicará a los modelos de precios variables (consulte cpm_bid_type). |
bid_margin |
double | Margen porcentual de los ingresos que el anunciante le paga. Por ejemplo, si los ingresos reservados son $1 CPM y estableces un margen de estrategia de puja del 25 %, tu campaña pujará 0,75 USD. Si el tipo de ingresos reservados es un objetivo de CPA o CPC, aplicará el margen deseado y se optimizará a ese objetivo previsto. Obligatorio en: POST, si cpm_bid_type es "margin". |
cpc_goal |
double | Es posible que desee variar las pujas en función de la probabilidad de que se produzca algún evento de conversión, ya sea un clic o una adquisición, para ese inventario en particular, con el fin de alcanzar un costo específico por clic o costo por adquisición. En este caso, el algoritmo de nuestra plataforma determina una puja en función de las tasas de conversión anteriores y en función de cuánto valore una conversión, si la define como un clic o una adquisición (registro, compra, etc.). Obligatorio En: POST, si cpm_bid_type es "predicted" y roi_click_goal y no roi_view_goal se establecen en la pixels matriz. |
max_learn_bid |
double | Cuando se usa cpm_bid_type"predicted", el motor de optimización envía pujas de "aprendizaje" para obtener información sobre el nuevo inventario. Si es necesario, escriba el importe máximo de CPM en dólares para estas pujas.Nota: Cuando se establecen tanto max_learn_bid para ofertas de aprendizaje como max_bid para ofertas que no son de aprendizaje, la parte inferior de las dos se usará para aprender.Predeterminado: null |
pixels |
matriz | Si usa una estrategia de puja de CPA, la matriz de píxeles se usa para asociar píxeles de conversión a la campaña y establecer objetivos de CPA y valores de pago para los píxeles. Para obtener más información, consulte Píxeles a continuación. |
bid_model |
objeto | Si usa un modelo predictivo personalizado para determinar los precios de las pujas, este objeto se usa para asociar el modelo personalizado a la campaña. Para obtener más información, consulte Modelo de puja a continuación. Predeterminado: nullObligatorio en: POST, si cpm_bid_type es "custom_model". |
Palancas de optimización
Estos campos opcionales proporcionan a los usuarios avanzados control adicional sobre la optimización de sus campañas. Para obtener información detallada sobre estos campos, consulte "Palancas de optimización" en la documentación de la interfaz de usuario.
Sugerencia
Si desea acceder a las palancas de optimización, un administrador de Xandr debe establecer el expose_optimization_levers campo true en para el miembro. Para obtener más información, póngase en contacto con el representante de su cuenta.
| Campo | Tipo | Descripción |
|---|---|---|
ecp_learn_divisor |
string | Obsoleto. Esta característica no se admite en la versión 7 del motor de optimización. Para conocer las formas más recientes de ajustar las ofertas de learn, consulte learn_override_type.Predeterminado: null (3) |
projected_learn_events |
Entero | Obsoleto. Esta característica se ha incorporado al algoritmo de aprendizaje de la versión 7 del motor de optimización. Predeterminado: null (3) |
learn_threshold |
Entero | Número de eventos correctos (clics o conversiones) necesarios antes de pasar de la fase de aprendizaje a la fase optimizada. Valores posibles: de 1 a 100. Predeterminado: null (3) |
max_learn_bid |
double | Cuando se usa " cpm_bid_type predicted", el motor de optimización envía pujas "learn" para obtener información sobre el nuevo inventario. Si es necesario, escriba el importe máximo de CPM en dólares para estas pujas. Nota: Cuando se establecen tanto max_learn_bid para ofertas de aprendizaje como max_bid para ofertas que no son de aprendizaje, la parte inferior de las dos se usará para aprender.Predeterminado: null |
cadence_type |
enumeración | Nivel al que se aplica el modificador de cadencia. Valores posibles: "advertiser" o "creative".Predeterminado: "advertiser" |
defer_to_li_prediction |
booleano | Si es true, esta campaña cambiará temporalmente el nivel en el que aprende mientras mantiene un porcentaje de margen de beneficio especificado. Consulte "Palancas de optimización" en la documentación de la interfaz de usuario para obtener más información. Predeterminado: false |
optimization_lookback |
matriz de objetos | La optimización se basa en los últimos 30 días de datos, ponderados uniformemente. Puede usar este campo para dar más peso a determinados días dentro de esa ventana. Valores posibles para "day": 0 - 29. Valores posibles para "bias_percent": 0 - 100. Para obtener más detalles, vea el ejemplo siguiente. |
optimization_version |
string | Indica la versión de optimización actualmente en uso. Predeterminado: v7Solo lectura. |
learn_override_type |
enumeración | Si quiere invalidar la oferta de aprendizaje de nuestro algoritmo, este es el tipo de oferta que se va a enviar en su lugar. Posibles valores: - "base_cpm_bid": una oferta de CPM plana. Especifique el valor de CPM en el base_cpm_bid_value campo .- "venue_avg_cpm_bid": la oferta media de cada lugar.Predeterminado: null |
base_cpm_bid_value |
double | Valor de CPM que se va a usar para las pujas de learn, cuando learn_override_type es "cpm_learn_bid". Este valor no puede ser mayor que 10,0.Predeterminado: nullObligatorio en: POST/PUT, si learn_override_type es "base_cpm_bid". |
bid_multiplier |
double | Valor por el que se va a multiplicar la oferta de aprendizaje. Esto se puede usar para la oferta de aprendizaje predeterminada de nuestro algoritmo o una oferta de invalidación de learn cuando learn_override_type es "venue_average_cpm_bid". Este valor no puede ser mayor que 10.0.Predeterminado: 1.0 |
impression_limit |
Entero | Para un lugar específico, el número de impresiones después de las cuales dejar de invalidar la oferta de aprendizaje de nuestro algoritmo. Este valor debe ser mayor que 0. Predeterminado: 40000 |
campaign_modifiers |
matriz de objetos | Matriz de objetos que contiene la configuración relacionada con modificadores de segmento asociada a esta campaña (formato que se muestra a continuación). Para obtener más información, vea "Modificador de segmento" en la documentación de la interfaz de usuario. Nota: No se puede establecer ni campaign_modifierbid_modifier_model en una sola campaña.Para obtener más detalles, vea el ejemplo siguiente. |
bid_modifier_model |
objeto | Modelo predictivo personalizado para aplicar multiplicadores a la oferta de CPM derivada de la optimización de la campaña. Este tipo de modelo se usa junto con nuestra estrategia de compra basada en optimización (cuando cpm_bid_type es "predicted" o "margin").Para obtener más información, vea Modelo modificador de puja a continuación. Nota: Solo se puede establecer bid_modifier_model cuando inventory_type es "rtb". Además, no se puede establecer ni bid_modifier_modelcampaign_modifier en una sola campaña.Predeterminado: null |
optimization_lookback ejemplo
"optimization_lookback":[
{
"day":8,
"bias_percent":10
},
{
"day":12,
"bias_percent":11
}
],
campaign_modifiers ejemplo
{
"campaign":
{
"id":123,
"name":"ModifiedCampaign",
"campaign_modifiers":[
{
"type":"segment_modifier_id",
"value":456
},
{
"type":"segment_price_id",
"value":789
},
{
"type":"segment_modifier_weight",
"value":1200
}
]
}
}
Tasas de broker
Cuando una red usa un agente para dar una impresión, paga una cuota al agente por ese servicio. Este valor varía entre diferentes redes, agentes y campañas diferentes. Por lo tanto, la red debe especificar cuánto pagará a cada agente que use. Esto también se puede hacer en el nivel de elemento de línea (servicio de artículo de línea) o en el nivel de pedido de inserción (servicio de pedido de inserción).
Para crear o editar agentes, consulte Broker Service.
| Campo | Tipo (longitud) | Descripción |
|---|---|---|
broker_id |
Entero | Identificador del agente. |
broker_name |
string | Nombre del agente. Solo lectura. |
payment_type |
enumeración | Tipo de pago al agente. Valores posibles: "cpm" o "revshare". |
value |
double | Valor del pago, en función del tipo de pago. |
description |
string (255) | Descripción de forma libre de la entrada de la cuota del agente. |
Adición de una cuota de agente
$ cat add-broker-fees.json
{
"campaign":
{
"broker_fees":[
{
"broker_id": 145,
"broker_name": "Test 3",
"payment_type": "cpm",
"value": "1.00",
"description": "JMS fee"
}]
}
}
$ curl -b cookies -c cookies -X PUT -d @add-broker-fees.json 'https://api.appnexus.com/campaign?id=376737&advertiser_id=35081'
{
"response":{
"status":"OK",
"id":"376737",
"count":1,
"start_element":0,
"num_elements":100,
}
}
Modificación de una cuota de agente
$ cat modify-broker-fee.json
{
"campaign" :
{ "broker_fees": [
{
"broker_id": 145,
"payment_type": "cpm",
"value": "3.00",
"description": "New JMS fee"
}]
}
}
$ curl -b cookies -c cookies -X PUT -d @modify-broker-fee.json 'https://api.appnexus.com/campaign?id=376737&advertiser_id=35081'
{
"response":{
"status":"OK",
"id":"376737",
"count":1,
"start_element":0,
"num_elements":100,
Creativos
Cada objeto de la creatives matriz incluye los campos siguientes. Para obtener información sobre "id" campos o "code" , puede usar el Servicio Creativo.
| Campo | Tipo (longitud) | Descripción |
|---|---|---|
id |
Entero | Identificador de la creatividad.
"code" O "id" es necesario al actualizar la asociación creativa.Obligatorio activado: PUT |
code |
string | Código personalizado para la creatividad.
"code" O "id" es necesario al actualizar la asociación creativa.Obligatorio activado: PUT |
name |
string | Nombre de la creatividad. Solo lectura. |
width |
Entero | Ancho de la creatividad. Solo lectura. |
height |
Entero | El alto de la creatividad. Solo lectura. |
state |
enumeración | El estado de la creatividad. Valores posibles: "active" o "inactive".Solo lectura. |
audit_status |
enumeración | Estado de auditoría de la creatividad. Valores posibles: "no_audit", "pending", "rejected", "audited"o "unauditable".Solo lectura. |
is_expired |
booleano | Si la creatividad ha expirado. Si falsees , la creatividad está activa.Solo lectura. |
is_prohibited |
booleano | Si el creativo entra en una categoría prohibida en nuestra plataforma. |
is_self_audited |
booleano | Si la creatividad se audita por sí misma. Si truees , entonces sí. Solo lectura. |
format |
enumeración | Formato del archivo creativo. Valores posibles: "url-html", "url-js", "flash", "image", "raw-js", "raw-html", o "iframe-html""text".Solo lectura. |
weight |
Entero | Peso proporcionado por el usuario que determina la estrategia de rotación creativa para las creatividades del mismo tamaño administradas en el nivel de campaña. Para usar este campo, el valor de creative_distribution_type debe ser "weighted". Valor permitido: un entero mayor 0 que y menor o igual que 1000. |
pop_window_maximize |
booleano | Si truees , la etiqueta del publicador maximizará la ventana. Solo es relevante para creativos con formato "url-html" y "url-js". Si pop_window_maximize se establece en true, no se debe establecer ni "height" en "width" la creatividad.Solo lectura. |
Valoración
El valuation objeto contiene los siguientes campos relacionados con el margen mínimo. Para obtener más información sobre el margen mínimo, vea "Uso del margen mínimo para equilibrar el margen y la entrega" en la documentación de la interfaz de usuario.
| Campo | Tipo (longitud) | Descripción |
|---|---|---|
min_margin_rtb_pct |
decimal | Margen mínimo del PCT en el inventario de RTB. Invalida lo que se establece en el elemento de línea. Predeterminado: null |
eap_multiplier |
decimal | Valor del multiplicador EAP. Solo se puede usar en los tipos de inventario "real_time" o "ambos". Predeterminado: 1.000000 |
Estadísticas
Precaución
El stats objeto ha quedado en desuso (a partir del 17 de octubre de 2016). Use el servicio de informes para obtener información estadística en su lugar.
Etiquetas
Cada objeto de la labels matriz incluye los campos siguientes.
Nota:
Puede usar el Servicio de etiquetas de solo lectura para ver todas las etiquetas posibles para campañas, anunciantes, pedidos de inserción, artículos de línea y publicadores. Este servicio también permite ver las etiquetas que ya se han aplicado a los objetos.
| Campo | Tipo (longitud) | Descripción |
|---|---|---|
id |
Entero | Identificador de la etiqueta. Valor posible: 9 (Test/Control). |
name |
enumeración | Nombre de la etiqueta. Este campo es de solo lectura. Valor posible: "Test/Control". |
value |
string (100) | Valor asignado a la etiqueta. Este podría ser el nombre de en user_group_target el perfil asociado. |
Pixels
Nota:
Para poder asociar un píxel a una campaña, el píxel ya debe estar asociado al elemento de línea primario. Además, si cpc_bid_type es "predicted" y cpc_goal no está establecido, debe proporcionar un valor para o roi_click_goalroi_view_goal.
| Campo | Tipo | Descripción |
|---|---|---|
id |
Entero | Identificador del píxel de conversión. |
state |
enumeración | Estado del píxel de conversión. Valores posibles: "active" o "inactive". |
name |
string | Solo lectura. Nombre del píxel de conversión. |
roi_click_goal |
double | Si paga por impresión (CPM) y optimiza a un objetivo de CPA previsto, establezca este campo en el objetivo de clic. |
roi_view_goal |
double | Si paga por impresión (CPM) y optimiza a un objetivo de CPA previsto, establezca este campo en el objetivo de vista. |
click_payout |
double | Si paga por conversión (CPA), establezca este campo en la cantidad que se va a pagar al publicador por clic. |
view_payout |
double | Si paga por conversión (CPA), establezca este campo en la cantidad que se va a pagar al publicador por vista. |
Modelo de puja
El bid_model objeto contiene los campos siguientes.
| Campo | Tipo | Descripción |
|---|---|---|
id |
Entero | Identificador del modelo personalizado. Solo se permiten los modelos personalizados con model_output establecido "Bid" en . Use el servicio de modelo personalizado para recuperar estos identificadores. |
name |
string | Nombre del modelo personalizado. Solo lectura. |
active |
Booleano | Estado del modelo. Valores posibles: 1 (true) o 0 (false).Solo lectura. |
Modelo modificador de puja
El bid_modifier_model objeto contiene los campos siguientes.
| Campo | Tipo | Descripción |
|---|---|---|
id |
Entero | Identificador del modelo personalizado. Solo se permiten los modelos aduaneros con model_output establecido en "bid_modifier" . Use el servicio de modelo personalizado para recuperar estos identificadores. |
name |
string | Nombre del modelo personalizado. Solo lectura. |
active |
Booleano | Estado del modelo. Valores posibles: 1 (true) o 0 (false).Solo lectura. |
Primera ejecución/última ejecución
Para incluir los first_run campos y last_run en una GET respuesta, pase flight_info=true la cadena de consulta. También puedes filtrar las campañas en función de cuándo se atienden por primera y última vez, como se indica a continuación:
Recuperar solo las campañas que nunca han servido
Pase never_run=true la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&never_run=true'
Nota:
Puede usar never_run=true en combinación con otros filtros, pero tenga en cuenta que siempre será una relación OR. Por ejemplo, si pasa tanto never_run=true como min_first_run=2012-01-01 00:00:00 en la cadena de consulta, buscará campañas que nunca hayan servido elementos de línea OR que se hayan servido por primera vez en o después de 2012-01-01.
Recuperar solo las campañas que se sirvieron por primera vez en o después de una fecha específica
Pase min_first_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&min_first_run=2012-01-01+00:00:00'
Recuperar solo las campañas que se sirvieron por primera vez en o antes de una fecha específica
Pase max_first_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&max_first_run=2012-08-01+00:00:00'
Recuperar solo las campañas que se sirvieron por primera vez dentro de un intervalo de fechas específico
Pase min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&min_first_run=2012-01-01+00:00:00&max_first_run=2012-08-01+00:00:00'
Recuperar solo las campañas que se sirvieron por última vez en o después de una fecha específica
Pase min_last_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&min_last_run=2012-01-01+00:00:00'
Recuperar solo las campañas que se sirvieron por última vez en o antes de una fecha específica
Pase max_last_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&max_last_run=2012-08-01+00:00:00'
Recuperar solo las campañas que se sirvieron por última vez dentro de un intervalo de fechas específico
Pase min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS la cadena de consulta.
curl -b cookies -c cookies 'https://api.appnexus.com/campaign?advertiser_id=100&flight_info=true&min_last_run=2012-01-01+00:00:00&max_last_run=2012-08-01+00:00:00'
Alertas
Este campo le notifica las condiciones que impiden que la campaña sirva. Hay dos tipos de alertas: pausas y advertencias. Las pausas se consideran intencionadas y controladas por el usuario, mientras que las advertencias se consideran involuntarias. Por ejemplo, "El estado está establecido en inactivo" se considera una pausa, mientras que "No hay creatividades asociadas a esta campaña" se considera una advertencia.
Para recuperar campañas basadas en pausas o advertencias, debe pasar determinados parámetros de cadena de consulta en la GET solicitud. Consulte a continuación los casos de uso con parámetros y ejemplos de cadena de consulta. Tenga en cuenta que puede usar estos parámetros de cadena de consulta al recuperar todas las campañas o campañas específicas, pero los ejemplos siguientes solo cubren la recuperación de todas las campañas, ya que es donde esta característica ofrece más valor.
Recuperar todas las campañas y mostrar alertas
Pase show_alerts=true la cadena de consulta. Este parámetro agregará el alerts objeto a cada campaña de la respuesta, independientemente de si la campaña tiene pausas o advertencias.
Nota:
Para cada uno de los casos de uso siguientes, debe pasar show_alerts=true si desea que el alerts objeto aparezca en la respuesta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "inactive",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 2,
"message": "Parent line item is inactive."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58991,
"state": "active",
...
"alerts": {
"warnings": [
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58992,
"state": "inactive",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 2,
"message": "Parent line item is inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tengan al menos una pausa
Pase show_alerts=true&pauses=true la cadena de consulta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=true'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "active",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 8,
"message": "Flight end is in the past."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "inactive",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que no tienen pausas
Pase show_alerts=true&pauses=false la cadena de consulta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=false'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58991,
"state": "active",
...
"alerts": {
"warnings": [
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58992,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 2,
"message": "All creatives associated to this campaign are either ineligible to serve (inactive, expired, prohibited) or can serve only on direct inventory and on supply partners who trust your network's self-classification (unaudited)."
}
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tienen una pausa específica
Pase show_alerts=true&pauses=PAUSE_ID la cadena de consulta. Para los identificadores de pausa, consulte la tabla Pausas siguiente.
En este ejemplo, usamos el identificador de pausa 4 para recuperar todas las campañas con fechas de inicio de vuelos que estén en el futuro.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=4'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 66493,
"state": "inactive",
"start_date": "2012-10-01 00:00:00",
"end_date": null,
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 15:01:02"
}
},
{
"id": 66510,
"state": "active",
"start_date": "2012-9-01 00:00:00",
"end_date": null,
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 2,
"message": "Parent line item is inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 15:01:02"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tienen dos o más pausas específicas
Pase show_alerts=true&pauses=SUM_OF_PAUSE_IDS la cadena de consulta. Para los identificadores de pausa, consulte la tabla Pausas siguiente.
En este ejemplo, agregamos juntos el identificador de pausa 1 y el identificador de pausa 2 para recuperar todas las campañas establecidas en inactivas y cuyos elementos de línea también están establecidos en inactivos.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=3'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 66493,
"state": "inactive",
"start_date": "2012-10-01 00:00:00",
"end_date": null,
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 2,
"message": "Parent line item is inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 15:01:02"
}
},
{
"id": 66510,
"state": "inactive",
"start_date": "2012-9-01 00:00:00",
"end_date": null,
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 2,
"message": "Parent line item is inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 15:01:02"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tengan al menos una advertencia
Pase show_alerts=true&warnings=true la cadena de consulta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&warnings=true'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "inactive",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 2,
"message": "All creatives associated to this campaign are either ineligible to serve (inactive, expired, prohibited) or can serve only on direct inventory and on supply partners who trust your network's self-classification (unaudited)."
},
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que no tienen advertencias
Pase show_alerts=true&warnings=false la cadena de consulta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&warnings=false'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "inactive",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58991,
"state": "active",
...
"alerts": {
"warnings": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58992,
"state": "active",
...
"alerts": {
"warnings": [
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tienen una advertencia específica
Pase show_alerts=true&warnings=WARNING_ID la cadena de consulta. Para ver los identificadores de advertencia, consulte la tabla Advertencias a continuación.
En este ejemplo, usamos el identificador de advertencia 1 para recuperar todas las campañas que no tienen creatividades asociadas.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&warnings=1'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "inactive",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tengan al menos una pausa Y al menos una advertencia
Pase show_alerts=true&pauses=true&warnings=true la cadena de consulta.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=true&warnings=true'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "inactive",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 2,
"message": "Parent line item is inactive."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 58993,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 2,
"message": "All creatives associated to this campaign are either ineligible to serve (inactive, expired, prohibited) or can serve only on direct inventory and on supply partners who trust your network's self-classification (unaudited)."
}
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tienen una pausa específica Y una advertencia específica
Pase show_alerts=true&pauses=PAUSE_ID&warnings=WARNING_ID la cadena de consulta. Para ver los identificadores de pausa y advertencia, consulte las tablas Pausas y advertencias a continuación.
En este ejemplo, recuperamos todas las campañas que tienen una fecha de inicio de vuelo en el futuro (id. de pausa 4) Y que no tienen ninguna creatividad asociada (id. de advertencia 1).
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=4&warnings=1'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58990,
"state": "inactive",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Recuperar solo las campañas que tienen pausas o advertencias
Puede combinar los parámetros descritos anteriormente con alert_boolean_op=orpara recuperar campañas que tengan ciertas pausas o ciertas advertencias. Consulte los ejemplos siguientes. Para ver los identificadores de pausa y advertencia, consulte las tablas Pausas y advertencias a continuación.
Nota:
El alert_boolean_op=orparámetro solo se puede usar para recuperar campañas con pausas o advertencias. No se puede usar para buscar relaciones OR entre pausas (es decir, pausar 1 O pausar 2) o entre advertencias (es decir, advertencia 1 O advertencia 2).
En este ejemplo, recuperamos todas las campañas establecidas en inactivas (id. de pausa 1) O que no tienen creatividades aptas (id. de advertencia 2).
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=1&warnings=2&alert_boolean_op=or'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58934,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 2,
"message": "All creatives associated to this campaign are either ineligible to serve (inactive, expired, prohibited) or can serve only on direct inventory and on supply partners who trust your network's self-classification (unaudited)."
}
],
"pauses": [
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "inactive",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
En este ejemplo, recuperamos todas las campañas establecidas en inactivas (id. de pausa 1) O que no tienen advertencias.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=1&warnings=false&alert_boolean_op=or'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58934,
"state": "active",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "inactive",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
En este ejemplo, recuperamos todas las campañas que no tienen pausas O que no tienen advertencias.
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=false&warnings=false&alert_boolean_op=or'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58934,
"state": "active",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
En este ejemplo, recuperamos todas las campañas establecidas en inactivas (id. de pausa 1) Y cuyo elemento de línea principal está establecido en inactivo (id. de pausa 4) O que no tienen creatividades asociadas (id. de advertencia 1).
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=5&warnings=1&alert_boolean_op=or'
{
"response": {
"status": "OK",
"campaigns": [
{
"id": 58934,
"state": "inactive",
...
"alerts": {
"warnings": [
],
"pauses": [
{
"id": 1,
"message": "State is set to inactive."
},
{
"id": 4,
"message": "Flight start is in the future."
}
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
{
"id": 81287,
"state": "active",
...
"alerts": {
"warnings": [
{
"id": 1,
"message": "No creatives are associated with this campaign."
}
],
"pauses": [
],
"warnings_last_checked": "2012-07-27 14:40:36",
"pauses_last_checked": "2012-08-08 13:01:03"
}
},
...
],
...
}
}
}
Pausas
| Id. | Descripción |
|---|---|
| 1 | El estado se establece en inactivo. |
| 2 | El elemento de línea principal está inactivo. |
| 4 | El inicio del vuelo es en el futuro. |
| 8 | El final del vuelo está en el pasado. |
Advertencias
| Id. | Descripción |
|---|---|
| 1 | No hay creativos asociados a esta campaña. |
| 2 | Todas las creatividades asociadas a esta campaña no son aptas para servir (inactivas, expiradas, prohibidas) o solo pueden servir en el inventario directo y en los asociados de suministro que confían en la clasificación automática de la red (no auditada). |
Ejemplos
Ver la campaña 17607 para anunciante 9
$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?id=17607&advertiser_id=11'
{
"response": {
"status": "OK",
"campaign": {
"id": 167051,
"state": "inactive",
"code": null,
"advertiser_id": 11,
"line_item_id": 69405,
"creative_id": 851325,
"pixel_id": 16688,
"short_name": null,
"name": "My example campaign",
"profile_id": 752909,
"start_date": "2011-10-31 00:00:00",
"end_date": null,
"timezone": "EST5EDT",
"priority": 5,
"cadence_modifier_enabled": true,
"cpc_goal": null,
"cpm_bid_type": "predicted",
"base_bid": null,
"min_bid": null,
"max_bid": null,
"bid_margin": 0,
"roadblock_creatives": false,
"roadblock_type": "no_roadblock",
"inventory_type": "real_time",
"last_modified": "2014-05-28 16:06:01",
"max_learn_bid": null,
"cadence_type": "creative",
"click_url": null,
"require_cookie_for_tracking": true,
"allow_unverified_ecp": false,
"defer_to_li_prediction": false,
"ecp_learn_divisor": "3.000000",
"projected_learn_events": "3",
"learn_threshold": 3,
"cpc_payout": null,
"comments": null,
"optimization_version": "v7",
"learn_override_type": null,
"base_cpm_bid_value": null,
"impression_limit": 40000,
"bid_multiplier": 1,
"remaining_days": null,
"total_days": null,
"supply_type_action": "include",
"supply_type": "mobile_web, web",
"creatives": [
{
"id": 445832,
"code": null,
"name": "Donate car.png",
"width": "300",
"height": "250",
"state": "inactive",
"audit_status": "no_audit",
"is_expired": true,
"is_prohibited": false,
"is_self_audited": true,
"format": "image",
"pop_window_maximize": null
}
],
"pixels": [
{
"id": 16688,
"roi_click_goal": 5,
"roi_view_goal": 5,
"click_payout": null,
"view_payout": null,
"code": null,
"name": "123",
"state": "active",
"trigger_type": "hybrid"
}
],
"optimization_lookback": [
{
"day": "0",
"bias_percent": "50.000000"
},
{
"day": "1",
"bias_percent": "50.000000"
},
{
"day": "2",
"bias_percent": "50.000000"
},
{
"day": "3",
"bias_percent": "50.000000"
},
{
"day": "4",
"bias_percent": "50.000000"
},
{
"day": "5",
"bias_percent": "50.000000"
},
{
"day": "6",
"bias_percent": "50.000000"
},
{
"day": "7",
"bias_percent": "50.000000"
},
{
"day": "8",
"bias_percent": "50.000000"
},
{
"day": "9",
"bias_percent": "50.000000"
},
{
"day": "10",
"bias_percent": "50.000000"
},
{
"day": "11",
"bias_percent": "50.000000"
},
{
"day": "12",
"bias_percent": "50.000000"
},
{
"day": "13",
"bias_percent": "50.000000"
},
{
"day": "14",
"bias_percent": "50.000000"
},
{
"day": "15",
"bias_percent": "50.000000"
},
{
"day": "16",
"bias_percent": "50.000000"
},
{
"day": "17",
"bias_percent": "50.000000"
},
{
"day": "18",
"bias_percent": "50.000000"
},
{
"day": "19",
"bias_percent": "50.000000"
},
{
"day": "20",
"bias_percent": "50.000000"
},
{
"day": "21",
"bias_percent": "50.000000"
},
{
"day": "22",
"bias_percent": "50.000000"
},
{
"day": "23",
"bias_percent": "50.000000"
},
{
"day": "24",
"bias_percent": "50.000000"
},
{
"day": "25",
"bias_percent": "50.000000"
},
{
"day": "26",
"bias_percent": "50.000000"
},
{
"day": "27",
"bias_percent": "50.000000"
},
{
"day": "28",
"bias_percent": "50.000000"
},
{
"day": "29",
"bias_percent": "50.000000"
}
],
"campaign_modifiers": null,
"labels": [
{
"id": "9",
"name": "Test/Control",
"value": "Test pattern - Group 1"
}
],
"broker_fees": null,
"valuation": null,
"lifetime_budget": 16000,
"lifetime_budget_imps": null,
"daily_budget": 500,
"daily_budget_imps": null,
"enable_pacing": true,
"allow_safety_pacing": true,
"lifetime_pacing": false,
"lifetime_pacing_span": null
},
"count": 1,
"start_element": 0,
"num_elements": 100
}
}
Creación de una campaña directa
Este código representa la información mínima necesaria para crear una campaña inactiva para el inventario directo sin creatividades ni segmentación.
$ cat create-campaign.json
{
"campaign": {
"state": "inactive",
"name": "Rich's cool campaign",
"advertiser_id": 11,
"line_item_id": 47726,
"inventory_type": "direct"
}
}
$ curl -b cookies 'https://api.appnexus.com/campaign?advertiser_id=11'
{
"response": {
"status": "OK",
"id": 11,
"dbg_info": {
...
}
}
}