Method: properties.getMetadata

Affiche les métadonnées des dimensions et des métriques disponibles dans les méthodes de création de rapports. Permet d'explorer les dimensions et les métriques. Dans cette méthode, un identifiant de propriété Google Analytics est spécifié dans la requête, et la réponse des métadonnées inclut des dimensions et métriques personnalisées, ainsi que des métadonnées Universal.

Par exemple, si une métrique personnalisée avec le nom de paramètre levels_unlocked est enregistrée pour une propriété, la réponse des métadonnées contient customEvent:levels_unlocked. Les métadonnées universelles sont des dimensions et des métriques applicables à toutes les propriétés, comme country et totalUsers.

Requête HTTP

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la ressource des métadonnées à récupérer. Ce champ de nom est spécifié dans le chemin d'URL, et non dans les paramètres d'URL. La propriété est un identifiant numérique de propriété Google Analytics. Pour en savoir plus, consultez Où trouver votre ID de propriété.

Exemple: properties/1234/metadata

Définissez l'ID de propriété sur 0 pour les dimensions et les métriques communes à toutes les propriétés. Dans ce mode spécial, cette méthode ne renvoie pas de dimensions ni de métriques personnalisées.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Dimensions, métriques et comparaisons actuellement acceptées dans les méthodes de création de rapports

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
Champs
name

string

Nom de ressource de ces métadonnées.
dimensions[]

object (DimensionMetadata)

Descriptions des dimensions.
metrics[]

object (MetricMetadata)

Descriptions des métriques.
comparisons[]

object (ComparisonMetadata)

Les descriptions de la comparaison.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

ComparisonMetadata

Métadonnées d'une seule comparaison.

Représentation JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Champs
apiName

string

Nom de la ressource de cette comparaison. Utilisable dans le champ comparison de Comparison (Comparaison). Exemple : "comparisons/1234".
uiName

string

Nom de cette comparaison dans l'interface utilisateur de Google Analytics.
description

string

Description de cette comparaison.