Method: guaranteedOrders.list

Enumera los pedidos garantizados a los que puede acceder el usuario actual.

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

Solicitud HTTP

GET https://displayvideo.googleapis.com/v4/guaranteedOrders

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

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 200. Si no se especifica, se establecerá el valor predeterminado 100.
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 guaranteedOrders.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 (predeterminada)

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. Por ejemplo, displayName desc.
filter

string

Permite filtrar por campos de pedidos garantizados.

  • 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}.
  • Todos los campos deben usar el operador EQUALS (=).

Campos admitidos: * guaranteedOrderId * exchange * displayName * status.entityStatus

Ejemplos:

  • Todos los pedidos garantizados activos: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Pedidos garantizados que pertenecen a los intercambios de Google Ad Manager o Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

Para obtener más información, consulta nuestra guía sobre solicitudes de filtros LIST.

Obligatorio.

Identifica dentro de qué entidad de DV360 se realiza la solicitud. La solicitud LIST solo devolverá entidades de pedidos garantizados a las que se pueda acceder desde la entidad de DV360 identificada en accessor. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
partnerId

string (int64 format)

Es el ID del socio que tiene acceso al pedido garantizado.
advertiserId

string (int64 format)

Es el ID del anunciante que tiene acceso al pedido garantizado.
Fin de los campos mutuamente excluyentes.

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 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
Campos
guaranteedOrders[]

object (GuaranteedOrder)

Es la lista de pedidos garantizados.

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 de la llamada posterior al método guaranteedOrders.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.