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. Avec cette méthode, un identifiant de propriété GA4 Google Analytics est spécifié dans la requête, et la réponse des métadonnées inclut des dimensions et des métriques personnalisées, ainsi que des métadonnées universelles.

Par exemple, si une métrique personnalisée avec le nom de paramètre levels_unlocked est enregistrée dans une propriété, la réponse "Metadata" contient customEvent:levels_unlocked. Les métadonnées universelles sont des dimensions et des métriques applicables à n'importe quelle propriété, comme country et totalUsers.

Requête HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{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 ressource des métadonnées à récupérer. Ce champ de nom est spécifié dans le chemin de l'URL et non dans les paramètres d'URL. La propriété est un identifiant numérique de propriété GA4 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

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

Dimensions et métriques actuellement acceptées dans les méthodes de reporting.

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

string

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

object (DimensionMetadata)

Descriptions des dimensions.
metrics[]

object (MetricMetadata)

Descriptions des métriques.

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

DimensionMetadata

Explique une dimension.

Représentation JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Champs
apiName

string

Nom de cette dimension. Utilisable dans l'élément name de Dimension. Exemple : eventName.
uiName

string

Nom de cette dimension dans l'interface utilisateur Google Analytics. Par exemple, Event name.
description

string

Description de la manière dont cette dimension est utilisée et calculée.
deprecatedApiNames[]

string

Noms encore utilisables, mais obsolètes pour cette dimension. Si elle est renseignée, cette dimension est disponible soit par apiName, soit par deprecatedApiNames pendant un certain temps. Après la période d'abandon, la dimension ne sera disponible que pour apiName.
customDefinition

boolean

"True" si la dimension est une dimension personnalisée pour cette propriété.

MetricMetadata

Explique une métrique.

Représentation JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Champs
apiName

string

Un nom de métrique. Utilisable dans le name de métrique. Exemple : eventCount.
uiName

string

Nom de cette métrique dans l'interface utilisateur Google Analytics. Par exemple, Event count.
description

string

Description de l'utilisation et du calcul de cette métrique.
deprecatedApiNames[]

string

Noms encore utilisables, mais obsolètes pour cette métrique. Si elle est renseignée, cette métrique est disponible soit par apiName, soit par deprecatedApiNames pendant un certain temps. Après la période d'abandon, la métrique ne sera disponible que d'ici le apiName.
type

enum (MetricType)

Type de cette métrique.
expression

string

Expression mathématique pour cette métrique dérivée. Peut être utilisé dans le champ expression de métrique pour les rapports équivalents. La plupart des métriques ne sont pas des expressions. Pour les non-expressions, ce champ est vide.
customDefinition

boolean

"True" si la métrique est une métrique personnalisée pour cette propriété.