API de plataforma digital: servicio de pedido de inserción

Artículo
05/18/2024

Los pedidos de inserción le permiten organizar, realizar un seguimiento y asignar mejor el presupuesto a las partidas individuales. Además, los intervalos presupuestados (es decir, conjuntos de fechas de vuelo cada uno con su propio ritmo y presupuesto) se pueden usar en pedidos de inserción, lo que le permite representar el presupuesto disponible de forma que refleje con mayor precisión su contrato con un anunciante. Xandr sugiere el uso de pedidos de inserción e intervalos de presupuesto.

Los pedidos de inserción se pueden asociar a uno o varios elementos de línea. Una línea de pedido puede pertenecer a varios pedidos de inserción, siempre y cuando los intervalos presupuestados en esos pedidos de inserción no se superpongan.

Nota:

Los pedidos de inserción se habilitan en el nivel anunciante mediante el Servicio de anunciante (el use_insertion_orders campo de ese servicio debe establecerse "true"en ).
Los elementos de línea se crean a través de Line Item Service - ALI (o Line Item Service para los elementos de línea heredados).

Pedidos de inserción sin problemas

Hay dos tipos de pedidos de inserción:

Sin problemas : orden de inserción sin problemas para los elementos de línea que proporcionan configuraciones de destino y presupuestación adicionales. La budget_type configuración de pedidos de inserción de conexión directa puede restringir los artículos de línea aumentadas de entrega garantizada (GDALI) y los elementos de línea garantizados por programación (PGLI) asociados que tienen configuraciones en conflicto. Se recomienda usar pedidos de inserción sin problemas con budget_type establecido "flexible" en para GDALIs y PGLIs para que pueda asociar elementos de línea basados en impresiones y basados en ingresos al mismo orden de inserción.
Heredado (sin conexión): orden de inserción heredado necesario para los elementos de línea heredados garantizados y no garantizados. Los pedidos de inserción heredados no usan la budget_intervals matriz y no se pueden usar con elementos de línea aumentadas (ALI), entrega garantizada de elementos de línea aumentadas (GDALI) y elementos de línea garantizados mediante programación (PGLI).

Las principales diferencias en la configuración para cada tipo de orden de inserción son las siguientes:

Para crear un orden de inserción de conexión directa , debe:
- Use los campos relacionados con el presupuesto y el ritmo, y los start_date campos y end_date de la budget_intervals matriz para especificar las fechas durante las que se debe ejecutar el orden de inserción, qué presupuesto está disponible para él durante esas fechas y cómo se debe ajustar el gasto del presupuesto.
- Deje los start_date campos y end_date (y los campos relacionados con el presupuesto o el ritmo) en el nivel de orden de inserción principal establecido null en (configuración predeterminada).
- Asocie solo elementos de línea de conexión directa con pedidos de inserción sin problemas. Para obtener instrucciones sobre cómo crear elementos de línea sin problemas, consulte Servicio de elementos de línea - ALI.
Para crear un orden de inserción heredado (no sin conexión), debe:
- Use los campos relacionados budget y pacing y los start_date campos y end_date del objeto de orden de inserción principal para especificar las fechas durante las que se debe ejecutar el orden de inserción, qué presupuesto está disponible para él durante esas fechas y cómo se debe ajustar el gasto del presupuesto.
- Asegúrese de que el budget_intervals campo está establecido en null.
- Asocie solo elementos de línea que no sean de conexión directa con pedidos de inserción no sin conexión. Para obtener instrucciones sobre cómo crear elementos de línea que no sean de conexión directa, consulte Servicio de elementos de línea.

Importante

Los pedidos de inserción sin problemas son el modelo preferido. Debe usar el flujo de trabajo de orden de inserción sin problemas al crear nuevos pedidos de inserción. No se puede convertir un orden de inserción sin conexión a elementos de línea sin conexión o vincularlos a pedidos de inserción sin problemas.

En la interfaz de usuario, la API budget_intervals se conoce como "Períodos de facturación".

Nota:

Pedidos de inserción para artículos de línea aumentada de entrega garantizada (GDALI)

Para que una orden de inserción se asocie a una línea de pedido aumentada de entrega garantizada (GDALI), el orden de inserción debe:

Ser un orden de inserción sin problemas (los pedidos de inserción heredados no son compatibles).
Se ha budget_type establecido en "flexible" o "impression".
No contiene más de una budget_intervals matriz.
Tener presupuesto ilimitado (establecido a través de la budget_intervals matriz).

Los pedidos de inserción que no coincidan con los anteriores solo pueden asociarse a elementos de línea no garantizados. La configuración anterior también es necesaria para los elementos de línea garantizados mediante programación (PGLI). Un orden de inserción con la configuración anterior también puede asociarse a elementos de línea no garantizados.

La asociación de un profile_id objeto (por ejemplo, límite de frecuencia o establecimiento de destinos adicionales) en el objeto de orden de inserción puede dar lugar a una previsión o entrega inesperadas de PGLIs y GDALIs. Se recomienda no usar profile_id para los pedidos de inserción destinados al uso con GDALIs.

API de REST

Http (método)	Endpoint	Description
`POST`	https://api.appnexus.com/insertion-order?advertiser_id=ADVERTISER_ID (JSON del orden de inserción)	Agregue un nuevo orden de inserción.
`PUT`	https://api.appnexus.com/insertion-order?id=INSERTIONORDER_ID& advertiser_id=ADVERTISER_ID (JSON del orden de inserción)	Modifique un orden de inserción existente.
`GET`	https://api.appnexus.com/insertion-order?advertiser_id=ADVERTISER_ID	Vea todos los pedidos de inserción de uno de sus anunciantes.
`DELETE`	https://api.appnexus.com/insertion-order?id=INSERTIONORDER_ID& advertiser_id=ADVERTISER_ID Importante: La eliminación de un pedido de inserción no significa necesariamente que se eliminen los elementos de línea asociados, ya que la relación entre un pedido de inserción y un elemento de línea puede ser de varios a varios. Además, la eliminación de un pedido de inserción da como resultado la eliminación de los intervalos de presupuesto asociados.	Elimine un orden de inserción.
`GET`	https://api.appnexus.com/insertion-order?id=INSERTIONORDER_ID	Vea un pedido de inserción específico para uno de sus anunciantes.
`GET`	https://api.appnexus.com/insertion-order?id=1,2,3	Vea varios pedidos de inserción por identificador mediante una lista separada por comas.
`GET`	https://api.appnexus.com/insertion-order?search=SEARCH_TERM	Busque pedidos de inserción con identificadores o nombres que contengan determinados caracteres.
`GET`	https://api.appnexus.com/insertion-order/meta	Averigüe por qué campos puede filtrar y ordenar.

Campos JSON

Campo	Tipo	Descripción
`id`	Entero	Identificador del orden de inserción. Obligatorio activado:`PUT`
`name`	string	Nombre del orden de inserción. (Máximo de 255 caracteres). Obligatorio activado:`POST`
`code`	string	Código personalizado para el orden de inserción. 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, elementos de línea) 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. Nota: También puede haber un código personalizado por intervalo de presupuesto. Para obtener más información, consulte la matriz Intervalos de presupuesto a continuación. Predeterminado:`null`
`state`	enumeración	Estado del orden de inserción. Valores posibles: `"active"` o `"inactive"`. Predeterminado:`"active"`
`advertiser_id`	Entero	El identificador del anunciante. Obligatorio activado:`POST`
`start_date`	Timestamp	La fecha de inicio del orden de inserción sin problemas. Si va a crear un orden de inserción sin problemas, no establezca este campo. Predeterminado:`null` (inmediatamente)
`end_date`	Timestamp	Fecha de finalización del pedido de inserción sin problemas. Si va a crear un orden de inserción sin problemas, no establezca este campo. Predeterminado:`null` (indefinidamente)
`remaining_days`	Entero	Número de días entre hoy y el `end_date` de la orden de inserción. Nota: Esto será `null` si es `start_date` 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 el orden de inserción. Nota: Esto será `null` si `start_dateend_date` o no está establecido. Solo lectura.
`last_modified`	Timestamp	Hora de la última modificación de esta campaña. Solo lectura.
`timezone`	string	Zona horaria por la que se cuenta el presupuesto y el gasto. Para obtener una lista de valores de zona horaria aceptables, consulte Zonas horarias de API. Nota: Cualquier `PUT` llamada al `advertiser` servicio que incluya `set_child_timezone=true` en la cadena de consulta hará que cualquier configuración de zona horaria de los objetos de nivel inferior (por ejemplo, pedidos de inserción, elementos de línea) se invalide con el valor de zona horaria más reciente para ese anunciante. Predeterminado:`"EST5EDT"` o la zona horaria del anunciante.
`currency`	string	Moneda asignada al orden de inserción. Para obtener una lista completa de las monedas disponibles, use el servicio de moneda de solo lectura. Nota: Una vez creado el orden de inserción, no se puede cambiar la moneda. Predeterminado: Moneda predeterminada del anunciante.
`comments`	string	Comentarios sobre el orden de inserción.
`billing_code`	string	El código de facturación del pedido de inserción. Esto solo aparecerá en las facturas específicas del pedido de inserción (por ejemplo, si recibe una factura por pedido de inserción). Para obtener más información sobre las facturas, consulte "Descripción de la factura" en la documentación de Finanzas. Predeterminado:`null`
`line_items`	matriz de objetos	Elementos de línea asociados al orden de inserción. Para obtener más información, vea Elementos de línea a continuación. Nota: Los pedidos de inserción sin problemas solo pueden estar asociados a elementos de línea de conexión directa. Los pedidos de inserciones no directas solo pueden asociarse a elementos de línea no sin conexión.
`labels`	matriz de objetos	Etiquetas asignadas al orden de inserción. Consulte Etiquetas a continuación.
`broker_fees`	matriz de objetos	Advertencia: Para los elementos de línea aumentadas (ALI): Las tarifas de broker están en desuso para los artículos de línea aumentadas. Cree tarifas de asociados y aplíquelas al artículo de línea mediante el Servicio de tarifas de asociados. Para los elementos de línea estándar: - Las tarifas de broker creadas en un pedido de inserción solo se aplican a las líneas de pedido estándar. Si también usa artículos de línea aumentadas, deberá crear y aplicar tarifas de asociados a las ALIs mediante el Servicio de tarifas de asociados. - Las tarifas de broker en el nivel de artículo de línea invalidan las cuotas de agente en el nivel de pedido de inserción. Las comisiones que la red debe pasar a los agentes al servir un anuncio. Estas comisiones se deducen de los ingresos reservados (la cantidad que recibe la red del anunciante) y suelen ser para negociar una relación con el anunciante. Pueden ser un porcentaje de los ingresos o un CPM plano. Para obtener más detalles, vea Cuotas de broker a continuación.
`budget_intervals`	matriz de objetos	Nota: Esta matriz solo es relevante y necesaria para los pedidos de inserción sin problemas (si el orden de inserción no es sin conexión, deje este campo establecido en `null`). Los intervalos de presupuesto permiten adjuntar varios intervalos de fecha a un pedido de inserción, cada uno con los valores presupuestados correspondientes. Para obtener más información, consulte Intervalos de presupuesto a continuación. Nota: Si usa `budget_intervals`, no se deben usar los siguientes campos en el objeto de orden de inserción de nivel superior: - `lifetime_pacing` - `lifetime_budget` - `lifetime_budget_imps` - `enable_pacing` - `lifetime_pacing_span` - `allow_safety_pacing` - `daily_budget` - `daily_budget_imps` - `lifetime_pacing_pct`
`budget_type`	enumeración	Tipo de presupuesto de la orden de inserción. Los valores pueden ser `'revenue'`, `'impression'`o `'flexible'`. - Si este campo está establecido en `'impression'` , los `lifetime_budget` campos y `daily_budget` deben establecerse en `null`. - Si este campo está establecido en `'revenue'` , los `lifetime_budget_imps` campos y `daily_budget_imps` deben establecerse en `null`. - Este campo debe establecerse cuando los cuatro campos presupuestados de la `budget_intervals` matriz (`lifetime_budget`, `lifetime_budget_imps`, `daily_budget`y `daily_budget_imps`) se hayan establecido `null`en . - Si este campo está establecido `'flexible'` en , la `budget_intervals` matriz solo puede tener un intervalo y los cuatro campos de presupuesto de la `budget_intervals` matriz (`lifetime_budget`, `lifetime_budget_imps`, `daily_budget`y `daily_budget_imps`) deben establecerse `null`en .
`lifetime_pacing`	booleano	Si `true`es , el orden de inserción sin problemas intentará gastar su presupuesto total de duración uniformemente en las fechas de vuelo del pedido de inserción. Si `true`: - Debe establecer o `lifetime_budgetlifetime_budget_imps`. - Debe establecer y `start_dateend_date`. - No se puede establecer .`daily_budget` - No se puede establecer en `enable_pacingfalse`. Nota: Solo se aplica a los pedidos de inserción no sin conexión. Predeterminado:`null`
`lifetime_budget`	double	Presupuesto de duración en ingresos. El campo define la moneda de `currency` ingresos. Nota: Solo se aplica a los pedidos de inserción no sin conexión. Predeterminado:`null` (ilimitado)
`lifetime_budget_imps`	Entero	Presupuesto de duración en impresiones. Nota: Si agrega elementos de línea a este orden de inserción, cualquier gasto ya asociado a esos elementos de línea antes de que se agreguen al orden de inserción NO se cuenta con respecto al presupuesto de duración del pedido de inserción. Solo se cuenta el gasto que se produce mientras el elemento de línea es un elemento secundario del orden de inserción. Solo se aplica a los pedidos de inserción no sin conexión. Predeterminado:`null` (ilimitado)
`enable_pacing`	booleano	Si `true`es , los gastos se recorrerán a lo largo del día. Solo se aplica si hay un objeto `daily_budget`. Nota: Solo se aplica a los pedidos de inserción no sin conexión.
`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. Nota: Solo se aplica a los pedidos de inserción no sin conexión. Predeterminado:`null` (3 días)
`daily_budget`	double	Presupuesto diario en ingresos. El campo define la moneda de `currency` ingresos. Nota: Si agrega elementos de línea a este orden de inserción, las impresiones asociadas a esos elementos de línea cuando se agregan al orden de inserción NO se cuentan en el presupuesto de duración del pedido de inserción. Solo se cuentan las impresiones que se producen mientras el elemento de línea es un elemento secundario del orden de inserción. Solo se aplica a los pedidos de inserción no sin conexión. Predeterminado:`null` (ilimitado)
`daily_budget_imps`	Entero	El presupuesto diario en impresiones. Nota: Solo se aplica a los pedidos de inserción no sin conexión. Predeterminado:`null` (ilimitado)
`lifetime_pacing_pct`	double	Un entero doble entre (e incluido) 50 y 150, que se usa para establecer el ritmo durante toda la duración del orden de inserción. Los valores posibles pueden ser cualquier doble entre 50 y 150 en la escala siguiente: - `50`: ritmo de retraso programado. - `100`: pace uniformemente. - `150`: el ritmo se adelanta a lo programado. Nota: Solo se aplica a los pedidos de inserción no sin conexión. Aviso alfa-beta Este campo o característica forma parte de la funcionalidad actualmente en la fase Alfa o Beta. Por lo tanto, está sujeto a cambios. Predeterminado:`100`
`profile_id`	Entero	Especifica el identificador del perfil adjunto al orden de inserción sin problemas (es decir, debe usar budget_intervals). Se puede usar un perfil para definir cómo se destina el inventario o cómo se aplica el límite de frecuencia (para obtener más información, consulte Servicio de perfiles). También se puede establecer un perfil en los niveles de anunciante, artículo de línea, campaña y creatividad. La configuración más restrictiva siempre tiene prioridad.
`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.
`object_stats`	objeto	Número de elementos de línea totales, activos e inactivos en el orden de inserción. Para incluir este objeto en una respuesta GET, pase `object_stats=true` la cadena de consulta. Solo lectura.
`viewability_standard_provider`	string	Este campo determina con qué estándar medir la visibilidad. Por ejemplo, `iab`. Nota: Este campo no se puede editar y solo aparece en pedidos de inserción sin problemas. Predeterminado:`'iab'`
`is_running_political_ads`	booleano	Declara si este orden de inserción contiene o no publicidad política (definida como publicidad relacionada con una elección, iniciativa de votación o candidato político, en los Estados Unidos). Si `true`es , el `political_content` objeto es editable. Si `true`es , y si el orden de inserción tiene como destino un estado con requisitos de informes políticos adicionales, se requieren muchos campos en `political_content` el objeto . Para obtener más información sobre los requisitos estatales, consulte Implementación de directivas de publicidad política. Para obtener más información sobre el `political_content` objeto, vea Contenido político a continuación. `is_running_political_ads` debe establecerse `true` en el anunciante que se va a establecer `true` en en el orden de inserción. Para obtener más información, consulte el Servicio de anunciantes. Predeterminado:`0false`
`political_content`	objeto	Información sobre la publicidad política realizada con este orden de inserción. La publicidad política debe estar habilitada en el anunciante y en este orden de inserción para que este objeto sea editable. (Es decir, el campo `is_running_political_ads` debe estar `true` tanto en el anunciante como en el orden de inserción). Para obtener más información sobre este objeto, vea Contenido político a continuación.

Elementos de línea

Cada objeto de la line_items matriz contiene los campos siguientes.

Campo	Tipo	Descripción
`id`	Entero	Identificador numérico asociado a este elemento de línea. Obligatorio activado:`POST` o `PUT`.
`line_item_type`	enumeración	Tipo asociado al elemento de línea secundario. Los posibles valores son: - `"standard_v1"`: indica que el elemento de línea secundario es un elemento de línea estándar. - `"standard_v2"`: indica que el elemento de línea secundario es un elemento de línea aumentada. - `"guaranteed"`: indica que el elemento de línea secundario es un elemento de línea garantizado. - `"performance"`: este tipo de elemento de línea ha quedado en desuso.
`name`	string	Nombre del elemento de línea.
`code`	string	Si ha elegido asociar un nombre de identificación opcional (un "código") a este elemento de línea, se mostrará aquí.
`state`	string	Los elementos de línea pueden ser `"active"` o `"inactive"`.
`end_date`	date	Fecha en la que los artículos de línea dejan de servir.
`start_date`	date	Fecha en la que los artículos de línea comienzan a servir.
`timezone`	string	Zona horaria en la que se establece el elemento de línea. Esto afectará a y `start_dateend_date`.

Etiquetas

Puede usar el servicio de etiquetas de solo lectura para ver todas las etiquetas posibles para artículos de línea, anunciantes, pedidos de inserción y publicadores. Este servicio también permite ver las etiquetas que ya se han aplicado al orden de inserción.

Campo	Tipo	Descripción
`value`	string (100)	Valor asignado a la etiqueta. Por ejemplo, para la `"Sales Rep"` etiqueta, podría ser un nombre como `"Michael Sellers"`.
`id`	Entero	Identificador de la etiqueta. Obligatorio activado:`POST` o `PUT`.
`name`	enumeración	Nombre de la etiqueta. Posibles valores: - `"Trafficker"` - `"Sales Rep"` - `"Campaign Type"`

Tasas de broker

Advertencia

Para los elementos de línea aumentadas (ALI):

Las tarifas de broker están en desuso para los artículos de línea aumentadas. Cree tarifas de asociados y aplíquelas al artículo de línea mediante el Servicio de tarifas de asociados.

Para los elementos de línea estándar:

Las tarifas de agente creadas en un pedido de inserción solo se aplican a los artículos de línea estándar. Si también usa artículos de línea aumentadas, deberá crear y aplicar tarifas de asociados a las ALIs mediante el Servicio de tarifas de asociados.
Las tarifas del agente en el nivel de artículo de línea invalidan las cuotas del agente en el nivel de pedido de inserción.

Nota:

La compatibilidad con la posición decimal para las cuotas de agente en la interfaz de usuario es de 1 lugar después del decimal. Por ejemplo, si establece el 16,67 % como tasa de agente en la sección Comisiones, después de guardar, el valor se redondearía al 16,7 %. Sin embargo, no hay ninguna restricción en el número de posiciones después de decimal si se usa la API del servicio de pedido de inserción para crear la cuota del agente.

Cada objeto de la broker_fees matriz contiene los campos siguientes.

Campo	Tipo	Descripción
`broker_id`	Entero	Identificador del agente.
`payment_type`	enumeración	Tipo de pago al agente. Posibles valores: - `"cpm"` - `"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.

Intervalos de presupuesto

Nota:

Esta matriz solo se usa para pedidos de inserción sin problemas.

Tenga en cuenta lo siguiente al usar la budget_interval matriz:

Los intervalos de presupuesto deben contener y start_dateend_date.
Los intervalos de fechas (es decir, start_date, end_date) de intervalos de presupuesto diferentes en el mismo orden de inserción no se pueden superponer.
Los intervalos de presupuesto deben contener o lifetime_budgetlifetime_budget_imps.
Los intervalos presupuestarios no se pueden usar si se establecen campos de presupuesto en el insertion_order propio objeto.
Las modificaciones realizadas en el intervalo presupuestado (por ejemplo, las fechas de inicio o finalización) en el orden de inserción deben replicarse manualmente en todos los elementos de línea secundarios (mediante el line-item servicio).
- Para los elementos de línea estándar , use parent_interval_id para vincular el elemento de línea a su orden de inserción primario. Las fechas del intervalo presupuestado se heredarán automáticamente por el elemento de línea una vez realizada esa asociación. Consulte Servicio de elementos de línea.
- En el caso de las partidas individuales aumentadas (ALI), asegúrese de que las fechas de inicio y finalización de cada intervalo presupuestado se encuentren dentro de las fechas de los intervalos presupuestados de la orden de inserción primaria. Consulte Servicio de elementos de línea (aumentada).
Se puede crear un máximo de 52 intervalos de presupuesto por orden de inserción.
Si desea que el intervalo presupuestado tenga un presupuesto ilimitado, los 4 campos de presupuesto de la matriz (lifetime_budget, lifetime_budget_imps, daily_budgety daily_budget_imps) deben establecerse nullen . Esto solo se permite si el lifetime_pacing campo está establecido en "false".

Cada objeto de la budget_intervals matriz contiene los campos siguientes.

Campo	Tipo	Descripción
`id`	Entero	Identificador del intervalo presupuestado.
`start_date`	Timestamp	Fecha de inicio del intervalo presupuestado. El formato debe ser AAAA-MM-DD hh:mm:ss (hh:mm:ss debe establecerse en `00`).
`end_date`	Timestamp	Fecha de finalización del intervalo presupuestado. El formato debe ser AAAA-MM-DD hh:mm:ss (hh:mm:ss debe establecerse en `23:59:59`). Si este campo se establece `null`en , el intervalo presupuestado del pedido de inserción se ejecutará indefinidamente. Si establece este campo en `'null'`: - Puede que no haya más de un objeto en la `budget_intervals` matriz (es decir, un intervalo de presupuesto máximo de 1). - El `lifetime_pacing` campo debe establecerse `"false"`en . - El `"daily_budget"` campo debe establecerse en `null`.
`timezone`	string	Zona horaria por la que se cuenta el presupuesto y el gasto. Para obtener una lista de valores de zona horaria aceptables, consulte Zonas horarias de API. El valor predeterminado es `"EST5EDT"` o la zona horaria del anunciante.
`code`	string	Código personalizado para el intervalo presupuestado. 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).
`lifetime_budget`	double	Presupuesto de duración en ingresos para el intervalo presupuestado. El campo del objeto define la `currency` moneda de `insertion_order` ingresos. Nota: Si también establece el `lifetime_budget_imps` campo dentro de esta matriz, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos.
`lifetime_budget_imps`	Entero	Presupuesto de duración en impresiones para el intervalo presupuestado. Nota: Si agrega elementos de línea a este orden de inserción, cualquier gasto ya asociado a esos elementos de línea antes de que se agreguen al orden de inserción no se cuenta con respecto al presupuesto de duración del pedido de inserción. Solo se cuenta el gasto que se produce mientras el elemento de línea es un elemento secundario del orden de inserción. Este campo tiene `null` como valor predeterminado (ilimitado). Nota: Si también establece el `lifetime_budget` campo dentro de esta matriz, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos.
`lifetime_pacing`	booleano	Si `true`es , el orden de inserción intentará escalar el presupuesto de duración uniformemente durante el intervalo presupuestado. Si `true`: - Debe establecer o `lifetime_budgetlifetime_budget_imps`. - Debe establecer y `start_dateend_date`. No se puede establecer un objeto `daily_budget`. - No se puede establecer en `enable_pacingfalse`.
`daily_budget`	double	Nota: Este campo tiene `null` como valor predeterminado (ilimitado). En su lugar, use el elemento de línea para establecer este valor. Si también establece el `daily_budget_imps` campo dentro de esta matriz, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos.
`daily_budget_imps`	Entero	Nota: Este campo tiene `null` como valor predeterminado (ilimitado). En su lugar, use el elemento de línea para establecer este valor. Si también establece el `daily_budget` campo dentro de esta matriz, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos.
`enable_pacing`	booleano	Si `true`es , los gastos se recorrerán a lo largo del día. Solo se aplica si hay un objeto `daily_budget`.
`lifetime_pacing_pct`	double	Nota: Establezca este campo en `100` (valor predeterminado) y, a continuación, use el elemento de línea para establecer el ritmo de duración. Entero doble entre (e incluido) 50 y 150, que se usa para establecer el ritmo a lo largo de un intervalo presupuestado. Los valores posibles pueden ser cualquier doble entre 50 y 150 en la escala siguiente: - `50`: ritmo de retraso programado. - `100`: pace uniformemente. - `150`: el ritmo se adelanta a lo programado.

Contenido político

Esta matriz solo se podrá editar si:

is_running_political_ads es cierto en el Servicio de anunciantes.
is_running_political_ads es true en el orden de inserción.

Estos campos deben rellenarse si usted está usando esta orden de inserción para la publicidad relacionada con una elección, iniciativa de votación, o candidato político a nivel local o estatal en los Estados Unidos, o para la publicidad relacionada con la elección federal o candidato político en el estado de Washington. No son necesarias para la publicidad política a nivel federal en otros estados.

Advertencia

No validamos los campos necesarios para asegurarnos de que estén presentes al crear un pedido de inserción, pero su creatividad para publicidad política estatal o local o publicidad federal dirigida al estado de Washington no servirá si los campos no se rellenan. Cualquier actualización del political_content objeto debe incluir todos los campos necesarios o la publicación de anuncios puede interrumpirse.

Campo	Tipo	Descripción
`billing_name`	string	Nombre de la persona u organización que está comprando anuncios en Xandr. Esto se rellenará automáticamente con el nombre del miembro Xandr. Solo lectura.
`billing_address_1`	string(255)	Dirección de la calle para la persona u organización que está comprando anuncios en Xandr. Escriba los detalles de contacto de la persona o equipo que mejor pueda responder a cualquier pregunta sobre la publicidad política en este pedido de inserción. Necesario.
`billing_address_2`	string(255)	Línea adicional opcional para la dirección de facturación de la persona u organización que está comprando anuncios en Xandr.
`billing_city`	string(100)	Ciudad de la dirección de facturación de la persona u organización que está comprando anuncios en Xandr. Necesario.
`billing_region`	string(50)	Estado o región de la dirección de facturación de la persona u organización que está comprando anuncios en Xandr. Necesario.
`billing_postal_code`	string(50)	Código POSTAL o postal de la dirección de facturación de la persona u organización que está comprando anuncios en Xandr. Necesario.
`billing_country`	string(50)	País de la dirección de facturación de la persona u organización que está comprando anuncios en Xandr. Necesario.
`billing_phone_code`	string(10)	Código de país para el número de teléfono de la persona u organización que está comprando anuncios en Xandr. Necesario.
`billing_phone`	string(50)	Póngase en contacto con el número de teléfono de la persona u organización que está comprando anuncios en Xandr. Necesario.
`us_fecid`	string(50)	Número de identificación asignado por el Comité Federal de Elecciones de EE. UU.
`organization_name`	string(100)	Nombre de la persona, grupo, organización o empresa que está publicitando (el cliente que le está pagando). Por ejemplo, un candidato, una agencia o un consultor político. Necesario.
`organization_address_1`	string(255)	Dirección de la persona, grupo, organización o empresa que está publicitando. Por ejemplo, un candidato, una agencia o un consultor político. Necesario.
`organization_address_2`	string(255)	Segunda línea opcional para la dirección de la persona, grupo, organización o empresa que está publicitando.
`organization_city`	string(100)	Ciudad en la dirección de la persona, grupo, organización o negocio que está publicitando. Necesario.
`organization_region`	string(50)	Estado o región en la dirección de la persona, grupo, organización o empresa que está publicitando. Necesario.
`organization_postal_code`	string(50)	Código postal o postal de la persona, grupo, organización o empresa que está publicitando. Necesario.
`organization_country`	string(50)	País de la persona, grupo, organización o empresa que está publicitando. Necesario.
`organization_phone_code`	string(10)	Código de país para el número de teléfono de la persona, grupo, organización o empresa que está publicitando. Necesario.
`organization_phone`	string(50)	Número de teléfono de la persona, grupo, organización o empresa que está publicitando. Necesario.
`treasurer_name`	string(100)	Tesorero del comité que compra los anuncios, o el individuo cuyo rol se ajustaría más estrechamente al de un tesorero. Necesario.
`payment_method_type`	enum(1)	Cómo le paga la organización política. Las opciones son: - `"Direct Debit"` - `"Check"` - `"Credit Card"` - `"Other"`. Si está seleccionado, `payment_method_other` es necesario. Necesario.
`political_objective`	string(255)	La iniciativa de candidato o votación que se apoya o se opone. Esto se asigna al campo Asunto de anuncios de la interfaz de usuario. Necesario.
`payment_method_other`	string(50)	Si `"4"` (Otro) está seleccionado para `payment_method_type`. Detalles de cómo se le paga por publicidad política. Necesario.
`is_independent_expenditure_committee`	Booleano	Especifica si algún anuncio está siendo pagado por un comité de gastos independiente: es decir, un tercero que gasta dinero en comunicaciones políticas que abogan expresamente por la elección o derrota de un candidato claramente identificado y no se coordina con un candidato, un comité autorizado de un candidato o un agente del candidato. Necesario.
`registration_form`	matriz	Requerido para NY y NJ cuando `is_independent_expenditure_committee` es `true`. El estado de Nueva York y Nueva Jersey requieren copias de los formularios de registro del estado de los comités de gastos independientes que realizan compras. Los creativos no servirán en el estado de Nueva York o Nueva Jersey hasta que se cargue el formulario. Los formularios deben cargarse con el servicio de formularios de registro para poder especificar su ubicación en esta matriz. La matriz debe tener el formato siguiente: `{"file_path": "PATH_AND_FILE_NAME_OF_THE_UPLOADED_FILE"}`
`is_ineligible`	Booleano	Le notifica si todos los campos necesarios de la `political_content` matriz se han rellenado (excepto `registration_form`) para la publicidad política en el nivel estatal o local. Si el valor es `true`, las creatividades no servirán. El valor se vuelve a calcular cada vez que se actualiza el orden de inserción. Nota: Si `is_ineligible` es `false`, es posible que se prohíba que las creatividades presten servicio, en función de otros factores, como si la creatividad ha superado la auditoría o si se ha cargado un formulario de registro para compras de anuncios en estados que lo requieran. Para obtener más información sobre la auditoría creativa, consulte "Solución de problemas creativos y preguntas más frecuentes" en la documentación de la interfaz de usuario. Solo lectura.
`government_level`	enumeración	Si `is_running_political_ads` es `true`. Los valores permitidos son: - `state or local` - `federal` - `both` (valor predeterminado) Necesario.
`is_accuracy_acknowledged`	Booleano	Especifica que el miembro Xandr ha certificado que la `political_content` información proporcionada es precisa y actualizada y que Xandr se basa en la precisión de la información proporcionada. Si se establece en `0` (valor predeterminado), no se permitirá que los creativos sirvan. Necesario.

Estadísticas

Advertencia

El stats objeto ha quedado en desuso (17 de octubre de 2016). En su lugar, use el servicio de informes para obtener información estadística.

Ejemplos

Adición de un nuevo orden de inserción sin problemas con intervalos de presupuesto

$ cat insertion-order.json
{
    "insertion-order": {
        "name": "My Insertion Order LH_EP",
        "budget_intervals": [

            {
                "start_date": "2030-10-10 00:00:00",
                "end_date": "2030-10-12 23:59:59",
                "daily_budget": null,
                "daily_budget_imps": 10,
                "enable_pacing": true,
                "lifetime_budget": null,
                "lifetime_budget_imps": 980,
                "lifetime_pacing": false
            },
            {
                "start_date": "2030-10-13 00:00:00",
                "end_date": "2030-10-18 23:59:59",
                "daily_budget": null,
                "daily_budget_imps": 10,
                "enable_pacing": true,
                "lifetime_budget": null,
                "lifetime_budget_imps": 6,
                "lifetime_pacing": false
            }
        ]
    }
}
$ curl -b cookies -X POST -d @insertion-order.json "https://api.appnexus.com/insertion-order?advertiser_id=11'

{
   "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 100,
    "insertion-orders": [
        {
            "id": 45797,
            "name": "MyInsertionOrderLH_EP",
            "code": null,
            "state": "active",
            "advertiser_id": 64,
            "start_date": null,
            "end_date": null,
            "last_modified": "2015-03-1718: 41: 57",
            "timezone": "EST5EDT",
            "currency": "USD",
            "budget_type": null,            
            "comments": null,
            "billing_code": null,
            "line_items": null,
            "labels": null,
            "broker_fees": null,
            "budget_intervals": [
                {
                    "id": 684,
                    "start_date": "2030-10-10 00:00:00",
                    "end_date": "2030-10-12 23:59:59",
                    "parent_interval_id": null,
                    "lifetime_budget": null,
                    "lifetime_budget_imps": 980,
                    "lifetime_pacing": false,
                    "enable_pacing": false,
                    "daily_budget_imps": 10,
                    "daily_budget": null
                },
                {
                    "id": 685,
                    "start_date": "2030-10-13 00:00:00",
                    "end_date": "2030-10-18 23:59:59",
                    "parent_interval_id": null,
                    "lifetime_budget": null,
                    "lifetime_budget_imps": 6,
                    "lifetime_pacing": false,
                    "enable_pacing": false,
                    "daily_budget_imps": 10,
                    "daily_budget": null
                }
            ],
            "lifetime_pacing": null,
            "lifetime_budget": null,
            "lifetime_budget_imps": null,
            "enable_pacing": null,
            "lifetime_pacing_span": null,
            "allow_safety_pacing": null,
            "daily_budget": null,
            "daily_budget_imps": null
            }
        ]
    }
}

Adición de un nuevo orden de inserción sin problemas con tipo de presupuesto flexible

$ cat insertion-order.json
{
    "insertion-order": {
        "name": "Test-Seamless-IO-GDALI",
        "advertiser_id": "33514",
        "timezone": "UTC",
        "budget_type": "flexible",
        "budget_intervals": [{
            "start_date": "2022-11-01 00:00:00",
            "timezone": "UTC"
        }],
        "currency": "USD"
    }
}



curl -b cookies -X POST -d @insertion-order.json "https://api.appnexus.com/insertion-order?advertiser_id=33514&member_id=958"


{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 6784364,
        "start_element": 0,
        "num_elements": 100,
        "insertion-order": {
            "id": 6784364,
            "name": "Test-Seamless-IO-GDALI",
            "code": null,
            "state": "active",
            "advertiser_id": 33514,
            "profile_id": null,
            "member_id": 958,
            "start_date": null,
            "end_date": null,
            "remaining_days": null,
            "total_days": null,
            "last_modified": "2022-01-26 20:00:29",
            "timezone": "UTC",
            "currency": "USD",
            "comments": null,
            "budget_type": "flexible",
            "billing_code": null,
            "viewability_standard_provider": "iab",
            "is_running_political_ads": false,
            "line_items": null,
            "labels": null,
            "broker_fees": null,
            "budget_intervals": [{
                "id": 16134020,
                "object_id": 6784364,
                "object_type": "insertion_order",
                "start_date": "2022-11-01 00:00:00",
                "end_date": null,
                "timezone": "UTC",
                "code": null,
                "lifetime_budget": null,
                "lifetime_budget_imps": null,
                "daily_budget_imps": null,
                "daily_budget": null,
                "enable_pacing": false,
                "lifetime_pacing": false,
                "lifetime_pacing_pct": null,
                "daily_budget_imps_opt": null,
                "daily_budget_opt": null
            }],
            "tpas_details": null,
            "political_content": null,
            "lifetime_pacing": null,
            "lifetime_budget": null,
            "lifetime_budget_imps": null,
            "enable_pacing": null,
            "lifetime_pacing_span": null,
            "allow_safety_pacing": null,
            "daily_budget": null,
            "daily_budget_imps": null,
            "lifetime_pacing_pct": null
        }
    }
}

Adición de un nuevo orden de inserción sin conexión directa

$ cat insertion-order.json

{
    "insertion-order":{
        "name":"My Insertion Order"
    }
}

$ curl -b cookies -X POST -d @insertion-order.json "https://api.appnexus.com/insertion-order?advertiser_id=11"
 
{
    "response":{
        "status":"OK",
        "id":2
    }
}

Ver todos los pedidos de inserción del anunciante 11

$ curl -b cookies "https://api.appnexus.com/insertion-order?advertiser_id=11"

    "response":{
        "status":"OK",
        "count":2,
        "start_element":0,
        "num_elements":100,
        "insertion-orders":[
            {
                "id":1,
                "name":"TEST CPM IO",
                "code":null,
                "billing_code":"3az56",
                "state":"active",
                "advertiser_id":11,
                "start_date":"2010-07-01 00:00:00",
                "end_date":"2010-09-01 23:59:59",
                "last_modified":"2010-08-02 23:44:14",
                "timezone":"EST5EDT",
                "currency":"USD",
                "budget_type": null,                
                "comments":null,
                "users":null,
                "line_items":[
                    {
                        "id":5588,
                        "line_item_type": "standard_v1",
                        "name":"Test IO Line Item CPM",
                        "code":null,
                        "state":"active",
                        "start_date":null,
                        "end_date":null,
                        "timezone":"EST5EDT"
                    }
                ],
                "labels":null,
                "broker_fees":null,
                "lifetime_budget":null,
                "lifetime_budget_imps":1000,
                "daily_budget":null,
                "daily_budget_imps":100,
                "enable_pacing":true,
                "lifetime_pacing":false,
                "lifetime_pacing_span":null,
                "allow_safety_pacing":true
            },
            {
                "id":2,
                "name":"TEST CPM IO - Expired Flight Dates",
                "code":null,
                "billing_code":null,
                "state":"active",
                "advertiser_id":2396,
                "start_date":"2010-06-01 00:00:00",
                "end_date":"2010-06-30 23:59:59",
                "last_modified":"2010-07-30 01:29:28",
                "timezone":"EST5EDT",
                "currency":"USD",
                "budget_type": null,                
                "comments":null,
                "users":null,
                "line_items":[
                    {
                        "id":5588,
                        "line_item_type": "standard_v1",
                        "name":"Test IO Line Item CPM",
                        "code":null,
                        "state":"active",
                        "start_date":null,
                        "end_date":null,
                        "timezone":"EST5EDT"
                    }
                ],
                "labels":null,
                "broker_fees":null,
                "lifetime_budget":null,
                "lifetime_budget_imps":1000,
                "daily_budget":null,
                "daily_budget_imps":100,
                "enable_pacing":true,
                "lifetime_pacing":false,
                "lifetime_pacing_span":null,
                "allow_safety_pacing":true
            }
        ]
}

Eliminar un intervalo presupuestado (en un orden de inserción sin problemas)

Nota:

La eliminación de intervalos presupuestados en un orden de inserción afectará de forma diferente a los elementos de línea subyacentes, en función de su tipo:

Para las partidas de línea que no son ali (aumentadas): la eliminación de intervalos de presupuesto en el orden de inserción primario eliminará automáticamente el intervalo presupuestado correspondiente en las partidas individuales. No intente eliminar intervalos de presupuesto del objeto de elemento de línea. Use siempre el orden de inserción primario para eliminar un intervalo de presupuesto.
Para los elementos de línea ali: no se puede eliminar un intervalo de presupuesto en una inserción primaria hasta que lo haya quitado por primera vez de todos los elementos de línea aumentadas subyacentes asociados al orden de inserción. Dado que las partidas individuales aumentadas pueden tener más de un intervalo presupuestado dentro de un intervalo de presupuesto determinado en el orden de inserción primario, asegúrese de quitar todos los intervalos presupuestados de la línea de línea aumentada que se encuentran dentro del intervalo presupuestado del pedido de inserción que tiene previsto quitar. Una vez que los intervalos presupuestados se han quitado de los elementos de línea aumentadas, se pueden quitar del orden de inserción.

//To delete a budget interval, both the "start_date" and "end_date" fields must be set to null.
$ cat delete-budget-interval
{
  "insertion-order": {
    "budget_intervals": [
      {
        "id": 79970,
        "start_date": null,
        "end_date": null
      }
    ]
  }
}
$ curl -b cookies -X PUT -d @delete-budget-interval "https://api.appnexus.com/insertion-order?id=357903"
{
  "response": {
    "status": "OK",
    "count": 1,
    "id": "357903",
    "start_element": 0,
    "num_elements": 100,
    "insertion-order": {
      "id": 357903,
      "name": "Seamless Insertion Order",
      "code": null,
      "state": "active",
      "advertiser_id": 1133550,
      "start_date": null,
      "end_date": null,
      "remaining_days": null,
      "total_days": null,
      "last_modified": "2016-07-26 21:33:34",
      "timezone": "America/Argentina/Buenos_Aires",
      "currency": "USD",
      "budget_type": null,
      "comments": null,
      "billing_code": null,
      "line_items": [
        {
          "id": 3188266,
          "line_item_type": "standard_v1",
          "name": "Seamless Line Item",
          "code": null,
          "state": "active",
          "start_date": null,
          "end_date": null,
          "timezone": "America/Argentina/Buenos_Aires"
        }
      ],
      "spend_protection_pixels": null,
      "labels": null,
      "broker_fees": null,
      "budget_intervals": [
        {
          "id": 79969,
          "object_id": 357903,
          "object_type": "insertion_order",
          "start_date": "2016-08-01 00:00:00",
          "end_date": "2016-08-31 23:59:59",
          "code": null,
          "timezone": "America/Argentina/Buenos_Aires",
          "lifetime_budget": 100,
          "lifetime_budget_imps": null,
          "lifetime_pacing": false,
          "enable_pacing": true,
          "daily_budget_imps": null,
          "daily_budget": null
        }
      ],
      "tpas_details": null,
      "lifetime_pacing": null,
      "lifetime_budget": null,
      "lifetime_budget_imps": null,
      "enable_pacing": null,
      "lifetime_pacing_span": null,
      "allow_safety_pacing": null,
      "daily_budget": null,
      "daily_budget_imps": null,
      "lifetime_pacing_pct": null
    },
    "dbg_info": {
      ...
    }
  }
}

Modificar un intervalo presupuestado (en un orden de inserción sin problemas)

$ cat modify-budget-interval
{

  "insertion-order": {
    "budget_intervals": [
      {
        "id": 79969,
        "lifetime_budget": 100
      }
    ]
  }
}
$ curl -b cookies -X PUT -d @modify-budget-interval "https://api.appnexus.com/insertion-order?id=357903"
{
  "response": {
    "status": "OK",
    "count": 1,
    "id": "357903",
    "start_element": 0,
    "num_elements": 100,
    "insertion-order": {
      "id": 357903,
      "name": "Seamless Insertion Order",
      "code": null,
      "state": "active",
      "advertiser_id": 1133550,
      "start_date": null,
      "end_date": null,
      "remaining_days": null,
      "total_days": null,
      "last_modified": "2016-07-29 17:26:26",
      "timezone": "America/Argentina/Buenos_Aires",
      "currency": "USD",
      "budget_type": null,
      "comments": null,
      "billing_code": null,
      "line_items": null,
      "spend_protection_pixels": null,
      "labels": null,
      "broker_fees": null,
      "budget_intervals": [
        {
          "id": 79969,
          "object_id": 357903,
          "object_type": "insertion_order",
          "start_date": "2016-08-01 00:00:00",
          "end_date": "2016-08-31 23:59:59",
          "code": null,          
          "timezone": "America/Argentina/Buenos_Aires",
          "lifetime_budget": 100,
          "lifetime_budget_imps": null,
          "lifetime_pacing": false,
          "enable_pacing": true,
          "daily_budget_imps": null,
          "daily_budget": null
        }
      ],
      "tpas_details": null,
      "lifetime_pacing": null,
      "lifetime_budget": null,
      "lifetime_budget_imps": null,
      "enable_pacing": null,
      "lifetime_pacing_span": null,
      "allow_safety_pacing": null,
      "daily_budget": null,
      "daily_budget_imps": null,
      "lifetime_pacing_pct": null
    },
    "dbg_info": {
      ...
    }
  }
}

Eliminación de un orden de inserción

curl -b cookies -X DELETE "https://api.appnexus.com/insertion-order?id=5851054&advertiser_id=5413231"

{"response":
    {
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "dbg_info":
            {
                "warnings":[],
                "version":"1.0.190",
                "output_term":"not_found"}
            }
    }
}

Compartir a través de

API de plataforma digital: servicio de pedido de inserción

API de REST

Campos JSON

Elementos de línea

Etiquetas

Tasas de broker

Intervalos de presupuesto

Contenido político

Estadísticas

Ejemplos

Adición de un nuevo orden de inserción sin problemas con intervalos de presupuesto

Adición de un nuevo orden de inserción sin problemas con tipo de presupuesto flexible

Adición de un nuevo orden de inserción sin conexión directa

Ver todos los pedidos de inserción del anunciante 11

Eliminar un intervalo presupuestado (en un orden de inserción sin problemas)

Modificar un intervalo presupuestado (en un orden de inserción sin problemas)

Eliminación de un orden de inserción

Recursos adicionales

Compartir a través de

API de plataforma digital: servicio de pedido de inserción

API de REST

Campos JSON

Elementos de línea

Etiquetas

Tasas de broker

Intervalos de presupuesto

Contenido político

Estadísticas

Ejemplos

Adición de un nuevo orden de inserción sin problemas con intervalos de presupuesto

Adición de un nuevo orden de inserción sin problemas con tipo de presupuesto flexible

Adición de un nuevo orden de inserción sin conexión directa

Ver todos los pedidos de inserción del anunciante 11

Eliminar un intervalo presupuestado (en un orden de inserción sin problemas)

Modificar un intervalo presupuestado (en un orden de inserción sin problemas)

Eliminación de un orden de inserción

Temas relacionados

Recursos adicionales