Servicio de línea de pedido

Las líneas de pedido de una orden de inserción representan las estrategias acordadas que ejecutará para el anunciante. Después de configurar una línea de pedido y, opcionalmente (dependiendo de si el anunciante utiliza órdenes de inserción) asociarla a una o varias órdenes de inserción, puede crear campañas para especificar cómo gastar el dinero para cumplir su acuerdo. Las líneas de pedido son donde registrará los "ingresos registrados" mediante los campos Yrevenue_value, que describen el tipo de ingresos (CPM, CPA, etc.) y el revenue_type importe que le pagarán sus anunciantes.

Xandr sugiere asociar sus líneas de pedido a los pedidos de inserción para conservar el historial de datos de ritmo y rendimiento en todas las líneas de pedido en una sola orden de inserción, y para optimizar la configuración de relaciones duraderas con anunciantes añadiendo intervalos de presupuesto a un pedido de inserción. Las líneas de pedido se pueden asociar a una o varias órdenes de inserción, pero solo a las del mismo tipo (una orden de inserción que utiliza intervalos de presupuesto o otra que no la utiliza). Cada línea de pedido está asociada a una o más campañas secundarias; Las estrategias de pujas y la segmentación de inventario se establecen a nivel de campaña.

API de REST

Campos JSON

Anunciante

Etiquetas

Puede usar el servicio de etiquetas de solo lectura para ver todas las etiquetas posibles para líneas de pedido, anunciantes, órdenes de inserción, campañas y editores. Este servicio también le permite ver las etiquetas que ya se han aplicado a los objetos.

Tarifas del agente

Cuando una red utiliza un corredor para entregar una impresión, paga una tarifa al corredor por ese servicio. Este valor varía entre las distintas redes, los distintos agentes y las distintas campañas. Por lo tanto, la red debe especificar cuánto pagará a cada corredor que utilice. Esto también se puede hacer a nivel de campaña (Servicio de campaña) o a nivel de orden de inserción (Servicio de orden de inserción).

Para crear o editar intermediarios, consulte el Servicio de intermediario.

Crear una tarifa de agente

$ 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,

        }
}

Modificar una tarifa de agente

$ 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 siguientes campos:

Órdenes de inserción

Campañas

Cada objeto de la campaigns matriz incluye los siguientes campos.

Valoración

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

El valuation objeto contiene los siguientes campos:

Recursos creativos

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

Intervalos presupuestarios

Los intervalos de presupuesto de las líneas de pedido continuas deben ser copias de los intervalos de presupuesto definidos en sus órdenes de inserción principales. Los intervalos de presupuesto de la partida tendrán automáticamente el mismo start_date y end_date como su orden de inserción correspondiente, intervalos de presupuesto, pero deben tener presupuestos distintos. Funcionan como "subpresupuestos" específicos de partidas del presupuesto en el intervalo de presupuesto de la orden de inserción correspondiente.

El campo crea los intervalos de presupuesto de las líneas de pedido (y los vincula a los intervalos de presupuesto de las órdenes de parent_interval_id inserción). Al crear una nueva línea de pedido directa, debe rellenar la budget_intervals matriz con referencias a todos los intervalos de presupuesto en todas las órdenes de inserción que asocie con esa línea de pedido (las órdenes de inserción se asocian a las líneas de pedido a través de la insertion_orders matriz en el Servicio de líneas de pedido). Esto se hace agregando objetos a la matriz que contienen un solo campo, parent_interval_id, cuyo valor es un intervalo de presupuesto de la orden de inserción que la línea de pedido debe heredar. Consulta Añadir una línea de pedido fluida con intervalos de presupuesto en la sección de 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_date) de diferentes intervalos presupuestarios en la misma partida no pueden superponerse.
• Los intervalos de presupuesto de la partida pueden tener presupuestos de duración ilimitados (es decir, si esos campos de presupuesto se dejan establecidos en null).
• Los intervalos de presupuesto 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 de presupuesto de nivel de orden de inserción se propagan a los intervalos de presupuesto de nivel de línea de pedido correspondientes (por ejemplo, al eliminar un intervalo de presupuesto en la orden de inserción, también se eliminará ese intervalo de presupuesto en todas las partidas que lo utilicen).
• Si va a aumentar el presupuesto para el intervalo de presupuesto de la línea de pedido, primero debe aumentar el presupuesto para el intervalo de presupuesto en la orden de inserción principal (de lo contrario, es posible que no tenga presupuesto suficiente). Para obtener más información, consulta Servicio de órdenes de inserción.

Cada objeto de la budget_intervals matriz contiene los siguientes campos.

Píxeles de objetivo

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

Cada objeto de la goal_pixels matriz incluye los siguientes campos:

Objetivo de entrega

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

Estadísticas

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

Primera ejecución y última ejecución

Para incluir los first_run campos and last_run en una GET respuesta, pase flight_info=true la cadena de consulta. También puede filtrar las líneas de pedido en función de cuándo se publicaron por primera vez y cuándo se sirvieron por última vez, de la siguiente manera:

Recuperar solo líneas de pedido que nunca se 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'

Recuperar solo las líneas de pedido que se publicaron por primera vez en una fecha determinada o después

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 las líneas de pedido que se publicaron por primera vez en una fecha específica o antes

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 las líneas de pedido 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 las líneas de pedido que se publicaron por última vez a partir de una fecha determinada

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 las líneas de pedido que se publicaron por última vez en una fecha determinada o antes de esa fecha

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 las líneas de pedido 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 del tipo fecha también se pueden filtrar por nmin y nmax . El nmin filtro le permite buscar fechas que sean nulas o posteriores a la fecha especificada, y el nmax filtro le permite buscar fechas que sean nulas o anteriores a la fecha especificada.

Alertas

Este campo le notifica las condiciones que impiden que la línea de pedido se publique. Hay dos tipos de alertas: pausas y advertencias. Las pausas se consideran intencionadas y dirigidas por el usuario, mientras que las advertencias se consideran no intencionadas.

Para recuperar elementos de línea en función de 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 de cadena de consulta y ejemplos. 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 ahí es donde esta característica ofrece el mayor valor.

Recuperar todas las líneas de pedido 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 o no.

$ 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 líneas de pedido 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 las líneas de pedido 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 las líneas de pedido que tienen una pausa específica

Pase show_alerts=true&pauses=PAUSE_ID la cadena de consulta. Para ver los identificadores de pausa, consulta la tabla de pausas a continuación.

En este ejemplo, usamos el id 2 . de pausa para recuperar todas las líneas de pedido con fechas de inicio de paquetes piloto que son futuras.

$ 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 líneas de pedido que tienen dos o más pausas específicas

Pase show_alerts=true&pauses=SUM_OF_PAUSE_IDS la cadena de consulta. Para ver los identificadores de pausa, consulta la tabla de pausas a continuación.

En este ejemplo, sumamos el id 1 . de pausa y el id 2 . de pausa para recuperar todas las líneas de pedido que están configuradas como inactivas y que tienen una fecha de estado piloto 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

Tarifa plana

El flat_fee objeto contiene los siguientes campos.

Obstáculo

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

El creativo maestro es el creativo con un tamaño que coincida con el master_height y master_width especificado en el objeto de bloqueo. Si más de una creatividad coincide con ese tamaño, el sistema elegirá una como maestra.

La creatividad maestra se utiliza para el roadblock a nivel de página, donde se registra una impresión del conjunto completo de creativos entregados para el roadblock. Esa impresión grabada se basa en el maestro creativo. Esto significa que si el maestro creativo no sirve, no se registrará ninguna impresión. Si quieres usar el roadblocking a nivel creativo, donde cada creatividad entregada se cuenta como una impresión, deja los master_width valores and master_height en blanco.

Ejemplos

Añada una línea de pedido fluida con intervalos de presupuesto

En este ejemplo, crearemos una nueva línea de pedido sin interrupciones inactiva, "Lauren's Line Item", que utilice intervalos de presupuesto. Ya hemos creado una orden (238174) de inserción con períodos de facturación a los que queremos asociar la nueva línea de pedido. Los intervalos de presupuesto de la línea de pedido se asociarán a los de la orden de inserción a través del parent_interval_id campo de la budget_intervals matriz de la línea de pedido.

$ 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
    }
  }
}

Añadir una línea de pedido no fluida

En este ejemplo, crearemos una nueva línea de pedido y asociaremos un píxel de conversión a nuestra nueva línea de pedido.

$ 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"

Agregar una línea de pedido con un objetivo de rendimiento de CPC

En este ejemplo, crearemos una línea de pedido con un objetivo de rendimiento de CPC. Establecemos un umbral de objetivo de coste por clic de 2,34 USD y un objetivo (para la creación 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"

Agregar una línea de pedido con un objetivo de rendimiento de CPA

En este ejemplo, crearemos una línea de pedido con un objetivo de rendimiento de CPA. Establecemos un umbral objetivo de CPA de 4,56 USD y un objetivo (para la presentación 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"

Agregar una línea de pedido de oferta de rendimiento

En este ejemplo, crearemos una línea de pedido de rendimiento que compre tanto inventario gestionado como cruzado por 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"

Ver una línea de pedido

Para ver una línea de pedido específica, debemos pasar la línea de pedido y los identificadores de anunciantes a través de la cadena de consulta. Esta línea de pedido 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
    }
}

Ver todas las líneas de pedido de un anunciante

A diferencia de los ejemplos anteriores, esta línea de pedido tiene dos campañas adjuntas, así como una goal_pixels matriz. Tenga en cuenta que, aunque este anunciante solo tenga una línea de pedido, 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
   }
}

Modificar un intervalo de presupuesto en una línea de pedido sin interrupciones

$ 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": {
      ...
    }
  }
}

$ 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'

$ 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'

Eliminar una línea de pedido

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"}
            }
    }
}

Temas relacionados

• Procedimientos recomendados de API
• Semántica de API
• Servicio de campaña
• Servicio de píxeles de conversión
• Servicio de órdenes de inserción