Method: partners.list

Lista os parceiros que estão acessíveis ao usuário atual.

A ordem é definida pelo parâmetro orderBy.

Solicitação HTTP

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

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 partners.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

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 parceiro.

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:

  • entityStatus

Exemplos:

  • Todos os parceiros ativos: entityStatus="ENTITY_STATUS_ACTIVE"

Esse campo não pode ter mais de 500 caracteres.

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

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

object (Partner)

A lista de parceiros.

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 partners.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.