Method: advertisers.adGroups.list

Lista os grupos de anúncios.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups

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

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

Obrigatório. O ID do anunciante ao qual os grupos de anúncios pertencem.

Parâmetros de consulta

Parâmetros
pageSize

integer

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

Opcional. 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 adGroups.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

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

  • displayName (padrão)
  • entityStatus

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

Opcional. Permite filtrar por campos personalizados de grupos de anúncios.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas por AND e 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 (=).

Propriedades compatíveis:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Exemplos:

  • Todos os grupos de anúncios em um item de linha: lineItemId="1234"
  • Todos os grupos de anúncios ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM de um anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

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

Consulte nosso guia de filtragem de solicitações 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 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
Campos
adGroups[]

object (AdGroup)

Lista de grupos de anúncios.

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