Method: properties.getMetadata

Renvoie les métadonnées des dimensions et des métriques disponibles dans les méthodes de reporting. 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. La réponse des métadonnées inclut les dimensions et métriques personnalisées, ainsi que les métadonnées Universal.

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 des métadonnées 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

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. "Property" est un identifiant numérique de propriété Google Analytics. Pour en savoir plus, consultez Où trouver l'ID de votre 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 reporting.

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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
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)

Descriptions de la comparaison.
conversions[]

object (ConversionMetadata)

Descriptions des conversions.

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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Champs
apiName

string

Nom de cette dimension. Utilisable dans name de Dimension. Par exemple, eventName.
uiName

string

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

string

Description de la façon dont cette dimension est utilisée et calculée.
deprecatedApiNames[]

string

Noms obsolètes, mais toujours utilisables, pour cette dimension. Si elle est renseignée, cette dimension est disponible par apiName ou par l'une des deprecatedApiNames pendant une certaine période. Après la période d'abandon, la dimension ne sera disponible que par apiName.
customDefinition

boolean

"True" si la dimension est personnalisée pour cette propriété. Cela inclut les dimensions personnalisées de portée utilisateur, événement et élément. Pour en savoir plus sur les dimensions personnalisées, consultez https://support.google.com/analytics/answer/14240153. Cela inclut également les groupes de canaux personnalisés. Pour en savoir plus, consultez https://support.google.com/analytics/answer/13051316.
category

string

Nom à afficher de la catégorie à laquelle appartient cette dimension. Les dimensions et les métriques similaires sont regroupées dans des catégories.
sections[]

enum (Section)

Spécifie les sections Google Analytics auxquelles cette dimension s'applique.

MetricMetadata

Explique une métrique.

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

string

Nom de la métrique. Utilisable dans name de Métrique. Par exemple, eventCount.
uiName

string

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

string

Description de la façon dont cette métrique est utilisée et calculée.
deprecatedApiNames[]

string

Noms obsolètes, mais toujours utilisables, pour cette métrique. Si elle est renseignée, cette métrique est disponible par apiName ou par l'une des deprecatedApiNames pendant une période donnée. Après la période d'obsolescence, la métrique ne sera disponible que par apiName.
type

enum (MetricType)

Type de cette métrique.
expression

string

Expression mathématique de 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 celles qui ne le sont pas, ce champ est vide.
customDefinition

boolean

True si la métrique est une métrique personnalisée pour cette propriété.
blockedReasons[]

enum (BlockedReason)

Si des raisons sont spécifiées, votre accès à cette métrique est bloqué pour cette propriété. Les requêtes API que vous envoyez à cette propriété pour cette métrique aboutiront. Toutefois, le rapport ne contiendra que des zéros pour cette métrique. Les requêtes API avec des filtres de métriques sur des métriques bloquées échoueront. Si les raisons sont vides, vous avez accès à cette métrique.

Pour en savoir plus, consultez Gestion des accès et des restrictions de données.
category

string

Nom à afficher de la catégorie à laquelle appartient cette métrique. Les dimensions et les métriques similaires sont regroupées dans des catégories.
sections[]

enum (Section)

Spécifie les sections Google Analytics auxquelles cette métrique s'applique.

BlockedReason

Justifications expliquant pourquoi cette métrique est bloquée.

Enums
BLOCKED_REASON_UNSPECIFIED Ne sera jamais spécifié dans la réponse de l'API.
NO_REVENUE_METRICS Si ce message s'affiche, cela signifie que vous n'avez pas accès aux métriques liées aux revenus pour cette propriété, et que cette métrique est liée aux revenus.
NO_COST_METRICS Si ce message s'affiche, cela signifie que vous n'avez pas accès aux métriques liées aux coûts pour cette propriété. Or, cette métrique est liée aux coûts.

ComparisonMetadata

Métadonnées d'une seule comparaison.

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

string

Nom de ressource de cette comparaison. Utilisable dans le champ comparison de Comparaison. Par exemple, "comparisons/1234".
uiName

string

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

string

Description de cette comparaison.

ConversionMetadata

Métadonnées d'une seule conversion.

Représentation JSON 
{
  "conversionAction": string,
  "displayName": string
}
Champs
conversionAction

string

Identifiant unique de l'action de conversion. Cet ID permet de spécifier les conversions à inclure dans un rapport en remplissant le champ conversionActions dans le ConversionsSpec d'une demande de rapport. Par exemple, "conversionActions/1234".
displayName

string

Nom de cette conversion dans l'interface utilisateur Google Analytics.