A API Campaign Manager 360 v3.4 foi descontinuada e será desativada em 10 de janeiro de 2022. Até essa data, todos os usuários precisam migrar para uma versão mais recente da API.

DimensionValues: query

Recupera uma lista de valores das dimensões de relatório para uma lista de filtros. Faça um teste.

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/dimensionvalues/query

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long É o ID do perfil do usuário do Campaign Manager 360.
Parâmetros de consulta opcionais
maxResults integer É o número máximo de resultados para retornar. Os valores aceitos vão de 0 a 100. Padrão: 100
pageToken string É o valor de nextToken da página de resultados anterior.

Autorização

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

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

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

Corpo da solicitação

No corpo da solicitação, forneça os dados com a seguinte estrutura:

{
  "kind": "dfareporting#dimensionValueRequest",
  "dimensionName": string,
  "startDate": date,
  "endDate": date,
  "filters": [
    {
      "kind": "dfareporting#dimensionFilter",
      "dimensionName": string,
      "value": string
    }
  ]
}
Nome da propriedade Valor Descrição Observações
kind string É o tipo da solicitação. Neste caso, dfareporting#dimensionValueRequest.
dimensionName string É o nome da dimensão a que os valores devem ser solicitados. gravável
startDate date É a data de início do período em que os valores de dimensão serão recuperados. É uma string no formato "yyyy-MM-dd". gravável
endDate date É a data de término do período em que os valores de dimensão serão recuperados. É uma string no formato "yyyy-MM-dd". gravável
filters[] list É a lista dos filtros que serão usados nos valores. Os filtros devem ser do tipo AND. gravável
filters[].kind string É o tipo de recurso. Neste caso, dfareporting#dimensionFilter.
filters[].dimensionName string É o nome da dimensão que será filtrada.
filters[].value string O valor da dimensão que será filtrada.

Resposta

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

{
  "kind": "dfareporting#dimensionValueList",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    dimensionValues Resource
  ]
}
Nome da propriedade Valor Descrição Observações
kind string É o tipo da lista. Neste caso, dfareporting#dimensionValueList.
etag etag É a ETag desta resposta para fins de armazenamento em cache.
nextPageToken string Token de continuação usado para paginar por meio dos valores de dimensão. Para recuperar a próxima página de resultados, defina o "pageToken" da próxima solicitação para o valor desse campo. O token de página só é válido para um período limitado de tempo e não deve ser mantido.
items[] list São os valores de dimensão retornados nessa resposta.

Faça um teste

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