API de análisis de datos: servicio de orden de inserción

Información general

La API y los servicios de Yield Analytics se exponen a través de una interfaz basada en REST. Su objetivo es hacer que el desarrollo de la funcionalidad personalizada sea cómodo para los desarrolladores experimentados con Web 2.0, AJAX, REST y plataformas de desarrollo orientadas a servicios. Los desarrolladores deben estar familiarizados con los paradigmas de aplicaciones basadas en web, incluidos AJAX, XML, JSON y el protocolo HTTP (S) antes de intentar desarrollar con la API y los servicios de Yield Analytics.

Actualmente, el servicio de órdenes de inserción expone interfaces relacionadas con:

  • Entrega garantizada y capacidad de artículos de línea a nivel de pedido
  • Entrega histórica de artículos de línea en el nivel de pedido

Tipos de contenido

La API de REST de servicio está diseñada actualmente para admitir el siguiente tipo de contenido:

  • JSON - using Content-type: application/json

Seleccionar el tipo de contenido deseado es una elección que el desarrollador de API debe hacer caso por caso. La funcionalidad de la API es simétrica entre los tipos de contenido. Los desarrolladores de API pueden especificar el tipo de contenido deseado en los parámetros del método HTTP GET o POST o a través de su biblioteca de cliente AJAX o HTTP.

Comprobación de errores y códigos de estado

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST de servicio para detectar errores propagados a partir de llamadas API. Las llamadas correctas al servicio darán como resultado códigos de respuesta de 200 intervalos. Las respuestas HTTP de rango 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos experimenten cambios durante el desarrollo BETA de la API, sin embargo, los rangos no lo harán.

Seguridad

La API de servicio expone los datos de la aplicación de forma segura. El uso de la funcionalidad de la API está restringido a los usuarios autenticados y se expone a través de protocolos de transporte seguros. El acceso a la API debe realizarse en el siguiente contexto:

Autenticación

Para obtener más información sobre la autenticación, consulte API de Yield Analytics - Proceso de autenticación.

Confidencialidad

La confidencialidad se mantiene mediante el uso de la comunicación basada en Secure Socket Layer para interactuar con la API de Yield Analytics. Los desarrolladores de API deben preferir el uso de HTTPS sobre una comunicación insegura de HTTP siempre que sea posible. Consulte la biblioteca de clientes HTTP para saber cómo habilitar HTTP sobre SSL al desarrollar fuera del contexto de un explorador web.

Host

https://api.appnexus.com/imf/

Paths

Consigue capacidad garantizada para un solo pedido

GET /api/v1/rest/order/capacity/future/{externalId}/{nbDays}

  • Descripción

    Obtén capacidad dinámica de entrega garantizada como CSV para una zona horaria determinada.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter nbDays nbDays true Entero (int32)
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/future/1/1' -i -H 'Content-Type: application/json' 
  -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'

  • Ejemplo de solicitud HTTP

    GET /api/v1/rest/order/capacity/future/1/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
"externalId" : "1",
"nextHours" : {
"20200619T05:00+1000" : 1000,
"20200619T12:00+1000" : 1000,
"20200619T06:00+1000" : 1000,
"20200619T13:00+1000" : 1000,
"20200619T20:00+1000" : 1000,
"20200619T04:00+1000" : 1000,
"20200619T07:00+1000" : 1000,
"20200619T21:00+1000" : 1000,
"20200619T03:00+1000" : 1000,
"20200619T10:00+1000" : 1000,
"20200619T08:00+1000" : 1000,
"20200619T11:00+1000" : 1000,
"20200619T02:00+1000" : 1000,
"20200619T17:00+1000" : 1000,
"20200619T00:00+1000" : 1000,
"20200619T09:00+1000" : 1000,
"20200619T16:00+1000" : 1000,
"20200619T23:00+1000" : 1000,
"20200619T18:00+1000" : 1000,
"20200619T15:00+1000" : 1000,
"20200619T01:00+1000" : 1000,
"20200619T19:00+1000" : 1000,
"20200619T14:00+1000" : 1000,
"20200619T22:00+1000" : 1000
},
"nextDays" : {
"20200619T00:00+1000" : 240000
},
"targetings" : [ {
"start" : "2020-03-19",
"end" : "2020-06-19",
"expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') 
or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and 
segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and 
size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and 
segment-4860908 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
segment-3222990 in ('true') and segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and 
size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and 
segment-4860941 in ('true')",
"impressionCap" : 5,
"impressionCapPeriod" : 77,
"dynamic" : false
} ]
} ]

Obtenga capacidad dinámica de entrega garantizada como CSV para una zona horaria única

GET /api/v1/rest/order/capacity/guaranteed/future/csv/{nbDays}/{timeZone}

  • Descripción

    Obtén capacidad dinámica de entrega garantizada como CSV para una zona horaria determinada.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter nbDays nbDays true Entero (int32)
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar string

  • Consume

    Prueba/CSV

  • Produce

    Prueba/CSV

  • Tags

    Puntos de conexión del servicio de la orden de inserción

Obtener capacidad dinámica de entrega garantizada como CSV por grupo de id. de pedido para doble zona horaria

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/csv/{nbDays}/{timeZone}/{timeZoneSecond}

  • Descripción

    Obtén capacidad dinámica de entrega garantizada como CSV para un grupo de pedidos dentro de una zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter timeZoneSecond timeZoneSecond true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar string

  • Consume

    Prueba/CSV

  • Produce

    Prueba/CSV

  • Tags

    Puntos de conexión del servicio de la orden de inserción

Obtener capacidad dinámica de entrega garantizada como CSV por grupo de id. de pedido para una sola zona horaria

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/csv/{nbDays}/{timeZone}

  • Descripción

    Obtén capacidad dinámica de entrega garantizada como CSV para un grupo de pedidos dentro de una zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar string

  • Consume

    application/json

  • Produce

    Prueba/CSV

  • Tags

    Puntos de conexión del servicio de la orden de inserción

Obtener capacidad dinámica de entrega garantizada como CSV por grupo de id. de pedido para doble zona horaria

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/csv/{nbDays}/{timeZone}/{timeZoneSecond}

  • Descripción

    Obtén capacidad dinámica de entrega garantizada como CSV para un grupo de pedidos con doble zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter timeZoneSecond timeZoneSecond true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar string

  • Consume

    application/json

  • Produce

    Prueba/CSV

  • Tags

    Puntos de conexión del servicio de la orden de inserción

Obtener capacidad dinámica de entrega garantizada como CSV por grupo de id. de pedido para una sola zona horaria

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/{nbDays}/{timeZone}

  • Descripción

    Obtenga capacidad garantizada para un grupo de pedidos dentro de una zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    Prueba/CSV

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/orderids/1/EST' -i -X 
POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"externalOrderIdPool" : 
{
"orderIds" : [ "1" ]
}
}'

  • Ejemplo de solicitud HTTP

    POST /api/v1/rest/order/capacity/guaranteed/future/orderids/1/EST HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 60

{
"externalOrderIdPool" : {
"orderIds" : [ "1" ]
}
}

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
"externalId" : "1",
"nextHours" : {
"20200619T05:00+1000" : 1000,
"20200619T12:00+1000" : 1000,
"20200619T06:00+1000" : 1000,
"20200619T13:00+1000" : 1000,
"20200619T20:00+1000" : 1000,
"20200619T04:00+1000" : 1000,
"20200619T07:00+1000" : 1000,
"20200619T21:00+1000" : 1000,
"20200619T03:00+1000" : 1000,
"20200619T10:00+1000" : 1000,
"20200619T08:00+1000" : 1000,
"20200619T11:00+1000" : 1000,
"20200619T02:00+1000" : 1000,
"20200619T17:00+1000" : 1000,
"20200619T00:00+1000" : 1000,
"20200619T09:00+1000" : 1000,
"20200619T16:00+1000" : 1000,
"20200619T23:00+1000" : 1000,
"20200619T18:00+1000" : 1000,
"20200619T15:00+1000" : 1000,
"20200619T01:00+1000" : 1000,
"20200619T19:00+1000" : 1000,
"20200619T14:00+1000" : 1000,
"20200619T22:00+1000" : 1000
},
"nextDays" : {
"20200619T00:00+1000" : 240000
},
"targetings" : [ {
"start" : "2020-03-19",
"end" : "2020-06-19",
"expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true')",
"impressionCap" : 5,
"impressionCapPeriod" : 77,
"dynamic" : false
} ]
} ]

Obtener capacidad dinámica de entrega garantizada por grupo de identificador de pedido para doble zona horaria

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/{nbDays}/{timeZone}/{timeZoneSecond}

  • Descripción

    Obtenga capacidad garantizada para un grupo de pedidos con doble zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter timeZoneSecond timeZoneSecond true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/orderids/1/Australia/Sydney' -i -X 
  POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "externalOrderIdPool" : 
  {
    "orderIds" : [ "1" ]
  }
}'

  • Ejemplo de solicitud HTTP

    POST /api/v1/rest/order/capacity/guaranteed/future/orderids/1/Australia/Sydney HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 60

{
  "externalOrderIdPool" : {
    "orderIds" : [ "1" ]
  }
}

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and 
     segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
     segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and 
     size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and 
     segment-4860908 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
     segment-3222990 in ('true') and segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and 
     size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and 
     segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

Obtener capacidad dinámica de entrega garantizada por grupo de id. de pedido para una sola zona horaria

GET /api/v1/rest/order/capacity/guaranteed/future/{nbDays}/{timeZone}

  • Descripción

    Obtenga capacidad garantizada para un grupo de pedidos dentro de una zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/orderids/1/EST' -i -X POST 
   -H 'Content-Type: application/json;charset=UTF-8' -d '{
   "externalOrderIdPool" : 
  {
    "orderIds" : [ "1" ]
  }
}'

  • Ejemplo de solicitud HTTP

    POST /api/v1/rest/order/capacity/guaranteed/future/orderids/1/EST HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 60

{
  "externalOrderIdPool" : {
    "orderIds" : [ "1" ]
  }
}

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
     and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

Obtenga capacidad dinámica de entrega garantizada para doble zona horaria

GET /api/v1/rest/order/capacity/guaranteed/future/{nbDays}/{timeZone}/{timeZoneSecond}

  • Descripción

    Obtenga capacidad garantizada para un grupo de pedidos con doble zona horaria.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter timeZone timeZone true string
    PathParameter timeZoneSecond timeZoneSecond true string
    PathParameter nbDays nbDays true Entero (int32)
    BodyParameter externalOrderIdPool externalOrderIdPool true ExternalOrderIdPool
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/1/Australia/Sydney' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}'

  • Ejemplo de solicitud HTTP

    GET /api/v1/rest/order/capacity/guaranteed/future/1/Australia/Sydney HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
     and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and 
     segment-4860908 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
     segment-3222990 in ('true') and segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and 
     size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') 
     and segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

Obtener capacidad histórica de entrega garantizada como JSON

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter externalId externalId true string
    PathParameter startDate startDate true string
    PathParameter endDate endDate true string
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar OrderDeliveryInfo

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/order/delivery/1/2016-06-01/2016-07-01' -i -H 
'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}'

  • Ejemplo de solicitud HTTP

    GET /api/v1/rest/order/delivery/1/2016-06-01/2016-07-01 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 241

{
  "externalOrderId" : "1",
  "impressions" : 20,
  "orderLineDeliveryDetail" : {
    "1" : [ {
      "impressions" : 10,
      "date" : "05/19/2020"
    } ],
    "2" : [ {
      "impressions" : 10,
      "date" : "06/19/2020"
    } ]
  }
}

Obtener inventario de órdenes de inserción con JSON

POST /api/v1/rest/order/inventory/apas/{startDate}/{endDate}/{consumptionFilter}

  • Descripción

    Obtenga el inventario de órdenes de inserción con JSON.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter startDate startDate true string
    PathParameter endDate endDate true string
    PathParameter consumptionFilter consumptionFilter true string
    PathParameter arrayVars arrayVars false objeto
    BodyParameter body body true string
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

Obtener inventario y contención de órdenes de inserción con JSON

POST /api/v1/rest/order/inventoryandcontention/apas/{startDate}/{endDate}/{consumptionFilter}

  • Descripción

    Obtenga el inventario y la contención de las órdenes de inserción con JSON.

  • Parámetros

    Tipo Nombre Descripción Obligatorio Esquema
    PathParameter startDate startDate true string
    PathParameter endDate endDate true string
    PathParameter consumptionFilter consumptionFilter true string
    PathParameter arrayVars arrayVars false objeto
    BodyParameter body body true string
    HeaderParameter usuario Su nombre de usuario para acceder a la API de Yield Analytics true string
    HeaderParameter contraseña Su contraseña para acceder a la API de Yield Analytics true string

  • Respuestas

    Código HTTP Descripción Esquema
    200 Aceptar Matriz InsertionOrderResponse

  • Consume

    application/json

  • Produce

    application/json

  • Tags

    Puntos de conexión del servicio de la orden de inserción

  • Ejemplo de solicitud de cURL

    $ curl 'https://api.appnexus.com/imf/v1/rest/order/inventoryandcontention/apas/2017-03-01/2017-03-31/consumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d 
'{
  "expression" : "ad_server in ('TEST')"
}'

  • Ejemplo de solicitud HTTP

    POST /api/v1/rest/order/inventoryandcontention/apas/2017-03-01/2017-03-31/consumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 44

{
  "expression" : "ad_server in ('TEST')"
}

  • Ejemplo de respuesta HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
     and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and    
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

Definiciones

ExternalOrderIdPool

Nombre Descripción Obligatorio Esquema
externalOrderIdPool false ExternalOrderIdPool
orderIds Colección de identificadores de pedidos true matriz de cadena

InsertionOrderResponse

Un objeto JSON para contener los resultados de la ejecución de la orden de inserción.

Nombre Descripción Obligatorio Esquema
externalId El id. externo de la respuesta de la orden de inserción true string
próximos días Un mapa de la clave para los próximos días true objeto
nextHours Un mapa de la clave para las próximas horas true objeto
Segmentación de destinos Una colección de respuestas de segmentación de órdenes de inserción true Matriz InsertionOrderTargetingResponse

InsertionOrderTargetingResponse

Un objeto JSON para contener los resultados de una segmentación en la respuesta de la orden de inserción.

Nombre Descripción Obligatorio Esquema
dinámica La dinámica de la orden de inserción y la respuesta de segmentación true booleano
end El final de la respuesta de segmentación de la orden de inserción true string
expresión Expresión de la orden de inserción dirigida a la respuesta true string
impressionCap El límite de impresiones de la respuesta de segmentación de la orden de inserción false Entero (int64)
impressionCapPeriod Período del límite de impresiones de la orden de inserción dirigida a la respuesta false Entero (int64)
start El inicio de la respuesta de segmentación de la orden de inserción true string

OrderDeliveryInfo

Un objeto JSON para almacenar la información de entrega del pedido.

Nombre Descripción Obligatorio Esquema
externalOrderId El id. de pedido externo de la información de entrega del pedido true string
Impresiones Las impresiones de la información de entrega del pedido true Entero (int64)
orderLineDeliveryDetail Un mapa de clave para un conjunto de detalles de entrega de línea de pedido false objeto

OrderLineDeliveryDetail

Un objeto JSON para contener la información detallada de la entrega de línea de pedido.

Nombre Descripción Obligatorio Esquema
date La fecha del detalle de entrega de la línea de pedido true string
Impresiones La impresión del detalle de entrega de la línea de pedido true Entero (int64)

Yield Analytics API

  • Last updated on