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 pour cette ressource CustomMetric. 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 peut contenir que des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre. La longueur maximale des métriques de portée événement est de 40 caractères.

displayName

string

Obligatoire. Nom à afficher de cette métrique personnalisée, tel qu'il apparaît dans l'interface utilisateur d'Analytics. 82 caractères maximum, 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 mises à jour de ce champ n'en autoriseront jamais.

description

string

Facultatif. Description de cette dimension personnalisée. 150 caractères maximum.

measurementUnit

enum (MeasurementUnit)

Obligatoire. Type de la 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 soumises à des restrictions que cette métrique peut contenir. Obligatoire pour les métriques avec l'unité de mesure "MONNAIE". Doit être vide pour les métriques dont l'unité de mesure n'est pas CURRENCY.

MeasurementUnit

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

La représentation des devises pourra 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 des unités par défaut.
CURRENCY Cette métrique mesure une devise.
FEET Cette métrique mesure les pieds.
METERS Cette métrique mesure les mètres.
KILOMETERS Cette métrique mesure les kilomètres.
MILES Cette métrique mesure les kilomètres.
MILLISECONDS Cette métrique mesure les millisecondes.
SECONDS Cette métrique mesure les secondes.
MINUTES Cette métrique est mesurée en 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 de portée événement.

RestrictedMetricType

Libellés qui indiquent 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 fournissent des données sur les coûts.
REVENUE_DATA La métrique affiche les 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

Recherchez une seule métrique personnalisée.

list

Répertorie les métriques personnalisées d'une propriété.

patch

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