Advertisers: list

Recupera uma lista de anunciantes, possivelmente filtrada. Esse método é compatível com paginação. Faça um teste agora.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/advertisers

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long É o ID do perfil de usuário associado a esta solicitação.
Parâmetros de consulta opcionais
advertiserGroupIds long Seleciona somente anunciantes com estes IDs de grupo de anunciantes.
floodlightConfigurationIds long Seleciona somente anunciantes com estes IDs de configuração do Floodlight.
ids long Seleciona somente anunciantes com estes IDs.
includeAdvertisersWithoutGroupsOnly boolean Seleciona somente anunciantes que não pertençam a um grupo de anunciantes.
maxResults integer É o número máximo de resultados para retornar. Os valores aceitos vão de 0 a 1000, inclusive. Padrão: 1000
onlyParent boolean Seleciona somente anunciantes que usem a configuração do Floodlight de outro anunciante.
pageToken string É o valor de nextPageToken da página de resultados anterior.
searchString string Permite a pesquisa de objetos por nome ou ID. Caracteres curinga (*) são permitidos. Por exemplo, "advertiser*2015" retornará objetos com nomes como "advertiser June 2015", "advertiser April 2015" ou simplesmente "advertiser 2015". A maioria das pesquisas também adiciona curingas implicitamente no começo e no fim da sequência de caracteres de pesquisa. Por exemplo, uma string de pesquisa de "advertiser" corresponderá a objetos com o nome "my advertiser", "advertiser 2015" ou simplesmente "advertiser".
sortField string É o campo que classificará a lista.

Os valores aceitáveis são os seguintes:
  • "ID" (padrão)
  • "NAME"
sortOrder string É a ordem dos resultados classificados.

Os valores aceitáveis são os seguintes:
  • "ASCENDING" (padrão)
  • "DESCENDING"
status string Seleciona somente anunciantes com o status especificado.

Os valores aceitáveis são os seguintes:
  • "APPROVED"
  • "ON_HOLD"
subaccountId long Seleciona somente anunciantes com estes IDs de subconta.

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/dfatrafficking

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "dfareporting#advertisersListResponse",
  "nextPageToken": string,
  "advertisers": [
    advertisers Resource
  ]
}
Nome da propriedade Valor Descrição Observações
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#advertisersListResponse".
advertisers[] list É uma coleção de anunciantes.
nextPageToken string É o token de paginação a ser usado para a próxima operação da lista.

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.