REST Resource: properties.customMetrics

Recurso: CustomMetric

Es una definición para una métrica personalizada.

Representación JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Campos
name

string

Solo salida. Es el nombre del recurso CustomMetric. Formato: properties/{property}/customMetrics/{customMetric}

parameterName

string

Obligatorio. Inmutable. Es el nombre de etiquetado para esta métrica personalizada.

Si se trata de una métrica centrada en el evento, este es el nombre del parámetro del evento.

Solo puede contener caracteres alfanuméricos y guiones bajos, y debe comenzar con una letra. La longitud máxima es de 40 caracteres para las métricas centradas en el evento.

displayName

string

Obligatorio. Es el nombre visible de esta métrica personalizada, tal como se muestra en la IU de Analytics. Tiene una longitud máxima de 82 caracteres, alfanuméricos más espacio y guion bajo que comienzan con una letra. Los nombres visibles generados por el sistema heredado pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán corchetes.

description

string

Opcional. Es la descripción de esta dimensión personalizada. Tiene una longitud máxima de 150 caracteres.

measurementUnit

enum (MeasurementUnit)

Obligatorio. Es el tipo del valor de la métrica personalizada.

scope

enum (MetricScope)

Obligatorio. Inmutable. Es el alcance de esta métrica personalizada.

restrictedMetricType[]

enum (RestrictedMetricType)

Opcional. Tipos de datos restringidos que puede contener esta métrica. Obligatorio para las métricas con la unidad de medida MONEDA. Debe estar vacío para las métricas con una unidad de medición que no sea MONEDA.

MeasurementUnit

Son los tipos posibles de representación del valor de la métrica personalizada.

La representación de la moneda puede cambiar en el futuro, lo que requerirá un cambio rotundo en la API.

Enumeraciones
MEASUREMENT_UNIT_UNSPECIFIED Falta la unidad de medida o no se especificó.
STANDARD Esta métrica usa unidades predeterminadas.
CURRENCY Esta métrica mide una moneda.
FEET Esta métrica mide pies.
METERS Esta métrica mide metros.
KILOMETERS Esta métrica mide kilómetros.
MILES Esta métrica mide kilómetros.
MILLISECONDS Esta métrica mide los milisegundos.
SECONDS Esta métrica mide los segundos.
MINUTES Esta métrica mide los minutos.
HOURS Esta métrica mide las horas.

MetricScope

El alcance de esta métrica.

Enumeraciones
METRIC_SCOPE_UNSPECIFIED El permiso es desconocido o no se especificó.
EVENT Métrica centrada en un evento.

RestrictedMetricType

Etiquetas que marcan los datos de esta métrica personalizada como datos que se deben restringir a usuarios específicos.

Enumeraciones
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconocido o no especificado.
COST_DATA Las métricas informan datos de costos.
REVENUE_DATA Las métricas informan datos de ingresos.

Métodos

archive

Archiva una CustomMetric en una propiedad.

create

Crea una CustomMetric.

get

Busca una sola CustomMetric.

list

Muestra CustomMetrics en una propiedad.

patch

Actualiza una CustomMetric en una propiedad.