Servicio de elemento de línea

Artículo
05/18/2024

Nota:

En esta página se describe el servicio de elementos de línea para los elementos de línea estándar (heredados). Si usa elementos de línea aumentadas, consulte Servicio de elementos de línea - ALI en su lugar.

Los artículos de línea de un pedido de inserción representan las estrategias acordadas que se ejecutarán para el anunciante. Después de configurar un artículo de línea y opcionalmente (dependiendo de si el anunciante usa pedidos de inserción) asociándolo a uno o varios pedidos de inserción, puede crear campañas para especificar cómo gastar el dinero para cumplir su contrato. Los artículos de línea son donde registrará los "ingresos reservados" mediante los revenue_type campos y revenue_value , que describen el tipo de ingresos (CPM, CPA, etc.) y la cantidad que pagarán los anunciantes.

Nota:

Los pedidos de inserción finalmente serán obligatorios. Por lo tanto, como procedimiento recomendado, Xandr le anima a empezar a usar pedidos de inserción como parte de la implementación de la API.

Xandr sugiere asociar los elementos de línea con los pedidos de inserción para conservar los datos históricos de ritmo y rendimiento entre los elementos de línea en un único orden de inserción, y simplificar la configuración para relaciones de anunciantes de larga duración mediante la adición de intervalos de presupuesto a un pedido de inserción. Los elementos de línea se pueden asociar a uno o varios pedidos de inserción, pero solo a los del mismo tipo (un orden de inserción que usa intervalos de presupuesto o uno que no lo hace). Cada elemento de línea está asociado a una o varias campañas secundarias; las estrategias de puja y la segmentación de inventario se establecen a nivel de campaña.

Nota:

Elementos de línea de conexión directa

Hay dos tipos de elementos de línea: sin conexión y sin conexión (heredado). La principal diferencia entre los elementos de línea de conexión directa y no directa es que los elementos de línea de conexión directa usan la budget_intervals matriz y los elementos de línea que no son de conexión directa no. En términos de configuración, las principales diferencias son:

Para crear un elemento de línea de conexión directa , debe:
- Asocie el elemento de línea a cada orden de inserción especificando los identificadores de los pedidos de inserción de conexión directa primaria en la insertion_orders matriz. Cada objeto de la matriz debe tener un id campo cuyo valor corresponde a uno de los pedidos de inserción de conexión directa primaria. Esto asocia el elemento de línea a cada uno de esos pedidos de inserción. No puede asociar elementos de línea de conexión directa con pedidos de inserción sin conexión.
- Utilice el parent_interval_id campo de la budget_intervals matriz para especificar cada intervalo de presupuesto definido en todos los pedidos de inserción asociados a la línea de pedido. Esto determinará cuándo se ejecuta el elemento de línea.
- Deje los start_date campos y end_date (y los campos relacionados con el presupuesto o el ritmo) en el nivel de objeto de elemento de línea de nivel superior establecido nullen .
- Asocie solo elementos de línea de conexión directa con pedidos de inserción sin problemas.

También debe usar el presupuesto y los campos relacionados con el ritmo en la budget_intervals matriz para especificar el presupuesto disponible para el elemento de línea durante cada intervalo presupuestado y cómo se debe ajustar el gasto de ese presupuesto.

Para crear un elemento de línea que no sea de conexión directa , debe:
- Use los campos relacionados budget y pacing y los start_date campos y end_date en el objeto de elemento de línea 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.
- Deje todos los campos del budget_intervals campo (y los campos de su matriz) establecidos nullen . Es posible que no asocie elementos de línea que no sean de conexión directa con pedidos de inserción sin problemas.
- Asocie solo elementos de línea que no sean de conexión directa con pedidos de inserción no sin conexión.

Los elementos de línea de conexión directa son el modelo preferido. Debe usar el flujo de trabajo de elementos de línea de conexión directa al crear nuevos elementos de línea. No se puede convertir un elemento de línea que no sea de conexión directa a elementos de línea sin conexión o vincularlos a pedidos de inserción sin problemas (o elementos de líneas de conexión directa a pedidos de inserción no sin conexión).

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

Acerca de los objetivos de rendimiento

Los objetivos de rendimiento también se establecen en el elemento de línea. Se usan para realizar un seguimiento y medir el rendimiento de la campaña cuando un anunciante ha articulado los objetivos de rendimiento y cuando revenue_type los y goal_type no se miden de la misma manera. Por ejemplo, una revenue_type de "cpm" puede coincidir con una goal_type de "ctr" porque el anunciante quiere medir el logro del objetivo en términos de la tasa de clics, pero pagar en CPM.

Para establecer los objetivos de rendimiento de los elementos de línea con goal_type"cpa", use la goal_pixels matriz . Esta matriz contiene información sobre los objetivos de rendimiento y los umbrales. Para establecer objetivos de rendimiento para los elementos de línea con o goal_type"cpc""ctr", use el valuation objeto . Este objeto contiene el umbral del objetivo de rendimiento, que determina el límite de puja/sin puja en campañas optimizadas y el objetivo de rendimiento, que representa los clics deseados o la tasa de clics.

Para más información sobre los objetivos de rendimiento, consulte Descripción de los objetivos de rendimiento en la documentación de la interfaz de usuario.

API de REST

Http (método)	Endpoint	Description
`POST`	https://api.appnexus.com/line-item?advertiser_id=ADVERTISER_ID (JSON de elemento de línea)	Agregue un nuevo elemento de línea.
`PUT`	- https://api.appnexus.com/line-item?id=LINEITEM_ID& advertiser_id=ADVERTISER_ID - https://api.appnexus.com/line-item?code=LINE-ITEM_CODE& advertiser_code=ADVERTISER_CODE (JSON de elemento de línea)	Modificar un elemento de línea existente.
`GET`	- https://api.appnexus.com/line-item?advertiser_id=ADVERTISER_ID - https://api.appnexus.com/line-item?code=LINE-ITEM_CODE& advertiser_code=ADVERTISER_CODE	Ver todos los artículos de línea de un anunciante.
`GET`	https://api.appnexus.com/line-item?id=1,2,3	Vea varios elementos de línea por identificador mediante una lista separada por comas.
`DELETE`	https://api.appnexus.com/line-item?id=1	Elimine un elemento de línea específico que identifique por su identificador. Advertencia: La eliminación es recursiva y permanente. Al eliminar un elemento de línea también se eliminarán todos sus intervalos y divisiones presupuestarios asociados. Las eliminaciones son permanentes y no se pueden revertir. Nota: Filtros de cadena de consulta útiles - Puede filtrar por artículos de línea en función de cuándo se atienden por primera y última vez. Esto resulta especialmente útil cuando se está aproximando al límite de objetos y es necesario identificar los elementos de línea que se pueden eliminar del sistema. Para obtener más información, vea Primera ejecución y Última ejecución a continuación. - Puede filtrar por la línea que no está sirviendo debido a varias condiciones. Para obtener más información, consulte Alertas a continuación.
`GET`	https://api.appnexus.com/line-item?search=SEARCH_TERM	Busque elementos de línea con identificadores o nombres que contengan determinados caracteres.
`DELETE`	- https://api.appnexus.com/line-item?id=LINEITEM_ID& advertiser_id=ADVERTISER_ID - https://api.appnexus.com/line-item?code=LINE-ITEM_CODE& advertiser_code=ADVERTISER_CODE	Eliminar un elemento de línea. Advertencia: La eliminación es recursiva y permanente La eliminación de un elemento de línea también eliminará todas sus campañas secundarias, seguimientos de impresiones y seguimientos de clics. Las eliminaciones son permanentes y no se pueden revertir. Aunque los objetos eliminados siguen estando disponibles en los informes, ya no tendrá visibilidad sobre su configuración específica (por ejemplo, el presupuesto de ingresos y el seguimiento de los artículos de línea, el presupuesto de costos y la segmentación de campañas).
`GET`	https://api.appnexus.com/line-item/meta	Averigüe por qué campos puede filtrar y ordenar.

Campos JSON

Campo	Tipo (longitud)	Descripción
`id`	Entero	Identificador del elemento de línea. Obligatorio on:`PUT`, en la cadena de consulta
`code`	string (100)	Código personalizado para el elemento de línea. 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. Predeterminado:`null`
`name`	string (255)	Nombre del elemento de línea. Obligatorio activado:`POST`
`advertiser_id`	Entero	Identificador del anunciante al que pertenece el elemento de línea.
`state`	enumeración	Estado del elemento de línea. Valores posibles: `"active"` o `"inactive"`. Predeterminado:`"active"`
`line_item_type`	enumeración	Tipo de elemento de línea. Los posibles valores son: - `"standard_v1"`: elemento de línea estándar (que no es ALI). - `"standard_v2"`: elemento de línea aumentada (ALI). Nota: Si va a crear un ALI, consulte esta versión de la documentación del servicio de elementos de línea, ya que se requiere una configuración de campo diferente. - `"guaranteed_delivery"`: elemento de línea garantizado (GDLI). Predeterminado:`"standard_v1"`
`start_date`	Timestamp	Fecha y hora en que el elemento de línea no sin conexión debe empezar a servir. Este valor refleja la zona horaria del anunciante. Importante: Si va a crear un elemento de línea de conexión directa, no establezca este campo. Predeterminado:`null` (inmediatamente)
`end_date`	Timestamp	Fecha y hora en que el elemento de línea sin conexión debe dejar de servir. Este valor refleja la zona horaria del anunciante. Importante: Si va a crear un elemento de línea de conexión directa, no establezca este campo. Predeterminado:`null` (indefinidamente) Importante: Las fechas son inclusivas; por ejemplo, un `end_date` 4 de mayo significa que la campaña se ejecuta hasta las 23:59:59 del 4 de mayo.
`timezone`	enumeración	Zona horaria por la que se cuenta el presupuesto y el gasto. Para más información y valores aceptados, consulte Zonas horarias de API. 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: "`EST5EDT"` o la zona horaria del anunciante.
`discrepancy_pct`	double	Obsolescente.
`publishers_allowed`	string	Especifica el tipo de inventario por el que se va a pujar con este artículo de línea. Valores posibles: `real_time` o `direct`. Las campañas en tiempo real pueden dirigirse al inventario expuesto para RTB por otros miembros de Xandr o por nuestros asociados de suministro de inventario. Las campañas directas solo pueden dirigirse al inventario del publicador dentro de la red.
`revenue_value`	double	Cantidad pagada a la red por el anunciante. Nota: Este campo debe establecerse en determinadas condiciones, pero puede que no se establezca en otros. Además de los `POST`/`PUT` requisitos enumerados en la columna Obligatorio activado , tenga en cuenta lo siguiente: - El campo se puede rellenar cuando `revenue_type` es `cpm`, , `cpccpa`, `cost_plus_margin`, , `cost_plus_cpm`, `est_cpm`. Sin embargo, si `revenue_type` es `"cpa"` este campo, se omitirá porque se realiza un seguimiento de los ingresos mediante `post_view_revenue` o `post_click_revenue` en el píxel. - Es posible que el campo no se rellene cuando `revenue_type` es `"none"` o `"vcpm"`. Obligatorio activado: `POST` / `PUT`, si `revenue_type` es `"cpc"`. `POST` / `PUT`, si `revenue_type` es `"flat_fee"`. Nota: Si `"flat_fee_type"` es este es `"daily"` el valor pagado por día. Si `"flat_fee_type"` es `"one_time"` este es el valor pagado en la fecha de asignación final.
`revenue_type`	enumeración	La forma en que el anunciante ha aceptado pagarle. A continuación se enumeran los valores posibles. Nota: Si `post_view_revenue` o `post_click_revenue` está establecido para cualquier píxel de la `pixels` matriz, `revenue_type` debe ser `"cpa"`. `revenue_type` No se puede establecer en un valor que no sea compatible con ninguna de las campañas secundarias del elemento de línea. - `"none"`: no realice un seguimiento de los ingresos del elemento de línea. - `"cpm"`: un pago plano por cada 1000 impresiones. - `"cpc"`: un pago plano por clic. - `"cpa"`: pago plano por conversión. - `"cost_plus_cpm"`: costo multimedia (lo que se gasta en el inventario) más un CPM adicional. - `"cost_plus_margin"`: costo de medios (lo que se gasta en el inventario) más un porcentaje de lo que se gasta. - `"flat_fee"`: pago plano que el anunciante le pagará en una fecha de asignación especificada. Esa fecha puede ser diaria o al final del vuelo. Si paga a los publicadores administrados un porcentaje de los ingresos, su parte se pagará en la fecha de asignación, después de lo cual el elemento de línea dejará de ser editable. Tenga en cuenta que la tarifa plana no se reservará en la fecha de asignación a menos que el artículo de línea haya servido al menos 1 impresión. Si define un de `revenue_typeflat_fee` debe especificar un valor para `flat_fee_type`. - `"vcpm"`: (solo el servidor de anuncios del publicador) Un pago plano por cada 1000 impresiones visibles. Para obtener más información sobre la visualización, consulte Introducción a la visualización. - `"est_cpm"`: el pago plano estimado por 1000 impresiones. Predeterminado:`"none"`
`goal_type`	enumeración	En el caso de los artículos de línea que hacen uso de los objetivos de rendimiento, la forma en que el anunciante quiere medir la optimización de la campaña. Valores posibles: `"none"`, `"cpc"`, `"cpa"`o `"ctr"`. Predeterminado:`"none"`
`goal_value`	double	Obsoleto. Use `valuation` el objeto en su lugar. Para obtener más información, consulte Valoración a continuación.
`last_modified`	Timestamp	Hora de la última modificación en este elemento de línea. Solo lectura.
`click_url`	string (1000)	Dirección URL del clic que se va a aplicar en el nivel de elemento de línea.
`currency`	string (3)	Moneda usada para este elemento de línea. Para obtener una lista de las monedas admitidas, consulte Servicio de divisas. Nota: Una vez creado el elemento de línea, no se puede cambiar la moneda. Como procedimiento recomendado, alinee la moneda con la moneda de facturación para lograr la mejor experiencia de moneda local posible. Predeterminado: Moneda predeterminada del anunciante.
`require_cookie_for_tracking`	booleano	Indica si desea servir solo a los usuarios que usan cookies, con el fin de realizar el seguimiento de conversiones (porque la atribución de conversión de Xandr está basada en cookies). `true` indica que no atenderá a los usuarios que no son cookies, porque no tienen ninguna posibilidad de atribución de conversión. `false` indica que atenderá a usuarios que no son de cookies y no aceptará ninguna atribución de conversión para esos usuarios. Esta marca solo se aplica cuando se ha aplicado un píxel de conversión, por lo que la configuración `true` no requerirá cookies para un elemento de línea que no tenga píxeles de conversión.
`profile_id`	Entero	Puede asociar un elemento opcional `profile_id` a este elemento de línea. 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.
`member_id`	Entero	Identificador del miembro propietario del elemento de línea.
`comments`	string	Comentarios sobre el elemento de línea.
`remaining_days`	Entero	Solo lectura. Número de días entre hoy y el `end_date` de la línea de pedido. Nota: Esto será `null` si es `start_date` en el futuro o si `start_date` está establecido o `end_date` no.
`total_days`	Entero	Número de días entre y `start_dateend_date` para el elemento de línea. Tenga en cuenta que será null si `start_date` no se establece o `end_date` . Solo lectura.
`manage_creative`	booleano	Si `true`es , las creatividades se administran en el nivel de elemento de línea. Si `false`es , las creatividades se administran en el nivel de campaña. Predeterminado:`false`
`advertiser`	objeto	Objeto que describe el anunciante con el que está asociado este elemento de línea. Para obtener más información, consulta Anunciante a continuación. Solo lectura.
`flat_fee`	objeto	Un pago plano que el anunciante le pagará en una fecha de asignación especificada. Esa fecha de asignación puede ser diaria o al final del vuelo. Si paga a los publicadores administrados un porcentaje de los ingresos, su parte se pagará en la fecha de asignación, después de lo cual el elemento de línea dejará de ser editable. Tenga en cuenta que la tarifa plana no se reservará en la fecha de asignación a menos que el artículo de línea haya servido al menos 1 impresión. Para obtener más información, consulte Tarifa plana a continuación. Obligatorio en:`POST`/`PUT`, si `revenue_type` es `"flat_fee"`.
`flat_fee_type`	string	Las tarifas planas se pueden pagar diariamente o en la fecha de finalización del vuelo. Los valores admitidos son: - `one_time`: la cuota se pagará en la fecha de asignación final. El asociado `revenue_value` es el valor que se va a pagar en esa fecha. El vuelo no puede tardar más de un mes. - `daily`: la tarifa se pagará diariamente. El asociado `revenue_value` es la tarifa diaria, no la tarifa de todo el vuelo. Predeterminado:`one_time` Obligatorio en:`POST`/`PUT`, si `revenue_type` es `"flat_fee"`.
`labels`	matriz	Etiquetas opcionales aplicadas al elemento de línea. Actualmente, hay cuatro etiquetas disponibles: `"Trafficker"`, `"Sales Rep"`y `"Campaign Type"`. Para obtener más información, vea Etiquetas a continuación. Nota: Puede informar sobre etiquetas de elementos de línea con los informes de Network Analytics y Network Advertiser Analytics . Por ejemplo, si usa la `"Trafficker`etiqueta " para especificar el nombre del tratante responsable de cada elemento de línea, podría ejecutar el informe de Network Analytics filtrado por `"trafficker_for_line_item"` para centrarse en los elementos de línea de los que es responsable un tratante determinado o agruparlo por `"trafficker_for_line_item"` para clasificar el rendimiento de los tratantes.
`broker_fees`	matriz	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. Nota: 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.
`pixels`	matriz de objetos	Los píxeles de conversión que se usan para el tipo de ingresos CPA. Se pueden especificar ingresos posteriores al clic y a la vista. Solo puede adjuntar 20 píxeles a un elemento de línea. Si necesita adjuntar más, hable con su consultor de implementación de Xandr o soporte técnico. Para obtener más información, consulte Píxeles y el ejemplo siguiente para obtener un ejemplo del formato. Predeterminado:`null`
`insertion_orders`	matriz de objetos	Objetos que contienen metadatos para los pedidos de inserción a los que está asociado este elemento de línea. Para obtener más información, vea Pedidos de inserción a continuación. Nota: Una vez que un elemento de línea está asociado a un orden de inserción sin problemas, no se puede asociar a un orden de inserción sin conexión. Solo los pedidos de inserción sin problemas pueden estar asociados a elementos de línea sin problemas. Solo los pedidos de inserciones no directas se pueden asociar4 con elementos de línea no sin conexión.
`goal_pixels`	matriz	Para un elemento de línea con `goal_type"cpa"`, los píxeles usados para el seguimiento de conversiones, así como los ingresos posteriores y posteriores al clic. Para obtener más información, consulte Píxeles de objetivo y el ejemplo siguiente para obtener un ejemplo del formato.
`imptrackers`	matriz de objetos	Rastreadores de impresiones de terceros asociados al elemento de línea. Para obtener más información, consulte Servicio de seguimiento de impresiones. Solo lectura.
`clicktrackers`	matriz de objetos	Seguimientos de clics de terceros asociados al elemento de línea. Para obtener más información, vea Click Tracker Service. Solo lectura.
`campaigns`	matriz de objetos	Campañas asociadas al elemento de línea. Para obtener más información, consulta Campañas a continuación. Nota: Para asociar una campaña a un elemento de línea, use el `line_item_id` campo en el Servicio de campaña. Tenga en cuenta que no se pueden asociar más de 500 campañas a un solo elemento de línea. Solo lectura.
`valuation`	objeto	Para un elemento de línea con o `goal_type"cpc""ctr"`, el umbral de objetivo de rendimiento, que determina el límite de puja o sin puja en campañas optimizadas, y el objetivo de objetivo de rendimiento, que representa los clics deseados o la tasa de clics. Para obtener más información, consulte Valoración a continuación.
`creatives`	matriz de objetos	Las creatividades asociadas al elemento de línea. Para obtener más detalles, consulte Creatives a continuación.
`budget_intervals`	matriz de objetos	Nota: Esta matriz solo es relevante y necesaria para los elementos de línea de conexión directa (si el elemento de línea no es sin conexión, deje este campo establecido en `null`). Los intervalos de presupuesto permiten asociar varios intervalos de fecha a un elemento de línea, 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 `line-item` objeto : - `lifetime_pacing` - `lifetime_budget` - `lifetime_budget_imps` - `enable_pacing` - `lifetime_pacing_span` - `allow_safety_pacing` - `daily_budget` - `daily_budget_imps` - `lifetime_pacing_pct`
`roadblock`	objeto	Configuración del bloqueo de carretera para el elemento de línea. Para obtener más información, consulte Roadblock a continuación.
`lifetime_budget`	double	Presupuesto de duración en ingresos. El campo define la moneda de `currency` ingresos. Si no desea asignar el presupuesto de partidas de línea a este `budget_interval`, establezca este campo en `0`. Nota: Solo se aplica a los elementos de línea que no son de conexión directa. Si también establece el `lifetime_budget_imps` campo, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos. Predeterminado:`null` (ilimitado)
`lifetime_budget_imps`	Entero	Presupuesto de duración en impresiones. `lifetime_budget_imps` funciona como duración `"catch-all"` o `"cap"` para el presupuesto total de impresiones de un elemento de línea. Un elemento de línea no superará el número de impresiones establecidas para este campo y, si el número de impresiones entregadas es mayor que el conjunto de montaje para este campo, el elemento de línea dejará de pujar. Si no desea asignar el presupuesto de partidas de línea a este `budget_interval`, establezca este campo en `0`. Nota: Solo se aplica a los elementos de línea que no son de conexión directa. Si también establece el `lifetime_budget` campo, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos. Predeterminado:`null` (ilimitado)
`daily_budget`	double	Presupuesto diario en ingresos. El campo define la moneda de `currency` ingresos. Nota: Solo se aplica a los elementos de línea que no son de conexión directa. Si también establece el `daily_budget_imps` campo, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos. Predeterminado:`null` (ilimitado)
`daily_budget_imps`	Entero	El presupuesto diario en impresiones. Nota: Solo se aplica a los elementos de línea que no son de conexión directa. Si también establece el `lifetime_budget` campo, el presupuesto que se agote primero hará que se detenga el gasto. El procedimiento recomendado consiste en establecer solo uno de estos campos. Predeterminado:`null` (ilimitado)
`enable_pacing`	booleano	Si `true`es , el gasto presupuestado diario se distribuye uniformemente a lo largo de un día. Solo se aplica si hay un presupuesto diario. Es por eso que el valor predeterminado `true` es si se establece el presupuesto diario; de lo contrario, tiene como valor predeterminado `null`. Nota: Solo se aplica a los elementos de línea que no son de conexión directa. Predeterminado:`null`
`allow_safety_pacing`	booleano	Si `true`es , el gasto por minuto está limitado a un máximo del 1 % del presupuesto de duración y del 5 % del presupuesto diario. Nota: Solo se aplica a los elementos de línea que no son de conexión directa.
`lifetime_pacing`	booleano	Si `true`es , el elemento de línea intentará gastar su presupuesto total de duración uniformemente en las fechas de vuelo del elemento de línea. Si `true`es , no se puede establecer un `daily_budget`, no se puede establecer `enable_pacingfalse`en , y primero debe establecer un `lifetime_budget`, un `start_date`y un `end_date` para el elemento de línea. Nota: Solo se aplica a los elementos de línea que no son de conexión directa. Predeterminado:`null`
`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 elementos de línea que no son de conexión directa. Predeterminado:`null` (3 días)
`lifetime_pacing_pct`	double	Un entero doble entre 50 y 150 incluidos, que se usa para establecer el ritmo a lo largo de un intervalo de presupuesto. Los valores posibles pueden ser cualquier doble entre 50 y 150 en la escala siguiente: - `50`: ritmo atrasado programado - `100`: pace uniformemente - `150`: ritmo previo a la programación Nota: 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. Solo se aplica a los elementos de línea que no son de conexión directa. Predeterminado:`100`
`payout_margin`	double	Margen de pago de los artículos de línea de la oferta de rendimiento.
`insertion_order_id`	Entero	Identificador del orden de inserción activo actual (cuando corresponda). Debe anexarse `include_insertion_order_id=true` para devolver este campo en una `GET` llamada. Para obtener más información, consulte el servicio de pedido de inserción. Nota: Solo los pedidos de inserción sin problemas pueden estar asociados a elementos de línea sin problemas. Solo los pedidos de inserciones no directas pueden estar asociados a elementos de línea no sin conexión.
`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	Para mostrar informes rápidos para todos los intervalos disponibles (hoy, ayer, los últimos 7 días, tiempo de vida), pase `all_status=true` la cadena de consulta de una `GET` solicitud. Solo lectura.
`object_stats`	objeto	Número de campañas totales, activas e inactivas en el elemento de línea. Solo lectura.
`first_run`	Timestamp	Fecha y hora en que el elemento de línea tuvo su primera impresión, actualizada cada hora. Este valor refleja la zona horaria UTC. Para incluir esta información en una `GET` respuesta, 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 la primera vez que se atienden, consulte Primera ejecución y Última ejecución a continuación. Solo lectura.
`last_run`	Timestamp	Fecha y hora en que el elemento de línea tuvo su última impresión, actualizada cada hora. Este valor refleja la zona horaria UTC. Para incluir esta información en una `GET` respuesta, 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 y Última ejecución a continuación. Solo lectura.
`expected_pacing`	double	Obsolescente. Atención: El `stats` objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016).
`total_pacing`	double	Obsolescente. Atención: El `stats` objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016).
`has_pacing_dollars`	enumeración	Obsolescente. Atención: El `stats` objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016).
`has_pacing_imps`	enumeración	Obsolescente. Atención: El `stats` objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016).
`imps_pacing_percent`	Entero	Obsolescente. Atención: El `stats` objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016).
`rev_pacing_percent`	Entero	Obsolescente. Atención: El `stats` objeto y Quickstats han quedado en desuso (a partir del 17 de octubre de 2016).
`alerts`	objeto	Condiciones que impiden que el elemento de línea 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. Tenga en cuenta que, en este momento, no hay advertencias para los elementos de línea. Para recuperar elementos de línea basados en pausas, debe pasar determinados parámetros de cadena de consulta en la `GET` solicitud. Para obtener más información, incluida una lista completa de posibles pausas, 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 el elemento de línea para poder usar este campo. Valores permitidos: - `even`: valor predeterminado. Use el algoritmo de optimización creativa Xandr estándar, donde la valoración de cada creatividad se calcula de forma independiente y se elige la creatividad mejor valorada para servir. - `weighted`: la rotación creativa se basa en un peso proporcionado por el usuario. - `ctr-optimized`: la creatividad con el CTR más alto ofrece el máximo. Predeterminado:`"even"`
`is_archived`	booleano	Indica si el elemento de línea se ha archivado automáticamente debido a que no se está usando. Una vez establecido en `true`, el valor no se puede cambiar y las únicas llamadas que se pueden realizar en el objeto de elemento de línea son `GET` y `DELETE`. Nota: Si un elemento de línea se archiva automáticamente, su perfil, así como todas sus campañas (y sus perfiles) también se archivarán y las únicas llamadas que se pueden realizar en esos objetos son `GET` y `DELETE`. Además, una vez archivado, es posible que el elemento de línea no esté asociado a ningún pedido de inserción. Predeterminado:`false` Solo lectura.
`archived_on`	Timestamp	Fecha y hora en que se archivó el elemento de línea (es decir, cuando el `is_archived` campo se estableció en `true`). Predeterminado:`null` Solo lectura.
`priority`	Entero	Para la estrategia de compra directa, la prioridad para las campañas que compran su propio inventario administrado. La prioridad debe establecerse en el objeto de campaña. Predeterminado:`5`

Anunciante

Campo	Tipo	Descripción
`id`	Entero	Identificador único de este anunciante.
`name`	string	Nombre del anunciante asociado al identificador único anterior.

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, campañas y publicadores. Este servicio también permite ver las etiquetas que ya se han aplicado a los objetos.

Campo	Tipo	Descripción
`id`	Entero	Identificador de la etiqueta. Valores posibles: `7`, `8`, `11`.
`name`	enumeración	Nombre de la etiqueta. Valores posibles: `"Trafficker"`, `"Sales Rep"`o `"Campaign Type"`. Solo lectura.
`value`	string (100)	Valor asignado a la etiqueta. Por ejemplo, para la `"Sales Rep"` etiqueta, podría ser un nombre como `"Michael Sellers"`.

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 campaña (Servicio de campaña) o en el nivel de orden de inserción (Servicio de pedido de inserción).

Para crear o editar agentes, consulte Broker Service.

Campo	Tipo	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"`. Nota:`payment_type` solo se puede establecer `"cpm"` en si se establece en `revenue_type"cpm"`. Donde `revenue_type` se establece en `"cpa"` o `"cpc"`, `payment_type` debe establecerse en `"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.

Creación de una cuota de broker

$ cat add-LI-broker-fees.json
{
    "line-item":
        {
    "broker_fees":[
        {
            "broker_id": 145,
                "payment_type": "cpm",
                "value": "1.00",
                "description": "Smart JMS fee"
            }]
    }
}

$ curl -b cookies -c cookies -X PUT -d @add-LI-broker-fees.json 'https://api.appnexus.com/line-item?id=152083&advertiser_id=11'

{
    "response":{
        "status":"OK",
        "id":"152083",
        "count":1,
        "start_element":0,
        "num_elements":100,

        }
}

Modificación de una cuota de broker

$ cat modify-LI-broker-fee.json
{
"line-item" :
{ "broker_fees": [
    {
    "broker_id": 145,
        "payment_type": "cpm",
    "value": "2.00",
        "description": "Extra JMS fee"
        }]
    }
}

$ curl -b cookies -c cookies -X PUT -d @modify-broker-fee.json $ curl -b cookies -c cookies -X PUT -d @modify-LI-broker-fee.json 'https://api.appnexus.com/line-item?id=152083&advertiser_id=11' | json-pp

{
    "response":{
        "status":"OK",
        "id":"152083",
        "count":1,
        "start_element":0,
        "num_elements":100,
     }
}

Pixels

Cada objeto de la pixels matriz incluye los campos siguientes:

Campo	Tipo	Descripción
`id`	Entero	Identificador del píxel de conversión.
`state`	enumeración	Estado del píxel. Valores posibles: `"active"` o `"inactive"`.
`post_click_revenue`	double	Valor de ingresos del clic posterior para el píxel.
`post_view_revenue`	double	Valor de ingresos de la vista posterior para el píxel.
`name`	string	Nombre del píxel de conversión. Solo lectura.
`trigger_type`	enumeración	Tipo de evento necesario para una conversión con atributos. Valores posibles: `"view"`, `"click"`o `"hybrid"`. Solo lectura.

Pedidos de inserción

Campo	Tipo	Descripción
`id`	Entero	Identificador único del orden de inserción. Nota: Una vez que un elemento de línea está asociado a un orden de inserción sin problemas, no se puede asociar a un orden de inserción sin problemas. Solo los pedidos de inserción sin problemas pueden estar asociados a elementos de línea sin problemas. Solo los pedidos de inserciones no directas pueden estar asociados a elementos de línea no sin conexión.
`state`	enumeración	Estado de este orden de inserción: `"active"` o `"inactive"`.
`code`	string	Código personalizado opcional que se usa para identificar este orden de inserción.
`name`	string	Nombre de este orden de inserción.
`advertiser_id`	Entero	Identificador único del anunciante asociado a este pedido de inserción.
`start_date`	date	Fecha de inicio de este pedido de inserción.
`end_date`	date	Fecha de finalización de este pedido de inserción.
`timezone`	enumeración	Zona horaria a la que está asociado este orden de inserción. Para obtener una lista de los valores permitidos, consulte Zonas horarias de API. El valor predeterminado es `"EST5EDT"` o la zona horaria del anunciante.
`last_modified`	date	Fecha en la que se actualizó por última vez este objeto de orden de inserción.
`currency`	enumeración	Tipo de moneda asociado a este orden de inserción. Para obtener una lista de las monedas admitidas, consulte Servicio de divisas.
`budget_intervals`	matriz de objetos	Metadatos de los intervalos de presupuesto del orden de inserción asociado. 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, vea Servicio de pedido de inserción.

Campañas

Cada objeto de la campaigns matriz incluye los campos siguientes.

Campo	Tipo	Descripción
`id`	Entero	Identificador de la campaña. Solo lectura.
`name`	string	Nombre de la campaña. Solo lectura.
`state`	enumeración	Estado de la campaña. Valores posibles: `"active"`, `"inactive"`o `"parent_inactive"`. 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. Solo lectura.
`cpm_bid_type`	enumeración	Estrategia de puja para comprar inventario de terceros por impresión. Valores posibles: `"base"`, `"average"`, `"clearing"`, `"predicted"`o `"margin"`. El promedio es equivalente al precio promedio estimado (EAP); la compensación es equivalente al precio claro estimado (ECP); predicted significa que establece un objetivo de CPC o un objetivo de CPA. Solo lectura.
`priority`	Entero	Para la estrategia de compra directa, la prioridad para las campañas que compran su propio inventario administrado. Valor predeterminado:`5`.
`start_date`	date	Fecha de inicio de la campaña.
`end_date`	date	Fecha de finalización de la campaña.
`creative_count`	Entero	Número de creativos asociados a la campaña.
`profile_id`	Entero	Identificador del perfil asociado a la campaña.

Valoración

El objeto de valoración se usa para establecer los objetivos de rendimiento de las partidas individuales con o goal_type"cpc""ctr". Contiene el umbral del objetivo de rendimiento, que determina el límite de puja/sin puja en campañas optimizadas y el objetivo de rendimiento, que representa los clics deseados o la tasa de clics.

El valuation objeto contiene los campos siguientes:

Campo	Tipo	Descripción
`min_margin_pct`	decimal	Para las partidas individuales con `revenue_type"cpm"`, `"cpa"`o `"cpc"` el margen mínimo PCT. Predeterminado:`null`
`goal_threshold`	decimal	En el caso de los artículos de línea con o `goal_type"cpc""ctr"`, el umbral del objetivo de rendimiento, que determina el límite de puja o sin puja en las campañas optimizadas. Predeterminado:`null`
`goal_target`	decimal	Para los elementos de línea con o `goal_type"cpc""ctr"`, el objetivo de rendimiento, que representa los clics deseados o la tasa de clics. Predeterminado:`null`
`performance_mkt_managed`	booleano	Si `true`es , el elemento de línea es un elemento de línea de Marketplace de rendimiento que compra en el inventario administrado. Este campo solo es aplicable cuando `revenue_type` es `"cpc"` o `"cpa"`. Predeterminado:`false`
`campaign_group_valuation_strategy`	enumeración	Nota: 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. Para los elementos de línea con `revenue_type“cpm”`, `“cpc”`o `“cpa”`, determina qué estrategia de optimización del objetivo de rendimiento se aplicará. Los posibles valores son: - `“prospecting”`: para usar la optimización estándar de Xandr. - `"retargeting"`: para optimizar un segmento de redestinación de usuario. Si selecciona esta configuración, también debe asociar un segmento de redestinación de usuario al elemento de línea. Para crear segmentos de usuario, consulte el servicio Segment. Para asociar segmentos de redestinación de usuarios con el elemento de línea, consulte Servicio de perfiles. Predeterminado:`null`

Creativos

Cada objeto de la creatives matriz incluye los campos siguientes. Para obtener información sobre "id" o "code" campos, puede usar el Servicio Creativo.

Campo	Tipo	Descripción
`is_expired`	booleano	Si `true`es , la creatividad ha expirado. Si `false`es , la creatividad está activa. Solo lectura.
`is_prohibited`	ooleano	Si `true`es , la creatividad entra en una categoría prohibida en la plataforma Xandr. Solo lectura.
`width`	Entero	Ancho de la creatividad. Solo lectura.
`audit_status`	enumeración	Estado de auditoría de la creatividad. Valores posibles: `"no_audit"`, `"pending"`, `"rejected"`, `"audited"`o `"unauditable"`. Solo lectura.
`name`	string	Solo lectura. Nombre de la creatividad.
`pop_window_maximize`	booleano	Si `true`es , 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.
`height`	Entero	El alto de la creatividad. Solo lectura.
`state`	enumeración	El estado de la creatividad. Valores posibles: `"active"` o `"inactive"`. 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.
`is_self_audited`	booleano	Si `true`es , la creatividad se audita por sí misma. Solo lectura.
`id`	Entero	Identificador de la creatividad. `code` O `id` es necesario al actualizar la asociación creativa.
`weight`	int(10)	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 elemento de línea. 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`.
`code`	string	Código personalizado para la creatividad. `code` O `id` es necesario al actualizar la asociación creativa.

Intervalos de presupuesto

Nota:

Esta matriz solo se usa para elementos de línea de conexión directa.

Los intervalos presupuestados de los elementos de línea de conexión directa deben ser copias de los intervalos de presupuesto definidos en sus pedidos de inserción primarios. Los intervalos presupuestados del elemento de línea tendrán automáticamente los mismos start_date intervalos presupuestados de pedido de inserción correspondientes, end_date pero deben tener presupuestos distintos. Estas funciones funcionan como "subs budgets" específicos del elemento de línea del presupuesto en el intervalo de presupuesto de pedido de inserción correspondiente.

El campo crea intervalos presupuestados de artículos de línea (y se vinculan a sus intervalos de presupuesto de pedido de parent_interval_id inserción). Al crear un nuevo elemento de línea de conexión directa, debe rellenar la budget_intervals matriz con referencias a todos los intervalos presupuestados en todos los pedidos de inserción que asocie a ese elemento de línea (los pedidos de inserción están asociados a elementos de línea a través de la insertion_orders matriz en el servicio de elementos de línea). Esto se hace agregando objetos a la matriz que contienen un único campo, parent_interval_id, cuyo valor es un intervalo de presupuesto de pedido de inserción que el elemento de línea debe heredar. Consulte Agregar un elemento de línea sin problemas con intervalos de presupuesto en la sección Ejemplos a continuación.

Tenga en cuenta también lo siguiente al usar la budget_interval matriz:

Los intervalos de fechas (por ejemplo, start_date, ) end_datede intervalos de presupuesto diferentes en el mismo elemento de línea no se pueden superponer.
Los intervalos presupuestados en el elemento de línea pueden tener presupuestos de duración ilimitada (es decir, si esos campos de presupuesto se dejan establecidos en null).
Los intervalos presupuestarios no se pueden usar si se establecen campos de presupuesto en el nivel superior del insertion_order propio objeto.
Las modificaciones realizadas en los intervalos presupuestados de nivel de pedido de inserción se propagan a los intervalos de presupuesto de nivel de elemento de línea correspondientes (por ejemplo, si se elimina un intervalo de presupuesto en el orden de inserción, también se eliminará ese intervalo de presupuesto en todas las partidas individuales que lo usen).
Si va a aumentar el presupuesto para el intervalo presupuestado del elemento de línea, primero debe aumentar el presupuesto para el intervalo presupuestado en el orden de inserción primario (de lo contrario, es posible que no tenga presupuesto suficiente). Para obtener más información, vea Servicio de pedido de inserción.

Cada objeto de la budget_intervals matriz contiene los campos siguientes.

Campo	Tipo	Descripción
`id`	Entero	Identificador del intervalo presupuestado del elemento de línea.
`start_date`	Timestamp	Fecha de inicio del intervalo presupuestado, que se hereda del orden de inserción. El formato es `YYYY-MM-DD hh:mm:ss`.
`end_date`	Timestamp	Fecha de finalización del intervalo presupuestado, que se hereda del orden de inserción. El formato debe ser `YYYY-MM-DD hh:mm:ss` (hh:mm:ss debe establecerse en 23:59:59). Nota: Si el `end_date` del intervalo presupuestado del pedido de inserción primario se ha establecido en `null` (por ejemplo, sin fecha de finalización), en `end_date` el elemento de línea debe establecerse en un valor distinto de 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. 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.
`parent_interval_id`	Entero	Identificador del intervalo presupuestado del pedido de inserción primario. Este es el `id` campo de la `budget_intervals` matriz en el orden de inserción. Necesario para que el intervalo presupuestado del elemento de línea herede los valores de los `start_date` campos y `end_date` en el intervalo presupuestado del pedido de inserción.
`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. Establezca este campo `0` en si no desea que el elemento de línea se gaste durante este intervalo presupuestado. Este campo tiene `null` como valor predeterminado (ilimitado). Nota: Si también establece el `lifetime_budget_imps` campo en 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. Establezca este campo `0` en si no desea que el elemento de línea se gaste durante este intervalo presupuestado. Este campo tiene `null` como valor predeterminado (ilimitado). Nota: Si también establece el `lifetime_budget` campo en 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 elemento de línea intentará mantener el ritmo del presupuesto de duración uniformemente durante el intervalo presupuestado. Si `true` es , debe establecer `lifetime_budget` o `lifetime_budget_imps`.
`daily_budget`	double	Presupuesto diario en ingresos para el intervalo presupuestado. El campo del objeto define la `currency` moneda de `insertion_order` 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. Este campo tiene `null` como valor predeterminado (ilimitado). Nota: Si también establece el `daily_budget_imps` campo en 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	El presupuesto diario en impresiones. Este campo tiene `null` como valor predeterminado (ilimitado). Nota: Si también establece el `daily_budget` campo, 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`.

Píxeles objetivo

La goal_pixels matriz se usa al trabajar con goal_type"cpa" y contiene información sobre los objetivos de rendimiento y los umbrales.

Cada objeto de la goal_pixels matriz incluye los campos siguientes:

Campo	Tipo	Descripción
`id`	Entero	Identificador del píxel de conversión.
`state`	enumeración	Estado del píxel. Valores posibles: `"active"` o `"inactive"`.
`post_click_goal`	double	Obsoleto. Use `post_click_goal_target` y `post_click_goal_threshold` en su lugar.
`post_view_goal`	double	Obsoleto. Use `post_view_goal_target` y `post_view_goal_threshold` en su lugar.
`trigger_type`	enumeración	Tipo de evento necesario para una conversión con atributos. Valores posibles: `"view"`, `"click"`o `"hybrid"`. Solo lectura.
`post_click_goal_target`	double	Valor objetivo del anunciante posterior al clic para el píxel.
`post_view_goal_target`	double	Valor objetivo del anunciante posterior a la vista para el píxel. (Comparable a `goal_value` para `goal_type"cpc"` y `"ctr"`.)
`post_click_goal_threshold`	double	Umbral del objetivo del anunciante después de hacer clic para el píxel, que determina el límite de puja o sin puja en las campañas optimizadas. No se puede habilitar sin un conjunto de destino. (Comparable a `goal_threshold` en el objeto de valoración para `goal_type"cpc"` y `"ctr"`.)
`post_view_goal_threshold`	double	Umbral del objetivo del anunciante posterior a la visualización para el píxel, que determina el límite de puja/no puja en las campañas optimizadas. No se puede habilitar sin un conjunto de destino. (Comparable a `goal_threshold` en el objeto de valoración para `goal_type"cpc"` y `"ctr"`.)

Objetivo de entrega

Esta sección solo se aplica a los clientes de Publisher Ad Server.

Campo	Tipo	Descripción
`delivery_goal`	matriz de objetos	Solo para los artículos de línea de entrega garantizada. En el caso de los artículos de línea de entrega garantizada, el indicador de rendimiento más importante es que la línea entrega su presupuesto en su totalidad y uniformemente en las fechas de vuelo. Para lograr estos fines, estos elementos de línea tienen un asociado `delivery_goal`. Estos artículos de línea entregarán sus objetivos de impresión o porcentaje uniformemente en las fechas de sus vuelos. Esta matriz especifica exactamente cuáles son los objetivos del elemento de línea. Para obtener más información sobre los artículos de línea de entrega garantizada, consulte Entrega garantizada. Predeterminado:`null`

Nota:

La delivery_goal matriz contiene información sobre el objetivo de entrega adjunto a este elemento de línea. Los artículos de línea de entrega garantizados intentarán cumplir los objetivos de impresión o porcentaje.

Para que los artículos de línea de entrega garantizada sirvan, hay una serie de validaciones diferentes que deben realizarse. Las validaciones cambian en función del tipo de objetivo de entrega; se describen a continuación.

Para ver cómo crear un elemento de línea de entrega garantizada y su campaña asociada (de forma que pase las validaciones descritas en esta sección), consulte el ejemplo Crear una línea de entrega garantizada .

Campo	Tipo	Descripción
`id`	Entero	Identificador único generado automáticamente de este objetivo de entrega.
`type`	string	Tipo de objetivo de entrega. Valores permitidos: - `"impressions"`: los artículos de línea de entrega garantizados con objetivos de impresión intentarán atender el número especificado de impresiones uniformemente en sus fechas de vuelo. Si el objetivo `type` de entrega es `"impressions"`, el presupuesto debe establecerse en el nivel de elemento de línea. - `"percentage"`: actualmente, el objetivo porcentual solo está disponible para los artículos de línea garantizados "exclusivos". Nota: Si el objetivo `type` de entrega es `"percentage"`, el elemento de línea no puede tener un presupuesto.
`disallow_non_guaranteed`	booleano	Cuando `true`, este elemento de línea siempre atenderá a los artículos de línea no garantizados que participan en la misma subasta (administrada).
`percentage`	Entero	Si el tipo de objetivo de entrega es `"percentage"`, este es el porcentaje real en el que se atenderá el elemento de línea de entrega garantizada. Los valores permitidos son enteros 0 <= n <= 100. Si el objetivo de `type` entrega es `"impressions"`, este campo debe ser `null`.
`reserved`	booleano	Este campo es obligatorio. Cuando `true`, este artículo de línea tiene el inventario "reservado"; es decir, el artículo de línea se establece para comprar un número o porcentaje garantizado de impresiones en el inventario de un vendedor durante su vuelo. Nota: No podrá establecer un elemento de `state` línea garantizado en a `"active"` menos que este campo esté establecido en `true`.
`guaranteed_delivery_version`	Entero	Esta marca temporal denota la versión del algoritmo de ritmo de entrega garantizada que se usa. Se puede establecer en el nivel de elemento de línea o miembro. La marca se quitará cuando se publique la nueva versión (2) del algoritmo en toda la plataforma. Valores permitidos: - `1` - `2` Predeterminado:`null`

Validaciones en elementos de línea de entrega garantizada

Para que un elemento de línea de entrega garantizada sirva, debe crear el elemento de línea y asociarlo a una o varias campañas. Las campañas no se crean automáticamente al configurar el elemento de línea Entrega garantizada.

Entre las validaciones adicionales de los elementos de línea de entrega garantizada se incluyen:

El elemento de línea debe tener un valor válido start_date y end_date.
lifetime_pacing debe establecerse en true.
enable_pacing debe establecerse en false.
manage_creative debe establecerse en true.
allow_safety_pacing debe establecerse en false.
La campaña inventory_type asociada debe ser "direct".
Si el tipo de objetivo de entrega es "impressions", el presupuesto debe establecerse en el nivel de elemento de línea.
Si el tipo de objetivo de entrega es "impressions", no se deben establecer los lifetime_budget campos y daily_budget .
Si el tipo de objetivo de entrega es "impressions", debe lifetime_budget_imps establecerse.
Si el tipo de objetivo de entrega es "percentage", el elemento de línea no puede tener un presupuesto asociado.
El elemento de revenue_type línea debe ser uno de:
- "cpm"
- "flat_fee"
El elemento de publishers_allowed línea debe establecerse en "direct".
Si asocias solo una campaña a un elemento de start_date línea, esa campaña es y end_date debe establecerse en null.

Estadísticas

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.

Primera ejecución y ú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 puede filtrar los elementos de línea en función de cuándo se atienden por primera y última vez, como se indica a continuación:

Recuperar solo los elementos de línea que nunca han servido

Pase never_run=true la cadena de consulta.

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?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á elementos de línea 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 los elementos de línea 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/line-item?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'

Recuperar solo los elementos de línea 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/line-item?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'

Recuperar solo los elementos de línea 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/line-item?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 los elementos de línea 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/line-item?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'

Recuperar solo los elementos de línea 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/line-item?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'

Recuperar solo los elementos de línea 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/line-item?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'

Los campos de la fecha de tipo también se pueden filtrar por nmin y nmax . El nmin filtro le permite encontrar fechas que son nulas o posteriores a la fecha especificada, y el nmax filtro le permite encontrar fechas que sean nulas o anteriores a la fecha especificada.

Alertas

Este campo le notifica las condiciones que impiden que el elemento de línea 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.

Nota:

En este momento, no hay advertencias para los elementos de línea.

Para recuperar elementos de línea basados en pausas, 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 todos los elementos de línea o elementos de línea específicos, pero los ejemplos siguientes solo cubren la recuperación de todos los elementos de línea, ya que es donde esta característica ofrece más valor.

Recuperar todos los elementos de línea y mostrar alertas

Pase show_alerts=true la cadena de consulta. Este parámetro agregará el alerts objeto a cada elemento de línea de la respuesta, independientemente de si el elemento de línea tiene pausas.

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/line-item?show_alerts=true'

{
    "response": {
        "status": "OK",
        "line-items": [

            {
                "id": 45047,
                "code": null,
                "name": "Line Item 1",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-04-01 00:00:00",
                "end_date": "2012-05-01 00:00:00",
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 4,
                            "message": "Flight end date is in the past."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 2",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-05-21 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 46308,
                "code": null,
                "name": "Test Line Item",
                "advertiser_id": 45278,
                "state": "inactive",
                "start_date": "2012-06-06 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        },
                        {
                            "id": 128,
                            "message": "All campaigns under this line item are inactive."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            ...
        ],
        ...
        }
    }
}

Recuperar solo elementos de línea 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/line-item?show_alerts=true&pauses=true'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45047,
                "code": null,
                "name": "Line Item 1",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-04-01 00:00:00",
                "end_date": "2012-05-01 00:00:00",
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 4,
                            "message": "Flight end date is in the past."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 2",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-05-21 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 46308,
                "code": null,
                "name": "Line Item 6",
                "advertiser_id": 45278,
                "state": "inactive",
                "start_date": "2012-06-06 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        }   
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            ...
        ],
        ...
        }
    }
}

Recuperar solo los elementos de línea 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",
        "line-items": [
            {
                "id": 45054,
                "code": null,
                "name": "Line Item 7",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-04-01 00:00:00",
                "end_date": "2012-05-01 00:00:00",
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [

                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45057,
                "code": null,
                "name": "Line Item 9",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-05-21 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [

                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 46345,
                "code": null,
                "name": "Line Item 12",
                "advertiser_id": 45278,
                "state": "active",
                "start_date": "2012-06-06 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [

                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            ...
        ],
        ...
        }
    }
}

Recuperar solo los elementos de línea 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 2 de pausa para recuperar todos los elementos de línea con fechas de inicio de vuelo que están en el futuro.

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?show_alerts=true&pauses=2'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45047,
                "code": null,
                "name": "Line Item 5",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-11-01 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 7",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-10-15 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },

            ...
        ],
        ...
        }
    }
}

Recuperar solo elementos de línea que tengan 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 1 de pausa y el identificador 2 de pausa para recuperar todos los elementos de línea que están establecidos en inactivos y tienen una fecha de estado de vuelo en el futuro.

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?show_alerts=true&pauses=3'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45047,
                "code": null,
                "name": "Line Item 3",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-11-01 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        },
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 7",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-10-15 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        },
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },

            ...
        ],
        ...
        }
    }
}

Pausas

Id.	Descripción
`1`	El estado se establece en inactivo.
`2`	El inicio del vuelo es en el futuro.
`4`	El final del vuelo está en el pasado.
`128`	Todas las campañas de este elemento de línea están inactivas.

Tarifa plana

El flat_fee objeto contiene los campos siguientes.

Campo	Tipo	Descripción
`flat_fee_status`	enumeración	Estado del desembolso de la tarifa plana. Valores posibles: `"pending"`, `"processing"`, `"allocated"`o `"error"`. Solo lectura.
`flat_fee_allocation_date`	Timestamp	Fecha en la que se programa la asignación de los ingresos de la tarifa plana a los editores. Ejemplo:`"2012-06-08 00:00:00"`. Este valor será `null` si es `flat_fee_type` diario.
`flat_fee_adjustment_id`	Entero	El identificador de los ajustes necesarios para esta tarifa plana.

Barrera

Los obstáculos solo se pueden establecer en un nivel, ya sea en línea o en campaña. Si se ha establecido un obstáculo en una campaña, no se puede establecer en el elemento de línea principal. Los obstáculos solo se pueden aplicar para el inventario administrado y no se pueden habilitar cuando se trabaja con un inventario de terceros.

Campo	Tipo	Descripción
`type`	enumeración	Tipo de obstáculo. Los valores posibles son: - `no_roadblock`: no hay ningún conjunto de obstáculos en el nivel de elemento de línea. - `normal_roadblock`: el elemento de línea sirve si el número de creatividades es mayor o igual que el número de espacios de anuncios disponibles. - `partial_roadblock`: el elemento de línea sirve cuando al menos una creatividad de cada tamaño se ajusta a una ranura de anuncio apta. - `exact_roadblock`: el elemento de línea sirve cuando el número de creatividades es igual al número de espacios de anuncios disponibles.
`master_width`	Entero	Ancho de la creatividad maestra. Establezca este valor solo cuando use el bloqueo de carreteras de nivel de página. Para el bloqueo de carreteras estándar, omita este campo o establezca el valor `0`en . (No establezca el valor en `null`.)
`master_height`	Entero	El alto del maestro creativo. Establezca este valor solo cuando use el bloqueo de carreteras de nivel de página. Para el bloqueo de carreteras estándar, omita este campo o establezca el valor `0`en . (No establezca el valor en `null`.)

La creatividad maestra es la creatividad con un tamaño que coincide master_height con y master_width especificado en el objeto roadblock. Si más de una creatividad coincide con ese tamaño, el sistema elegirá una como maestra.

La creatividad maestra se usa para el bloqueo de carreteras de nivel de página, donde se registra una impresión para el conjunto completo de creativos entregados para el obstáculo. Esa impresión grabada se basa en la creatividad maestra. Esto significa que si el maestro creativo no sirve, no se registrará ninguna impresión. Si desea usar el obstáculo de nivel creativo, donde cada entrega creativa se cuenta como una impresión, deje los master_width valores y master_height en blanco.

Ejemplos

Adición de un elemento de línea sin problemas con intervalos de presupuesto

En este ejemplo, crearemos un nuevo elemento de línea de conexión directa inactiva, "Lauren's Line Item", que usa intervalos de presupuesto. Ya hemos creado un pedido (238174) de inserción con períodos de facturación a los que queremos asociar el nuevo elemento de línea. Los intervalos presupuestados del elemento de línea se asociarán a los del orden de inserción a través del parent_interval_id campo de la budget_intervals matriz del elemento de línea.

$ cat line-item
{
    "line-item": {
        "name": "Lauren's Line Item",
        "state": "inactive",
        "insertion_orders": [
            {
                "id": 238174
            }
        ],
        "budget_intervals": [
            {
                "parent_interval_id": 1377
            },
            {
                "parent_interval_id": 1378
            }
        ]
    }
}

$ curl -b cookies -X POST -d @line-item.json "https://api.appnexus.com/line-item?&advertiser_id=599314"
{
  "response": {
    "status": "OK",
    "count": 1,
    "id": 2304063,
    "start_element": 0,
    "num_elements": 100,
    "line-item": {
      "id": 2304063,
      "code": null,
      "name": "Lauren's Line Item",
      "advertiser_id": 599314,
      "state": "inactive",
      "start_date": null,
      "end_date": null,
      "timezone": "EST5EDT",
      "discrepancy_pct": 0,
      "publishers_allowed": "all",
      "revenue_value": 0,
      "revenue_type": "cpm",
      "goal_type": "none",
      "goal_value": null,
      "last_modified": "2015-09-02 14:17:50",
      "click_url": null,
      "currency": "USD",
      "require_cookie_for_tracking": true,
      "profile_id": null,
      "member_id": 958,
      "comments": null,
      "remaining_days": null,
      "total_days": null,
      "manage_creative": false,
      "advertiser": {
        "id": 599314,
        "name": "Cindy's Adv"
      },
      "flat_fee": null,
      "delivery_goal": null,
      "labels": null,
      "broker_fees": null,
      "pixels": null,
      "insertion_orders": [
        {
          "id": 238174,
          "state": "inactive",
          "code": null,
          "name": "LH Test IO",
          "advertiser_id": 599314,
          "start_date": null,
          "end_date": null,
          "timezone": "EST5EDT",
          "last_modified": "2015-09-02 13:56:56",
          "currency": "USD",
          "budget_intervals": [
            {
              "id": 1377,
              "object_id": 238174,
              "object_type": "insertion_order",
              "start_date": "2015-09-02 00:00:00",
              "end_date": "2015-09-10 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": 1000,
              "lifetime_budget_imps": null,
              "lifetime_pacing": false,
              "enable_pacing": false,
              "daily_budget_imps": null,
              "daily_budget": null
            },
            {
              "id": 1378,
              "object_id": 238174,
              "object_type": "insertion_order",
              "start_date": "2015-09-10 00:00:00",
              "end_date": "2015-09-18 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": 1000,
              "lifetime_budget_imps": null,
              "lifetime_pacing": false,
              "enable_pacing": false,
              "daily_budget_imps": null,
              "daily_budget": null
            }
          ]
        }
      ],
      "goal_pixels": null,
      "imptrackers": null,
      "clicktrackers": null,
      "campaigns": null,
      "valuation": {
        "performance_mkt_managed": false,
      },
      "creatives": null,
      "budget_intervals": [
        {
          "id": 1379,
          "object_id": 2304063,
          "object_type": "campaign_group",
          "start_date": "2015-09-02 00:00:00",
          "end_date": "2015-09-10 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 1377,
          "budget_allocation": null
        },
        {
          "id": 1380,
          "object_id": 2304063,
          "object_type": "campaign_group",
          "start_date": "2015-09-10 00:00:00",
          "end_date": "2015-09-18 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 1378,
          "budget_allocation": null
        }
      ],
      "lifetime_budget": null,
      "lifetime_budget_imps": null,
      "daily_budget": null,
      "daily_budget_imps": null,
      "enable_pacing": null,
      "allow_safety_pacing": null,
      "lifetime_pacing": null,
      "lifetime_pacing_span": null,
      "lifetime_pacing_pct": null,
      "payout_margin": null
    }
  }
}

Adición de un elemento de línea sin conexión

En este ejemplo, crearemos un nuevo elemento de línea y asociaremos un píxel de conversión a nuestro nuevo elemento de línea.

Nota:

Todavía no estamos vinculando ninguna campaña a este elemento de línea; por lo tanto campaigns , se establece en null.

$ cat line-item
{
    "line-item": {
    "name": "Weekday French Speakers Q3 2012",
    "state": "inactive",
    "comments": "The name says it all -- that's who we're trying to advertise to",
    "daily_budget": null,
    "revenue_type": "cpa",
    "code": "wfspq312",
    "pixels": [
        {
        "id": "123456",
        "state": "inactive",
        "post_view_revenue": null,
        "post_click_revenue": "30.000000"
        }
    ],
    "start_date": "2011-11-04 00:00:00",
    "lifetime_budget": null,
    "end_date": null,
    "enable_pacing": null,
    "allow_safety_pacing": null,
    "publishers_allowed": "all",
    "campaigns": null
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

Adición de un elemento de línea con un objetivo de rendimiento de CPC

En este ejemplo, crearemos un elemento de línea con un objetivo de rendimiento de CPC. Estamos estableciendo un umbral de objetivo de costo por clic de 2,34 USD y un destino (para fines de informes) de 2,00 USD.

$ cat line-item
{
    "line-item": {
    "name": "Weekday French Speakers Q3 2012",
    "state": "inactive",
    "comments": "The name says it all -- that's who we're trying to advertise to",
    "daily_budget": null,
    "revenue_type": "cpm",
    "goal_type": "cpc",
    "valuation": {
        "goal_target":2.00,
        "goal_threshold":2.34
    }
    "lifetime_budget": null,
    "end_date": null,
    "enable_pacing": null,
    "allow_safety_pacing": null,
    "publishers_allowed": "all",
    "campaigns": null
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

Adición de un elemento de línea con un objetivo de rendimiento de CPA

En este ejemplo, crearemos un elemento de línea con un objetivo de rendimiento de CPA. Estamos estableciendo un umbral de objetivo de CPA de 4,56 USD y un destino (para fines de informes) de 4,00 USD.

$ cat line-item
{
    "line-item": {
    "name": "Weekday French Speakers Q3 2012",
    "state": "inactive",
    "comments": "The name says it all -- that's who we're trying to advertise to",
    "daily_budget": null,
    "revenue_type": "cpm",
    "goal_type": "cpa",
    "pixels": [
        {
        "id": "123456",
        "state": "inactive",
        "post_view_revenue": null,
        "post_click_revenue": "30.000000"
        }
    ],
    "goal_pixels":[
        {
        "id":"123456",
        "post_view_goal_threshold":4.56,
        "post_view_goal_target":4.00
        }
    ].
    "lifetime_budget": null,
    "end_date": null,
    "enable_pacing": null,
    "allow_safety_pacing": null,
    "publishers_allowed": "all",
    "campaigns": null
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

Adición de un elemento de línea de oferta de rendimiento

En este ejemplo, crearemos un elemento de línea de oferta de rendimiento que compre inventario administrado y multi neta sobre una base de CPC.

$ cat line-item
{
    "line-item": {
        "name": "US CA",
        "state": "inactive",
        "daily_budget": null,
        "revenue_type": "cpc",
        "revenue_value": "5.00",
        "goal_type": "none",
        "valuation": {
            "performance_mkt_managed": true,
        },
        "lifetime_budget": null,
        "end_date": null,
        "enable_pacing": null,
        "allow_safety_pacing": null,
        "publishers_allowed": "all",
        "campaigns": null,
        "manage_creative": true,
        "payout_margin": 0.2
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

Visualización de un elemento de línea

Para ver un elemento de línea específico, debemos pasar los identificadores de línea y anunciante a través de la cadena de consulta. Este elemento de línea ya tiene un píxel de conversión configurado.

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?id=164532&advertiser_id=52049'

{
    "response": {
    "status": "OK",
    "line-item": {
        "id": 164532,
        "code": "wfspq312",
        "name": "Weekday French Speakers Q3 2012",
        "advertiser_id": 52049,
        "state": "inactive",
        "start_date": "2011-11-04 00:00:00",
        "end_date": null,
        "timezone": "EST5EDT",
        "discrepancy_pct": 0,
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "enable_pacing": null,
        "allow_safety_pacing": null,
        "publishers_allowed": "all",
        "revenue_value": 0,
        "revenue_type": "cpa",
        "pixels": [
        {
            "id": "39688",
            "state": "inactive",
            "post_view_revenue": null,
            "post_click_revenue": "30.000000"
        }
        ],
        "campaigns": null,
        "insertion_orders": null,
        "goal_type": "none",
        "goal_value": null,
        "goal_pixels": null,
        "last_modified": "2012-06-19 20:29:38",
        "all_stats": null,
        "click_url": null,
        "currency": "USD",
        "require_cookie_for_tracking": true,
        "labels": null,
        "advertiser": {
        "id": 52049,
        "name": "Cody's Great Advertiser"
        },
        "broker_fees": null,
        "profile_id": null,
        "member_id": 1282,
        "flat_fee": null,
        "imptrackers": null,
        "clicktrackers": null,
        "comments": "The name says it all -- that's who we're trying to advertise to",
        "is_malicious": false,
        "remaining_days": null,
        "total_days": 60
    },
    "count": 1,
    "start_element": null,
    "num_elements": null
    }
}

Visualización de todos los artículos de línea de un anunciante

A diferencia de los ejemplos anteriores, este elemento de línea tiene dos campañas asociadas, así como una goal_pixels matriz. Tenga en cuenta que, aunque este anunciante solo tiene un elemento de línea, se devuelve a través de la line-items matriz JSON.

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=51'

{
   "response":{
      "status":"OK",
      "line-items":[
         {
            "id":2,
            "code":null,
            "name":"Default Line Item",
            "advertiser_id":51,
            "state":"active",
            "start_date":null,
            "end_date":null,
            "timezone":"EST5EDT",
            "lifetime_budget":null,
            "lifetime_budget_imps":null,
            "daily_budget":null,
            "daily_budget_imps":null,
            "enable_pacing":false,
            "publishers_allowed":"all",
            "lifetime_spend":null,
            "lifetime_imps":null,
            "daily_spend":null,
            "daily_imps":null,
            "revenue_value":null,
            "revenue_type":null,
            "pixels":[
               {
                  "id":"934",
                  "state":"active",
                  "post_view_revenue":null,
                  "post_click_revenue":null
               }
            ],
            "campaigns":[
               {
                  "id":"21999",
                  "name":"My second campaign",
                  "state":"inactive"
               },
               {
                  "id":"21180",
                  "name":"My first campaign",
                  "state":"active"
               }
            ],
            "goal_type":"cpa",
            "goal_value":null,
            "goal_pixels":[
               {
                  "id":934,
                  "state":"active",
                  "post_view_goal":1,
                  "post_click_goal":2
               }
            ],
            "labels" [
               {
                  "value: "First Contact",
                  "id": 7,
                  "name": "Trafficker"
               },
               {
                  "value: "Second Contact",
                  "id": 8,
                  "name": "Sales Rep"
               },
            "last_modified":"2010-06-09 19:32:56",
            "comments": null
            "is_malicious": false,
            "remaining_days": null,
            "total_days": 30
         }
      ],
      "count":1,
      "start_element":null,
      "num_elements":null
   }
}

Modificación de un intervalo presupuestado en un elemento de línea de conexión directa

Nota:

No modifique los valores de los start_date campos o end_date dentro del intervalo presupuestado en el elemento de línea. El elemento de línea hereda sus fechas de intervalo presupuestado del orden de inserción primario.

$ cat modify-budget-interval
{
    "line-item": {
        "budget_intervals": [
            {
                "parent_interval_id": 197186,
                "id": 219368,
                "lifetime_budget": 100
            },
            {
                "parent_interval_id": 197187,
                "id": 219369,
                "lifetime_budget": 100
            }
        ]
    }
}
curl -b cookies -X PUT -d @modify-budget-interval "https://api.appnexus.com/line-item?advertiser_id=608591&id=3319754"
{
  "response": {
    "status": "OK",
    "count": 1,
    "id": "3319754",
    "start_element": 0,
    "num_elements": 100,
    "line-item": {
      "id": 3319754,
      "code": null,
      "name": "Seamless Line Item Test",
      "advertiser_id": 608591,
      "state": "active",
      "start_date": null,
      "end_date": null,
      "timezone": "EST5EDT",
      "discrepancy_pct": 0,
      "publishers_allowed": "all",
      "revenue_value": 0,
      "revenue_type": "cpm",
      "goal_type": "none",
      "goal_value": null,
      "last_modified": "2016-09-01 17:44:32",
      "click_url": null,
      "currency": "USD",
      "require_cookie_for_tracking": true,
      "profile_id": null,
      "member_id": 958,
      "comments": null,
      "remaining_days": null,
      "total_days": null,
      "manage_creative": false,
      "creative_distribution_type": null,
      "line_item_type": "standard_v1",
      "prefer_delivery_over_performance": false,
      "advertiser": {
        "id": 608591,
        "name": "Don Test Advertiser"
      },
      "flat_fee": null,
      "delivery_goal": null,
      "labels": null,
      "broker_fees": null,
      "pixels": null,
      "insertion_orders": [
        {
          "id": 379643,
          "state": "inactive",
          "code": null,
          "name": "Seamless Insertion Order Test",
          "advertiser_id": 608591,
          "start_date": null,
          "end_date": null,
          "timezone": "EST5EDT",
          "last_modified": "2016-08-30 15:23:07",
          "currency": "USD",
          "budget_intervals": [
            {
              "id": 197186,
              "object_id": 379643,
              "object_type": "insertion_order",
              "start_date": "2016-09-01 00:00:00",
              "end_date": "2016-09-30 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": null,
              "lifetime_budget_imps": null,
              "daily_budget_imps": null,
              "daily_budget": null,
              "enable_pacing": false,
              "lifetime_pacing": false,
              "lifetime_pacing_pct": null
            },
            {
              "id": 197187,
              "object_id": 379643,
              "object_type": "insertion_order",
              "start_date": "2016-10-01 00:00:00",
              "end_date": "2016-10-31 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": null,
              "lifetime_budget_imps": null,
              "daily_budget_imps": null,
              "daily_budget": null,
              "enable_pacing": false,
              "lifetime_pacing": false,
              "lifetime_pacing_pct": null
            }
          ]
        }
      ],
      "goal_pixels": null,
      "imptrackers": null,
      "clicktrackers": null,
      "campaigns": null,
      "valuation": {
        "min_margin_pct": null,
        "max_avg_cpm": null,
        "min_avg_cpm": null,
        "goal_target": null,
        "goal_threshold": null,
        "no_revenue_log": false,
        "performance_mkt_managed": false,
        "bid_price_pacing_enabled": false,
        "bid_price_pacing_lever": 0,
        "goal_confidence_threshold": null
      },
      "creatives": null,
      "budget_intervals": [
        {
          "id": 219368,
          "object_id": 3319754,
          "object_type": "campaign_group",
          "start_date": "2016-09-01 00:00:00",
          "end_date": "2016-09-30 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 197186,
          "lifetime_budget": 100,
          "lifetime_budget_imps": null,
          "lifetime_pacing": false,
          "enable_pacing": true,
          "daily_budget_imps": null,
          "daily_budget": null
        },
        {
          "id": 219369,
          "object_id": 3319754,
          "object_type": "campaign_group",
          "start_date": "2016-10-01 00:00:00",
          "end_date": "2016-10-31 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 197187,
          "lifetime_budget": 100,
          "lifetime_budget_imps": null,
          "lifetime_pacing": false,
          "enable_pacing": true,
          "daily_budget_imps": null,
          "daily_budget": null
        }
      ],
      "expected_value_model": null,
      "custom_models": null,
      "inventory_discovery": null,
      "inventory_discovery_budget": null,
      "incrementality": null,
      "lifetime_budget": null,
      "lifetime_budget_imps": null,
      "daily_budget": null,
      "daily_budget_imps": null,
      "enable_pacing": null,
      "allow_safety_pacing": null,
      "lifetime_pacing": null,
      "lifetime_pacing_span": null,
      "lifetime_pacing_pct": null,
      "payout_margin": null
    },
    "dbg_info": {
      ...
    }
  }
}

Nota:

Esta sección solo se aplica a los clientes de Publisher Ad Server. Cree un elemento de línea de entrega garantizado.

La creación de un elemento de línea de entrega garantizada requiere que el combinado de línea o campaña cumpla todas las validaciones descritas en la sección Objetivo de entrega anterior. Tenga en cuenta que también tendrá que asociar el elemento de línea a un perfil de destino.

En este ejemplo, crearemos un elemento de línea y, a continuación, una campaña asociada a ese elemento de línea.

Cree siempre primero el elemento de línea. Para evitar una condición de carrera en la API, cree primero el elemento de línea y, después, la campaña asociada.

$ cat guaranteed-delivery-line-item.json
     
{
    "line-item": {
        "name": "Rich's Second Guaranteed Line Item - Impressions Delivery Goal",
        "state": "inactive",
        "lifetime_budget_imps": 10000,
        "lifetime_pacing": true,
        "enable_pacing": false,
        "manage_creative": true,
        "allow_safety_pacing": false,
        "delivery_goal": {
            "type": "impressions",
            "disallow_non_guaranteed": true
        },
        "daily_budget": null,
        "revenue_type": "cpm",
        "start_date": "2015-05-15 00:00:00",
        "end_date": "2015-05-20 00:00:00",
        "lifetime_budget": null,
        "publishers_allowed": "direct",
        "campaigns": null
    }
}

$ curl -b cookies -X POST -d @guaranteed-delivery-line-item.json 'https://api.appnexus.com/line-item?advertiser_id=561703'

Ahora que tenemos un elemento de línea de entrega garantizada, debemos crear la campaña asociada:

$ cat campaign.json


{
    "campaign": {
         "state": "inactive",
         "name": "Rich's Guaranteed Campaign",
         "advertiser_id": 41884,
         "line_item_id": 232854,
         "inventory_type": "direct"
    }
}

$ curl -b cookies -X POST -d @campaign.json 'https://api.appnexus.com/campaign?advertiser_id=561703'

Tenga en cuenta que si asocia una sola campaña a un elemento de línea, start_date y end_date para la campaña debe establecerse nullen .

Eliminación de un elemento de línea

curl -b cookies -X DELETE "https://api.appnexus.com/line-item?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

Servicio de elemento de línea

API de REST

Campos JSON

Anunciante

Etiquetas

Tasas de broker

Creación de una cuota de broker

Modificación de una cuota de broker

Pixels

Pedidos de inserción

Campañas

Valoración

Creativos

Intervalos de presupuesto

Píxeles objetivo

Objetivo de entrega

Estadísticas

Primera ejecución y última ejecución

Recuperar solo los elementos de línea que nunca han servido

Recuperar solo los elementos de línea que se sirvieron por primera vez en o después de una fecha específica

Recuperar solo los elementos de línea que se sirvieron por primera vez en o antes de una fecha específica

Recuperar solo los elementos de línea que se sirvieron por primera vez dentro de un intervalo de fechas específico

Recuperar solo los elementos de línea que se sirvieron por última vez en o después de una fecha específica

Recuperar solo los elementos de línea que se sirvieron por última vez en o antes de una fecha específica

Recuperar solo los elementos de línea que se sirvieron por última vez dentro de un intervalo de fechas específico

Alertas

Recuperar todos los elementos de línea y mostrar alertas

Recuperar solo elementos de línea que tengan al menos una pausa

Recuperar solo los elementos de línea que no tienen pausas

Recuperar solo los elementos de línea que tienen una pausa específica

Recuperar solo elementos de línea que tengan dos o más pausas específicas

Pausas

Tarifa plana

Barrera

Ejemplos

Adición de un elemento de línea sin problemas con intervalos de presupuesto

Adición de un elemento de línea sin conexión

Adición de un elemento de línea con un objetivo de rendimiento de CPC

Adición de un elemento de línea con un objetivo de rendimiento de CPA

Adición de un elemento de línea de oferta de rendimiento

Visualización de un elemento de línea

Visualización de todos los artículos de línea de un anunciante

Modificación de un intervalo presupuestado en un elemento de línea de conexión directa

Eliminación de un elemento de línea

Temas relacionados

Recursos adicionales