Ads: list

Recupera uma lista de anúncios, possivelmente filtrada. Este 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/ads

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long ID do perfil de usuário associado a esta solicitação.
Parâmetros de consulta opcionais
active boolean Selecionar apenas anúncios ativos.
advertiserId long Selecionar apenas anúncios com esse ID de anunciante.
archived boolean Selecionar apenas anúncios arquivados.
audienceSegmentIds long Selecionar apenas anúncios com esses IDs de segmento de público-alvo.
campaignIds long Selecionar apenas anúncios com esses IDs da campanha.
compatibility string Selecione anúncios default com a compatibilidade especificada. Aplicável quando type é AD_SERVING_DEFAULT_AD. DISPLAY e DISPLAY_INTERSTITIAL se referem à renderização em computadores ou dispositivos móveis para anúncios normais ou intersticiais, respectivamente. APP e APP_INTERSTITIAL são usadas para renderização em apps para dispositivos móveis. IN_STREAM_VIDEO refere-se à renderização de anúncios em vídeo in-stream desenvolvidos com o padrão VAST.

Os valores aceitáveis são:
  • "APP"
  • "APP_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
  • "IN_STREAM_AUDIO"
  • "IN_STREAM_VIDEO"
creativeIds long Selecionar apenas anúncios com esses IDs de criativos atribuídos.
creativeOptimizationConfigurationIds long Selecione apenas anúncios com esses IDs de configuração da otimização de criativos.
dynamicClickTracker boolean Selecionar apenas rastreadores de cliques dinâmicos. Aplicável quando type é AD_SERVING_CLICK_TRACKER. Se verdadeiro, selecionar rastreadores de cliques dinâmicos. Se falso, selecionar rastreadores de cliques estáticos. Deixe sem definir para selecionar ambos.
ids long Selecionar apenas anúncios com esses IDs.
landingPageIds long Selecionar apenas anúncios com esses IDs de página de destino.
maxResults integer Número máximo de resultados para retornar. Os valores aceitos vão de 0 a 1000, inclusive. Padrão: 1000
overriddenEventTagId long Selecionar apenas anúncios com esse ID de modificação de tag de evento.
pageToken string Valor de nextPageToken da página de resultados anterior.
placementIds long Selecione apenas anúncios com esses IDs de posição atribuídos.
remarketingListIds long Selecionar somente anúncios com expressão de segmentação de lista que use esses IDs de lista de remarketing.
searchString string Permite a pesquisa de objetos por nome ou ID. Caracteres curinga (*) são permitidos. Por exemplo, "ad*2015" retornará objetos com nomes como "ad June 2015", "ad April 2015" ou simplesmente "ad 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 "ad" corresponderá a objetos com o nome "my ad", "ad 2015" ou simplesmente "ad".
sizeIds long Selecionar apenas anúncios com esses IDs de tamanho.
sortField string Campo que classificará a lista.

Os valores aceitáveis são:
  • "ID" (padrão)
  • "NAME"
sortOrder string Ordem dos resultados classificados.

Os valores aceitáveis são:
  • "ASCENDING" (padrão)
  • "DESCENDING"
sslCompliant boolean Selecionar apenas anúncios compatíveis com SSL.
sslRequired boolean Selecionar somente anúncios que exijam SSL.
type string Selecionar apenas anúncios com esses tipos.

Os valores aceitáveis são:
  • "AD_SERVING_BRAND_SAFE_AD"
  • "AD_SERVING_CLICK_TRACKER"
  • "AD_SERVING_DEFAULT_AD"
  • "AD_SERVING_STANDARD_AD"
  • "AD_SERVING_TRACKING"

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#adsListResponse",
  "nextPageToken": string,
  "ads": [
    ads Resource
  ]
}
Nome da propriedade Valor Descrição Notas
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#adsListResponse".
nextPageToken string O token de paginação a ser usado para a próxima operação da lista.
ads[] list Conjunto de anúncios.

Faça um teste

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