REST Resource: properties.customMetrics

Ressource : CustomMetric

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

Représentation JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Champs
name

string

Identifiant. Nom de ressource de cette ressource CustomMetric. Format: properties/{property}/customMetrics/{customMetric}
parameterName

string

Obligatoire. Immuable. Nom de tag pour cette métrique personnalisée.

S'il s'agit d'une métrique de portée événement, il s'agit du nom du paramètre d'événement.

Ne peut contenir que des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre. Longueur maximale de 40 caractères pour les métriques de portée événement.
displayName

string

Obligatoire. Nom à afficher de cette métrique personnalisée dans l'interface utilisateur Analytics. Longueur maximale de 82 caractères, alphanumériques plus espace et trait de soulignement commençant par une lettre. Les noms à afficher générés par l'ancien système peuvent contenir des crochets, mais les mises à jour de ce champ ne les autoriseront jamais.
description

string

Facultatif. Description de cette dimension personnalisée. Longueur maximale de 150 caractères.
measurementUnit

enum (MeasurementUnit)

Obligatoire. Type de valeur de la métrique personnalisée.
scope

enum (MetricScope)

Obligatoire. Immuable. Portée de cette métrique personnalisée.
restrictedMetricType[]

enum (RestrictedMetricType)

Facultatif. Types de données restreintes que cette métrique peut contenir. Obligatoire pour les métriques dont l'unité de mesure est CURRENCY. Doit être vide pour les métriques dont l'unité de mesure n'est pas CURRENCY.

MeasurementUnit

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

La représentation de la devise peut changer à l'avenir, ce qui nécessitera une modification de l'API.

Enums
MEASUREMENT_UNIT_UNSPECIFIED Unité de mesure non spécifiée ou manquante.
STANDARD Cette métrique utilise des unités par défaut.
CURRENCY Cette métrique mesure une devise.
FEET Cette métrique mesure des pieds.
METERS Cette métrique mesure des mètres.
KILOMETERS Cette métrique mesure des kilomètres.
MILES Cette métrique mesure des miles.
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.

MetricScope

Portée de cette métrique.

Enums
METRIC_SCOPE_UNSPECIFIED Portée inconnue ou non spécifiée.
EVENT Métrique de portée événement.

RestrictedMetricType

Libellés qui marquent les données de cette métrique personnalisée comme des données qui doivent être limitées à des utilisateurs spécifiques.

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 revenus.

Méthodes

archive

 Archive une CustomMetric sur une propriété.

create

 Crée une CustomMetric.

get

 Recherche une seule CustomMetric.

list

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

patch

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