REST Resource: properties.customMetrics

Recurso: CustomMetric

Es una definición de 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

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

parameterName

string

Obligatorio. Inmutable. Es el nombre de etiquetado de 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. La longitud máxima es de 82 caracteres, alfanuméricos más espacio y guion bajo, y debe comenzar con una letra. Los nombres visibles heredados generados por el sistema pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán corchetes.

description

string

Es opcional. Es la descripción de esta dimensión personalizada. La longitud máxima es de 150 caracteres.

measurementUnit

enum (MeasurementUnit)

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

scope

enum (MetricScope)

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

restrictedMetricType[]

enum (RestrictedMetricType)

Es opcional. Son los tipos de datos restringidos que puede contener esta métrica. Es obligatorio para las métricas con la unidad de medida CURRENCY. Debe estar vacío para las métricas con una unidad de medida que no sea CURRENCY.

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.

Enums
MEASUREMENT_UNIT_UNSPECIFIED Indica que la unidad de medida no está especificada o falta.
STANDARD Indica que esta métrica usa unidades predeterminadas.
CURRENCY Indica que esta métrica mide una moneda.
FEET Indica que esta métrica mide pies.
METERS Indica que esta métrica mide metros.
KILOMETERS Indica que esta métrica mide kilómetros.
MILES Indica que esta métrica mide millas.
MILLISECONDS Indica que esta métrica mide milisegundos.
SECONDS Indica que esta métrica mide segundos.
MINUTES Indica que esta métrica mide minutos.
HOURS Indica que esta métrica mide horas.

MetricScope

Es el alcance de esta métrica.

Enums
METRIC_SCOPE_UNSPECIFIED Indica que el alcance es desconocido o no está especificado.
EVENT Indica que la métrica está centrada en un evento.

RestrictedMetricType

Son las etiquetas que marcan los datos de esta métrica personalizada como datos que deben restringirse a usuarios específicos.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Indica que el tipo es desconocido o no está especificado.
COST_DATA Indica que la métrica informa datos de costos.
REVENUE_DATA Indica que la métrica informa datos de ingresos.

Métodos

archive

Archiva una CustomMetric en una propiedad.

create

Crea una CustomMetric.

get

Busca una sola CustomMetric.

list

Muestra las CustomMetrics de una propiedad.

patch

Actualiza una CustomMetric en una propiedad.