Method: partners.channels.list

Lista canais para um parceiro ou anunciante.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v1/partners/{partnerId}/channels

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

Parâmetros de caminho

Parâmetros
partnerId

string (int64 format)

O ID do parceiro proprietário dos canais.

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. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.
pageToken

string

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

string

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

  • displayName (padrão)
  • channelId

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, adicione um sufixo " desc" ao nome dele. Exemplo: displayName desc.
filter

string

Permite filtrar por campos do canal.

Sintaxe compatível:

  • As expressões de filtro do canal só podem conter no máximo uma restrição.
  • Uma restrição tem o formato {field} {operator} {value}.
  • Todos os campos precisam usar o operador HAS (:).

Campos compatíveis:

  • displayName

Exemplos:

  • Todos os canais em que o nome de exibição contém "google": displayName : "google".

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

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

string (int64 format)

O ID do anunciante proprietário dos canais.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListChannelsResponse.

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.