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 la ressource CustomMetric. Format: Properties/{property}/customMetrics/{customMetric}

parameterName

string

Obligatoire. Immuable. Nom de l'ajout de tags 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, commençant 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, tel qu'il apparaît dans l'interface utilisateur d'Analytics. Longueur maximale de 82 caractères, caractères alphanumériques, espace et trait 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 mises à jour de ce champ n'autoriseront jamais les crochets.

description

string

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

measurementUnit

enum (MeasurementUnit)

Obligatoire. Type de 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 utilisant l'unité de mesure CURRENCY. Ce champ doit être vide pour les métriques n'utilisant pas la devise CURRENCY.

MeasurementUnit

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

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

Enums
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit 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 mesure l'unité (pieds).
METERS Cette métrique mesure le mètre.
KILOMETERS Cette métrique mesure les kilomètres.
MILES Cette métrique mesure les miles.
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.

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 qui marquent les données de cette métrique personnalisée comme celles devant être limitées à des utilisateurs spécifiques.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Type inconnu ou non spécifié.
COST_DATA Les métriques génèrent des rapports sur les données de coût.
REVENUE_DATA Les métriques présentent des données sur les revenus.

Méthodes

archive

Archive une CustomMetric sur une propriété.

create

Crée une métrique personnalisée.

get

Recherche pour une seule métrique personnalisée.

list

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

patch

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