Cette page a été traduite par l'API Cloud Translation.

Custom Dimensions: list

Répertorie les dimensions personnalisées auxquelles l'utilisateur a accès. Essayer maintenant ou voir un exemple

Demande

Requête HTTP

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

Paramètres

Nom du paramètre	Value	Description
Paramètres de chemin d'accès
`accountId`	`string`	Identifiant du compte pour les dimensions personnalisées à récupérer.
`webPropertyId`	`string`	ID de la propriété Web pour les dimensions personnalisées à récupérer.
Paramètres de requête facultatifs
`max-results`	`integer`	Nombre maximal de dimensions 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

Portée
`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#customDimensions",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customDimensions Resource
  ]
}

Nom de propriété	Value	Description
`kind`	`string`	Type de collection.
`username`	`string`	Adresse e-mail de l'utilisateur authentifié
`totalResults`	`integer`	Nombre total de résultats pour la requête, quel que soit le nombre de résultats dans la réponse.
`startIndex`	`integer`	L'index de départ des ressources, qui est égal à 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 par défaut de 1 000, ou spécifiée par le paramètre "max-results query".
`previousLink`	`string`	Lien vers la page précédente de cette collection de dimensions personnalisées.
`nextLink`	`string`	Lien vers la page suivante de cette collection de dimensions personnalisées.
`items[]`	`list`	Collection de dimensions 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 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

Utilise la bibliothèque cliente 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')

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 essayer l'explorateur autonome.