Method: advertisers.insertionOrders.list

Enumera las órdenes de inserción de un anunciante.

El orden se define con el parámetro orderBy. Si no se especifica un filter por entityStatus, los pedidos de inserción con ENTITY_STATUS_ARCHIVED no se incluirán en los resultados.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante para el que se enumerarán los pedidos de inserción.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 100. Si no se especifica, se establecerá de forma predeterminada como 100. Devuelve el código de error INVALID_ARGUMENT si se especifica un valor no válido.
pageToken

string

Un token que identifica una página de resultados que el servidor debe devolver. Por lo general, este es el valor de nextPageToken que se devolvió de la llamada anterior al método insertionOrders.list. Si no se especifica, se devolverá la primera página de resultados.
orderBy

string

Campo según el cual se ordenará la lista. Los valores aceptables son:

  • "displayName" (predeterminado)
  • "entityStatus"
  • "updateTime"

El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar el sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

Permite filtrar por campos de la orden de inserción.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con los operadores lógicos AND o OR. Una secuencia de restricciones usa AND de forma implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El campo updateTime debe usar los operadores GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • Todos los demás campos deben usar el operador EQUALS (=).

Campos admitidos:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (entrada en formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Ejemplos:

  • Todos los pedidos de inserción de una campaña: campaignId="1234"
  • Todos los pedidos de inserción de ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED de un anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Todos los pedidos de inserción con una fecha y hora de actualización inferior o igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Todos los pedidos de inserción con una fecha y hora de actualización mayor o igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

La longitud de este campo no debe superar los 500 caracteres.

Consulta nuestra guía sobre cómo solicitar el filtro LIST para obtener más información.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Campos
insertionOrders[]

object (InsertionOrder)

Es la lista de pedidos de inserción.

Esta lista no estará presente si está vacía.
nextPageToken

string

Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método insertionOrders.list para recuperar la siguiente página de resultados.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/display-video

Para obtener más información, consulta OAuth 2.0 Overview.