Requer autorização
Lista métricas 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/customMetrics
Parâmetros
Nome do parâmetro | Valor | Descrição |
---|---|---|
Parâmetros de caminho | ||
accountId |
string |
ID da conta das métricas personalizadas a serem recuperadas. |
webPropertyId |
string |
ID da propriedade da Web das métricas personalizadas a serem recuperadas. |
Parâmetros de consulta opcionais | ||
max-results |
integer |
Número máximo de métricas 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#customMetrics", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customMetrics 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". | |
previousLink |
string |
Link para a página anterior desse conjunto de métricas personalizadas. | |
nextLink |
string |
Link para a página seguinte desse conjunto de métricas personalizadas. | |
items[] |
list |
Conjunto de métricas 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 metrics for the authorized user. */ try { CustomMetrics metrics = analytics.management.customMetrics .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 metrics object. * The following code shows how to iterate through them. */ for (CustomMetric metric : metrics.getItems()) { System.out.println("Metric Kind: " + metric.getKind()); System.out.println("Metric Id: " + metric.getId()); System.out.println("Account ID: " + metric.getAccountId()); System.out.println("Property ID: " + metric.getWebPropertyId()); System.out.println("Metric Name: " + metric.getName()); System.out.println("Metric Index: " + metric.getIndex()); System.out.println("Metric Scope: " + metric.getScope()); System.out.println("Metric Active: " + metric.getActive()); System.out.println("Metric Type: " + metric.getType()); System.out.println("Metric Created: " + metric.getCreated()); System.out.println("Metric Updated: " + metric.getUpdated()); }
Python
Usa a biblioteca cliente de Python.
# Note: This code assumes you have an authorized Analytics service object. # This request lists all custom metrics for the authorized user. try: metrics = analytics.management().customMetrics().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 metrics object. # The following code shows how to iterate through them. for metric in metrics.get('items', []): print 'Metric Kind = %s' % metric.get('kind') print 'Metric Id = %s' % metric.get('id') print 'Account ID = %s' % metric.get('accountId') print 'Property ID = %s' % metric.get('webPropertyId') print 'Metric Name = %s' % metric.get('name') print 'Metric Index = %s' % metric.get('index') print 'Metric Scope = %s' % metric.get('scope') print 'Metric Active = %s' % metric.get('active') print 'Metric Type = %s' % metric.get('type') print 'Metric Created = %s' % metric.get('created') print 'Metric Updated = %s' % metric.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.