Ressource: CalculatedMetric
Définition d'une métrique calculée.
Représentation JSON |
---|
{ "name": string, "description": string, "displayName": string, "calculatedMetricId": string, "metricUnit": enum ( |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de la ressource pour CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId} |
description |
Facultatif. Description de cette métrique calculée. Longueur maximale de 4 096 caractères. |
displayName |
Obligatoire. Nom à afficher pour cette métrique calculée, tel qu'il apparaît dans l'interface utilisateur de Google Analytics. Longueur maximale : 82 caractères. |
calculatedMetricId |
Uniquement en sortie. ID à utiliser pour la métrique calculée. Dans l'interface utilisateur, il s'agit du "nom de l'API". La valeur "computeMetricId" est utilisée pour référencer cette métrique calculée à partir d'API externes. Par exemple, "calcMetric:{calculatedMetricId}". |
metricUnit |
Obligatoire. Type de valeur de la métrique calculée. |
restrictedMetricType[] |
Uniquement en sortie. Types de données restreintes que contient cette métrique. |
formula |
Obligatoire. Définition de la métrique calculée. Le nombre maximal de métriques personnalisées référencées uniques est de 5. Les formules prennent en charge les opérations suivantes: + (addition), - (soustraction), - (négatif), * (multiplication), / (division), () (parenthèses). Tout nombre réel valide s'adapte à un nombre long (entier 64 bits) ou double (nombre à virgule flottante de 64 bits). Exemple de formule: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0" |
invalidMetricReference |
Uniquement en sortie. Si la valeur est "true", cette métrique calculée contient une référence non valide. Toute action utilisant une métrique calculée avec invalidMetricReference définie sur "true" peut échouer, générer des avertissements ou produire des résultats inattendus. |
MetricUnit
Types possibles de représentation de la valeur de la métrique calculée.
Enums | |
---|---|
METRIC_UNIT_UNSPECIFIED |
MetricUnit non spécifiée ou manquante. |
STANDARD |
Cette métrique utilise les unités par défaut. |
CURRENCY |
Cette métrique mesure une devise. |
FEET |
Cette métrique mesure pieds. |
MILES |
Cette métrique mesure les miles. |
METERS |
Cette métrique mesure les mètres. |
KILOMETERS |
Cette métrique mesure les kilomètres. |
MILLISECONDS |
Cette métrique mesure les millisecondes. |
SECONDS |
Cette métrique mesure les secondes. |
MINUTES |
Cette métrique mesure les minutes. |
HOURS |
Cette métrique mesure les heures. |
RestrictedMetricType
Libellés qui marquent les données dans une métrique calculée, utilisée avec des rôles utilisateur limitant l'accès aux métriques sur les coûts et/ou les revenus.
Enums | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
Type inconnu ou non spécifié. |
COST_DATA |
Les métriques présentent les données de coût. |
REVENUE_DATA |
Les métriques présentent des données sur les revenus. |
Méthodes |
|
---|---|
|
Crée une valeur CalculatedMetric. |
|
Supprime une métrique CalculatedMetric sur une propriété. |
|
Recherche pour une seule CalculatedMetric. |
|
Répertorie les CalculatedMetrics pour une propriété. |
|
Met à jour une CalculatedMetric sur une propriété. |