Campaigns: list

Recupera uma lista de campanhas, 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/campaigns

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 campanhas de anunciantes que pertençam a estes grupos de anunciantes.
advertiserIds long Seleciona somente campanhas que pertençam a estes anunciantes.
archived boolean Seleciona somente campanhas arquivadas. Para selecionar campanhas tanto arquivadas quanto não arquivadas, não defina este campo.
atLeastOneOptimizationActivity boolean Seleciona somente campanhas que tenham pelo menos uma atividade de otimização.
excludedIds long Exclui campanhas com estes IDs.
ids long Seleciona somente campanhas com estes IDs.
maxResults integer É o número máximo de resultados para retornar. Os valores aceitos vão de 0 a 1000, inclusive. Padrão: 1000
overriddenEventTagId long Seleciona somente campanhas que modificaram este ID de tag de evento.
pageToken string É o valor de nextPageToken da página de resultados anterior.
searchString string Permite a pesquisa de campanhas por nome ou ID. Caracteres curinga (*) são permitidos. Por exemplo, "campaign*2015" retornará campanhas com nomes como "campaign June 2015", "campaign April 2015" ou simplesmente "campaign 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 "campaign" corresponderá a campanhas com o nome "my campaign", "campaign 2015" ou simplesmente "campaign".
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"
subaccountId long Seleciona somente campanhas que pertençam a esta 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#campaignsListResponse",
  "nextPageToken": string,
  "campaigns": [
    campaigns Resource
  ]
}
Nome da propriedade Valor Descrição Observações
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#campaignsListResponse".
campaigns[] list É uma coleção de campanhas.
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.