- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Lista as campanhas de um anunciante.
A ordem é definida pelo parâmetro orderBy
. Se um filter
de entityStatus
não for especificado, as campanhas com ENTITY_STATUS_ARCHIVED
não serão incluídas nos resultados.
Solicitação HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
advertiserId |
O ID do anunciante para o qual listar campanhas. |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Tamanho da página solicitada. O valor precisa estar entre |
pageToken |
Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de |
orderBy |
Campo que classificará a lista. Os valores aceitáveis sã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. Exemplo: |
filter |
Permite filtrar por campos de campanha. Sintaxe compatível:
Campos compatíveis:
Exemplos:
Esse campo não pode ter mais de 500 caracteres. Consulte nosso guia de solicitações de filtro de |
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 |
---|
{
"campaigns": [
{
object ( |
Campos | |
---|---|
campaigns[] |
A lista de campanhas. Esta lista estará ausente se estiver vazia. |
nextPageToken |
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo |
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
Para mais informações, consulte a Visão geral do OAuth 2.0.