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 ressource pour cette métrique CalculatedMetric. Format : "properties/{property_id}/ComputeMetrics/{calculMetricId}"
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, comme indiqué 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'interface utilisateur, il s'agit du "nom de l'API".

Le paramètre "computeMetricId" est utilisé pour faire référence à cette métrique calculée à partir d'API externes. Par exemple, "calcMetric:{CalculMetricId}".
metricUnit

enum (MetricUnit)

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

enum (RestrictedMetricType)

Uniquement en sortie. Types de données restreintes contenues dans 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 prennent en charge les opérations suivantes: + (addition), - (soustraction), - (négatif), * (multiplication), / (division), () (parenthèse). Tous les nombres réels valides sont acceptés dans un format long (entier 64 bits) ou double (nombre à virgule flottante de 64 bits). Exemple de formule : "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

Uniquement en sortie. Si la valeur est "true", la référence à la métrique calculée n'est pas valide. Toute opération 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é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 est exprimée en pieds.
MILES Cette métrique mesure les miles.
METERS Cette métrique mesure des mètres.
KILOMETERS Cette métrique mesure les kilomètres.
MILLISECONDS Cette métrique mesure la milliseconde.
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 de la métrique calculée en association 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 enregistrent les données de coût.
REVENUE_DATA La métrique fournit des données sur les revenus.

Méthodes

create

 Crée une métrique CalculatedMetric.

delete

 Supprime une métrique CalculatedMetric d'une propriété.

get

 Recherche d'une seule métrique CalculatedMetric.

list

 Répertorie les CalculatedMetrics sur une propriété.

patch

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