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

Identifiant. Nom de ressource pour cette CalculatedMetric. 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 pour cette métrique calculée dans l'interface utilisateur de Google Analytics. Longueur maximale de 82 caractères.
calculatedMetricId

string

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

L'élément 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 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 référencées uniques est de 5. Les formules sont compatibles avec les opérations suivantes : + (addition), - (soustraction), - (négatif), * (multiplication), / (division), () (parenthèses). Tous les nombres réels valides qui tiennent dans un entier long (entier de 64 bits) ou un double (nombre à virgule flottante de 64 bits) sont acceptables. Exemple de formule : "( customEvent:parameterName + 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 ce qui utilise une métrique calculée dont la valeur invalidMetricReference est 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é 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 des pieds.
MILES Cette métrique mesure des miles.
METERS Cette métrique mesure des mètres.
KILOMETERS Cette métrique mesure des kilomètres.
MILLISECONDS Cette métrique mesure des millisecondes.
SECONDS Cette métrique mesure des secondes.
MINUTES Cette métrique mesure des minutes.
HOURS Cette métrique mesure des heures.

RestrictedMetricType

Libellés qui marquent les données de la métrique calculée utilisée conjointement 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 La métrique indique les données de coût.
REVENUE_DATA La métrique indique les données de revenu.

Méthodes

create

 Crée une CalculatedMetric.

delete

 Supprime une CalculatedMetric sur une propriété.

get

 Recherche une CalculatedMetric unique.

list

 Liste les CalculatedMetrics sur une propriété.

patch

 Met à jour une CalculatedMetric sur une propriété.