Dimensões personalizadas: list

Requer autorização

Lista dimensões personalizadas às quais o usuário tem acesso. Faça um teste agora ou veja um exemplo.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
accountId string ID da conta para as dimensões personalizadas a serem recuperadas.
webPropertyId string ID da propriedade da Web para as dimensões personalizadas a serem recuperadas.
Parâmetros de consulta opcionais
max-results integer Número máximo de dimensões personalizadas a serem incluídas nessa resposta.
start-index integer Um índice da primeira entidade a ser recuperada. Use esse parâmetro como um mecanismo de paginação juntamente com o parâmetro "max-results".

Autorização

Essa solicitação requer autorização com pelo menos um dos escopos a seguir (mais informações sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics

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": "analytics#customDimensions",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customDimensions Resource
  ]
}
Nome da propriedade Valor Descrição Observações
kind string Tipo de conjunto.
username string ID do e-mail do usuário autenticado
totalResults integer Número total de resultados da consulta, independentemente do número de resultados na resposta.
startIndex integer Índice inicial dos recursos, que é 1 por padrão ou outro especificado pelo parâmetro de consulta "start-index".
itemsPerPage integer Número máximo de recursos que a resposta pode conter, independentemente do número real de recursos retornados. O valor varia de 1 a 1.000, sendo que o valor padrão é 1.000 ou outro valor especificado pelo parâmetro de consulta "max-results".
items[] list Conjunto de dimensões personalizadas.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de Java.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 */

/**
 * This request lists all custom dimensions for the authorized user.
 */
try {
  CustomDimensions dimensions = analytics.management.customDimensions
      .list("12345", "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * The results of the list method are stored in the dimensions object.
 * The following code shows how to iterate through them.
 */
for (CustomDimension dimension : dimensions.getItems()) {
  System.out.println("Dimension Kind: " + dimension.getKind());
  System.out.println("Dimension Id: " + dimension.getId());
  System.out.println("Account ID: " + dimension.getAccountId());
  System.out.println("Property ID: " + dimension.getWebPropertyId());
  System.out.println("Dimension Name: " + dimension.getName());
  System.out.println("Dimension Index: " + dimension.getIndex());
  System.out.println("Dimension Scope: " + dimension.getScope());
  System.out.println("Dimension Active: " + dimension.getActive());
  System.out.println("Dimension Created: " + dimension.getCreated());
  System.out.println("Dimension Updated: " + dimension.getUpdated());
}

Python

Usa a biblioteca cliente de Python.

# Note: This code assumes you have an authorized Analytics service object.

# This request lists all custom dimensions for the authorized user.
try:
  dimensions = analytics.management().customDimensions().list(
      accountId='123456',
      webPropertyId='UA-123456-1',
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))


# The results of the list method are stored in the dimensions object.
# The following code shows how to iterate through them.
for dimension in dimensions.get('items', []):
  print 'Dimension Kind = %s' % dimension.get('kind')
  print 'Dimension Id = %s' % dimension.get('id')
  print 'Account ID = %s' % dimension.get('accountId')
  print 'Property ID = %s' % dimension.get('webPropertyId')
  print 'Dimension Name = %s' % dimension.get('name')
  print 'Dimension Index = %s' % dimension.get('index')
  print 'Dimension Scope = %s' % dimension.get('scope')
  print 'Dimension Active = %s' % dimension.get('active')
  print 'Dimension Created = %s' % dimension.get('created')
  print 'Dimension Updated = %s' % dimension.get('updated')

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta. Como alternativa, teste o Explorador independente.