API de Data Analytics: servicio de pedido de inserción

Artículo
05/18/2024

Información general

La API y los servicios de Yield Analytics se exponen a través de una interfaz basada en REST. Está diseñado para que el desarrollo de funcionalidad personalizada sea cómodo para los desarrolladores experimentados con plataformas de desarrollo orientadas a servicios, AJAX, REST y Web 2.0. Los desarrolladores deben estar familiarizados con los paradigmas de aplicación basados en web, como AJAX, XML, JSON y el protocolo HTTP(S) antes de intentar el desarrollo con la API y los servicios de Yield Analytics.

El servicio de pedido de inserción expone actualmente interfaces relacionadas con:

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

Tipos de contenido

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

JSON: mediante Content-type: application/json

Seleccionar el tipo de contenido deseado es una opción que el desarrollador de la API debe tomar caso por caso. La funcionalidad de 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 cliente AJAX o HTTP.

Códigos de estado y comprobación de errores

Los desarrolladores de API deben comprobar los códigos de respuesta HTTP devueltos desde la API REST del servicio para detectar los errores propagados por las llamadas API. Las llamadas correctas al servicio generarán 200 códigos de respuesta de intervalo. Las respuestas HTTP de intervalo 400 y 500 denotan errores. Es probable que los códigos de respuesta y el texto específicos cambien durante el desarrollo beta de la API; sin embargo, los intervalos no.

Seguridad

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

Ejemplo de autenticación cURL

La autenticación se produce pasando credenciales a través de encabezados HTTP en cada solicitud.

- username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"

Autenticación HTTPS de ejemplo

GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

Ejemplo de autenticación POSTMAN

Busque un ejemplo de configuración de encabezado en Postman a continuación:
Nota:
- "Autorización" se establece en "Sin autenticación"; la configuración siguiente se colocará en la pestaña "Encabezados".
- Para obtener un tutorial más detallado sobre el uso de Postman, consulte Uso de Postman con yield analytics API.

Confidencialidad

La confidencialidad se mantiene mediante la comunicación basada en capa de socket seguro para interactuar con yield analytics API. Los desarrolladores de API deben preferir el uso de HTTPS en lugar de una comunicación HTTP insegura siempre que sea posible. Consulte la biblioteca cliente HTTP sobre cómo habilitar HTTP a través de SSL al desarrollar fuera de un contexto de explorador web.

Paths

Obtención de una capacidad garantizada para un solo pedido

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

Descripción

Obtenga una 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	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Solicitud cURL de ejemplo

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

Solicitud HTTP de ejemplo

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

Respuesta HTTP de ejemplo

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

Obtención de una capacidad dinámica de entrega garantizada como CSV para una sola zona horaria

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

Descripción

Obtenga una 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	integer (int32)
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar string
Consume

test/csv
Produce

test/csv
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	string

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para la doble zona horaria

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

Descripción

Obtenga 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar string
Consume

test/csv
Produce

test/csv
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	string

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para una sola zona horaria

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

Descripción

Obtenga 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar string
Consume

application/json
Produce

test/csv
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	string

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para la doble zona horaria

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

Descripción

Obtenga una capacidad dinámica de entrega garantizada como CSV para un grupo de pedidos para la 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar string
Consume

application/json
Produce

test/csv
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	string

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

test/csv
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Solicitud cURL de ejemplo

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

Solicitud HTTP de ejemplo

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

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

Respuesta HTTP de ejemplo

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

Obtención de una capacidad dinámica de entrega garantizada por grupo de identificadores de pedido para la 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 para la 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/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" ]
  }
}'

Solicitud HTTP de ejemplo

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

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

Respuesta HTTP de ejemplo

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

Obtención de una capacidad dinámica de entrega garantizada por grupo de identificadores 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Solicitud cURL de ejemplo

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

Solicitud HTTP de ejemplo

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

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

Respuesta HTTP de ejemplo

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

Obtención de una capacidad dinámica de entrega garantizada para la doble zona horaria

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

Descripción

Obtenga capacidad garantizada para un grupo de pedidos para la 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	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/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}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

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}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

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

Obtención de una 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	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar OrderDeliveryInfo
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	OrderDeliveryInfo

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/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}}' -H 'source: {{source}}'

Solicitud HTTP de ejemplo

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}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Respuesta HTTP de ejemplo

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

Obtención del inventario de pedidos de inserción con JSON

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

Descripción

Obtenga el inventario del pedido 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	matrixVars	matrixVars	false	object
BodyParameter	body	body	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Obtención del inventario y la contención del pedido de inserción con JSON

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

Descripción

Obtenga el inventario y la contención del pedido 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	matrixVars	matrixVars	false	object
BodyParameter	body	body	true	string
HeaderParameter	usuario	Nombre de usuario para acceder a Yield Analytics API	true	string
HeaderParameter	contraseña	La contraseña para acceder a yield analytics API	true	string
HeaderParameter	source	El origen de cliente para acceder a yield analytics API	true	string

Respuestas

Código HTTP Description Esquema

200 Aceptar Matriz InsertionOrderResponse
Consume

application/json
Produce

application/json
Tags

Puntos de conexión del servicio de pedido de inserción

Código HTTP	Description	Esquema
200	Aceptar	Matriz InsertionOrderResponse

Solicitud cURL de ejemplo

$ curl 'https://{{client_url}}/api/v1/rest/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')"
}'

Solicitud HTTP de ejemplo

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://{{client_url}}/api/v1/rest
Content-Length: 44

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

Respuesta HTTP de ejemplo

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 pedido	true	matriz de cadena

InsertionOrderResponse

Objeto JSON que contiene los resultados de la ejecución del orden de inserción.

Nombre	Descripción	Obligatorio	Esquema
externalId	Identificador externo de la respuesta del orden de inserción	true	string
nextDays	Un mapa de clave para los próximos días	true	object
nextHours	Un mapa de clave a las próximas horas	true	object
segmentaciones	Colección de la respuesta de destino del orden de inserción	true	Matriz InsertionOrderTargetingResponse

InsertionOrderTargetingResponse

Objeto JSON que contiene los resultados de una segmentación en la respuesta del orden de inserción.

Nombre	Descripción	Obligatorio	Esquema
Dinámica	Dinámica de la respuesta de destino del orden de inserción	true	booleano
end	El final de la respuesta de destino del orden de inserción	true	string
expresión	Expresión de la respuesta de destino del orden de inserción	true	string
impressionCap	Límite de impresión de la respuesta de destino del orden de inserción	false	integer (int64)
impressionCapPeriod	Período límite de impresión de la respuesta de destino del orden de inserción	false	integer (int64)
start	El inicio de la respuesta de destino del orden de inserción	true	string

OrderDeliveryInfo

Objeto JSON que contiene la información de entrega del pedido.

Nombre	Descripción	Obligatorio	Esquema
externalOrderId	El identificador 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	integer (int64)
orderLineDeliveryDetail	Asignación de clave a un conjunto de detalles de entrega de línea de pedido	false	object

OrderLineDeliveryDetail

Objeto JSON que contiene la información de detalles de entrega de la línea de pedido.

Nombre	Descripción	Obligatorio	Esquema
date	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	integer (int64)

Yield Analytics API

Compartir a través de

API de Data Analytics: servicio de pedido de inserción

Información general

Tipos de contenido

Códigos de estado y comprobación de errores

Seguridad

Confidencialidad

Paths

Obtención de una capacidad garantizada para un solo pedido

Obtención de una capacidad dinámica de entrega garantizada como CSV para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para la doble zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para la doble zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada por grupo de identificadores de pedido para la doble zona horaria

Obtención de una capacidad dinámica de entrega garantizada por grupo de identificadores de pedido para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada para la doble zona horaria

Obtención de una capacidad histórica de entrega garantizada como JSON

Obtención del inventario de pedidos de inserción con JSON

Obtención del inventario y la contención del pedido de inserción con JSON

Definiciones

ExternalOrderIdPool

InsertionOrderResponse

InsertionOrderTargetingResponse

OrderDeliveryInfo

OrderLineDeliveryDetail

Recursos adicionales

Compartir a través de

API de Data Analytics: servicio de pedido de inserción

Información general

Tipos de contenido

Códigos de estado y comprobación de errores

Seguridad

Confidencialidad

Paths

Obtención de una capacidad garantizada para un solo pedido

Obtención de una capacidad dinámica de entrega garantizada como CSV para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para la doble zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para la doble zona horaria

Obtención de una capacidad dinámica de entrega garantizada como CSV por grupo de identificadores de pedido para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada por grupo de identificadores de pedido para la doble zona horaria

Obtención de una capacidad dinámica de entrega garantizada por grupo de identificadores de pedido para una sola zona horaria

Obtención de una capacidad dinámica de entrega garantizada para la doble zona horaria

Obtención de una capacidad histórica de entrega garantizada como JSON

Obtención del inventario de pedidos de inserción con JSON

Obtención del inventario y la contención del pedido de inserción con JSON

Definiciones

ExternalOrderIdPool

InsertionOrderResponse

InsertionOrderTargetingResponse

OrderDeliveryInfo

OrderLineDeliveryDetail

Tema relacionado

Recursos adicionales