Autorisation requise
Répertorie les métriques personnalisées auxquelles l'utilisateur a accès. Essayez maintenant ou consultez un exemple.
Requête
Requête HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customMetrics
Paramètres
Nom du paramètre | Valeur | Description |
---|---|---|
Paramètres de chemin d'accès | ||
accountId |
string |
ID de compte des métriques personnalisées à récupérer. |
webPropertyId |
string |
ID de propriété Web des métriques personnalisées à récupérer. |
Paramètres de requête facultatifs | ||
max-results |
integer |
Nombre maximal de métriques personnalisées à inclure dans cette réponse. |
start-index |
integer |
Index de la première entité à récupérer. Utilisez ce paramètre comme mécanisme de pagination avec le paramètre max-results. |
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
Définition du champ d'application |
---|
https://www.googleapis.com/auth/analytics.readonly |
https://www.googleapis.com/auth/analytics |
Corps de la requête
Ne spécifiez pas de corps de requête pour cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{ "kind": "analytics#customMetrics", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customMetrics Resource ] }
Nom de propriété | Valeur | Description | Remarques |
---|---|---|---|
kind |
string |
Type de collection. | |
username |
string |
ID d'adresse e-mail de l'utilisateur authentifié. | |
totalResults |
integer |
Nombre total de résultats de la requête, quel que soit le nombre de résultats dans la réponse. | |
startIndex |
integer |
Index de départ des ressources, défini sur 1 par défaut ou spécifié par le paramètre de requête "start-index". | |
itemsPerPage |
integer |
Nombre maximal de ressources que la réponse peut contenir, quel que soit le nombre réel de ressources renvoyées. Sa valeur est comprise entre 1 et 1 000, avec une valeur de 1 000 par défaut. Elle est également spécifiée par le paramètre de requête "max-results". | |
previousLink |
string |
Lien vers la page précédente sur cette collection de métriques personnalisées. | |
nextLink |
string |
Lien vers la page suivante pour cette collection de métriques personnalisées. | |
items[] |
list |
Ensemble de métriques personnalisées. |
Exemples
Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).
Java
Utilise la bibliothèque cliente 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
Utilise la bibliothèque cliente 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')
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse. Vous pouvez également utiliser l'explorateur autonome.