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

Uniquement en sortie. Nom de ressource de cette ressource de métrique personnalisée. Format: Properties/{property}/customMetrics/{customMetric}

parameterName

string

Obligatoire. Immuable. Nom du taggage 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 doit contenir que des caractères alphanumériques et des traits de soulignement, et commencer par une lettre. Longueur maximale de 40 caractères pour les métriques de portée événement.

displayName

string

Obligatoire. Nom à afficher pour cette métrique personnalisée, comme indiqué dans l'interface utilisateur d'Analytics. Longueur maximale de 82 caractères, caractères alphanumériques, espaces et traits de soulignement commençant par une lettre. Les anciens noms à afficher générés par le système peuvent contenir des crochets, mais les modifications apportées à ce champ ne les autoriseront jamais.

description

string

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

measurementUnit

enum (MeasurementUnit)

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

scope

enum (MetricScope)

Obligatoire. Immuable. Champ d'application 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 avec l'unité de mesure CURRENCY. Doit être vide pour les métriques utilisant une unité de mesure autre que CURRENCY.

MeasurementUnit

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

La représentation des devises est susceptible de changer à l'avenir, ce qui nécessitera une modification destructive de l'API.

Enums
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit 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 est exprimée en pieds.
METERS Cette métrique mesure des mètres.
KILOMETERS Cette métrique mesure les kilomètres.
MILES Cette métrique mesure les miles.
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.

MetricScope

Champ d'application de cette métrique.

Enums
METRIC_SCOPE_UNSPECIFIED Champ d'application inconnu ou non spécifié.
EVENT Métrique limitée à un événement.

RestrictedMetricType

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

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

archive

Archive une métrique personnalisée sur une propriété.

create

Crée une métrique personnalisée.

get

Recherche d'une seule métrique personnalisée.

list

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

patch

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