Method: guaranteedOrders.list

Lista os pedidos garantidos acessíveis ao usuário atual.

A ordem é definida pelo parâmetro orderBy. Se um filter por entityStatus não for especificado, os pedidos garantidos com o status da entidade ENTITY_STATUS_ARCHIVED não serão incluídos nos resultados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. Precisa estar entre 1 e 200. Se não for especificado, o padrão será 100.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da chamada anterior ao método guaranteedOrders.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

Campo que classifica a lista. Os valores aceitáveis são:

  • displayName (padrão)

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, um sufixo "desc" precisa ser adicionado ao nome dele. Por exemplo, displayName desc.
filter

string

Permite filtrar por campos de pedido garantido.

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas pelos operadores lógicos AND ou OR. Uma sequência de restrições usa AND implicitamente.
  • Uma restrição tem o formato {field} {operator} {value}.
  • Todos os campos precisam usar o operador EQUALS (=).

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

Exemplos:

  • Todos os pedidos garantidos ativos: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Pedidos garantidos pertencentes às trocas do Google Ad Manager ou da Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

O comprimento deste campo não pode exceder 500 caracteres.

Consulte nosso guia Filtrar solicitações LIST para mais informações.

Parâmetro de união accessor. Obrigatório.

Identifica em qual entidade do DV360 a solicitação está sendo feita. A solicitação LIST vai retornar apenas entidades de pedido garantido acessíveis à entidade do DV360 identificada no accessor. accessor pode ser apenas de um dos tipos a seguir:
partnerId

string (int64 format)

O ID do parceiro que tem acesso ao pedido garantido.
advertiserId

string (int64 format)

O ID do anunciante que tem acesso ao pedido garantido.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
Campos
guaranteedOrders[]

object (GuaranteedOrder)

A lista de pedidos garantidos.

Essa lista não vai aparecer se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente ao método guaranteedOrders.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.