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 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 à portée d'é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 axées sur les événements.

displayName

string

Obligatoire. Nom à afficher pour cette métrique personnalisée, tel qu'il apparaît dans l'interface utilisateur Analytics. Il ne doit pas dépasser 82 caractères. Il doit comporter des caractères alphanumériques, un espace et un trait de soulignement, et doit commencer 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. Ne doit pas dépasser 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 avec une unité de mesure en CURRENCY. Ce champ doit être vide pour les métriques associées à une unité de mesure autre que la devise.

Unité de mesure

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écessite un changement majeur 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 est mesurée en mètres.
KILOMETERS Cette métrique mesure les kilomètres.
MILES Cette métrique mesure des miles.
MILLISECONDS Cette métrique mesure quelques millisecondes.
SECONDS Cette métrique mesure les secondes.
MINUTES Cette métrique mesure les minutes.
HOURS Cette métrique mesure les heures.

Champ d'application de la métrique

Champ d'application de cette métrique.

Enums
METRIC_SCOPE_UNSPECIFIED Portée inconnue ou non spécifiée.
EVENT Métrique appliquée à un événement.

RestrictedMetricType

Libellés qui marquent les données de cette métrique personnalisée comme des données devant ê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 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

Recherchez une seule métrique personnalisée.

list

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

patch

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