- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- DimensionMetadata
- MetricMetadata
- Essayer
Renvoie 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. La réponse de 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 portant le nom de paramètre levels_unlocked
est enregistrée pour une propriété, la réponse "Metadata" contiendra 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 |
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, découvrez où trouver votre ID de propriété. Exemple: propriétés/1234/metadata Définissez l'ID de propriété sur 0 pour les dimensions et 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 création de rapports
Représentation JSON | |
---|---|
{ "name": string, "dimensions": [ { object ( |
Champs | |
---|---|
name |
Nom de ressource de ces métadonnées. |
dimensions[] |
Descriptions des dimensions. |
metrics[] |
Description 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 |
Nom de cette dimension. Utilisable dans le |
uiName |
Nom de cette dimension dans l'interface utilisateur Google Analytics. Par exemple, |
description |
Description de l'utilisation et du calcul de cette dimension. |
deprecatedApiNames[] |
Noms toujours utilisables, mais abandonnés pour cette dimension. Si cette dimension est renseignée, elle est disponible par |
customDefinition |
"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 ( |
Champs | |
---|---|
apiName |
Nom d'une métrique. Utilisable dans le champ |
uiName |
Nom de cette métrique dans l'interface utilisateur Google Analytics. Par exemple, |
description |
Description de l'utilisation et du calcul de cette métrique. |
deprecatedApiNames[] |
Noms toujours utilisables, mais obsolètes pour cette métrique. Si cette métrique est renseignée, elle est disponible par |
type |
Type de cette métrique. |
expression |
Expression mathématique pour cette métrique dérivée. Peut être utilisé dans le champ |
customDefinition |
"True" si la métrique est une métrique personnalisée pour cette propriété. |