Method: inventorySources.list

Lista as origens de inventário que são acessíveis ao usuário atual.

A ordem é definida pelo parâmetro orderBy. Se um filter de entityStatus não for especificado, as origens de inventário com status de entidade ENTITY_STATUS_ARCHIVED não serão incluídas nos resultados.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v2/inventorySources

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O valor 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 para o método inventorySources.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

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

  • displayName (padrão)

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

string

Permite filtrar por campos de origem de inventário.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas por 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 compatíveis:

  • status.entityStatus
  • commitment
  • deliveryMethod
  • rateDetails.rateType
  • exchange

Exemplos:

  • Todas as origens de inventário ativas: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Origens de inventário pertencentes às trocas do Google Ad Manager ou da Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

Consulte nosso guia de solicitações de filtro de 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 só vai retornar entidades de origem de inventário que sejam 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 à origem de inventário.
advertiserId

string (int64 format)

O ID do anunciante que tem acesso à origem de inventário.

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

object (InventorySource)

A lista de origens de inventário.

Esta lista estará ausente se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método inventorySources.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 a Visão geral do OAuth 2.0.