REST Resource: properties.calculatedMetrics

Ressource: CalculatedMetric

Définition d'une métrique calculée.

Représentation JSON 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Champs
name

string

Uniquement en sortie. Nom de la ressource pour cette métrique calculée. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

Facultatif. Description de cette métrique calculée. Longueur maximale de 4 096 caractères.
displayName

string

Obligatoire. Nom à afficher de cette métrique calculée dans l'interface utilisateur de Google Analytics. Longueur maximale : 82 caractères.
calculatedMetricId

string

Uniquement en sortie. ID à utiliser pour la métrique calculée. Dans l'UI, il est appelé "nom de l'API".

Le calculatedMetricId est utilisé lorsque vous faites référence à cette métrique calculée à partir d'API externes. Par exemple, "calcMetric:{calculatedMetricId}".
metricUnit

enum (MetricUnit)

Obligatoire. Type de la valeur de la métrique calculée.
restrictedMetricType[]

enum (RestrictedMetricType)

Uniquement en sortie. Types de données limitées que contient cette métrique.
formula

string

Obligatoire. Définition de la métrique calculée. Le nombre maximal de métriques personnalisées uniques référencées est de cinq. Les formules acceptent les opérations suivantes: + (addition), - (soustraction), - (négatif), * (multiplication), / (division), () (parenthèses). Tous les nombres réels valides qui tiennent dans un Long (entier 64 bits) ou un Double (nombre à virgule flottante 64 bits) sont acceptés. Exemple de formule: "( customEvent:nomParamètre + cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

Uniquement en sortie. Si la valeur est "true", cette métrique calculée comporte une référence de métrique non valide. Tout élément utilisant une métrique calculée avec invalidMetricReference défini sur "true" peut échouer, générer des avertissements ou des résultats inattendus.

MetricUnit

Types de représentation possibles de la valeur de la métrique calculée.

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit non spécifié ou manquant.
STANDARD Cette métrique utilise les unités par défaut.
CURRENCY Cette métrique mesure une devise.
FEET Cette métrique mesure les pieds.
MILES Cette métrique mesure les kilomètres.
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 la métrique calculée utilisée avec des rôles utilisateur qui limitent l'accès aux métriques de coût et/ou de revenu.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Type inconnu ou non spécifié.
COST_DATA Les métriques fournissent des données sur les coûts.
REVENUE_DATA La métrique enregistre les données sur les revenus.

Méthodes

create

 Crée une métrique calculée.

delete

 Supprime une métrique calculée d'une propriété.

get

 Recherchez une seule métrique calculée.

list

 Répertorie les métriques calculées d'une propriété.

patch

 Met à jour une métrique calculée sur une propriété.