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

Solo salida. Nombre del recurso para este recurso CustomMetric. Formato: properties/{property}/customMetrics/{customMetric}

parameterName

string

Obligatorio. Inmutable. Nombre de etiquetado de esta métrica personalizada.

Si esta es 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, que comiencen 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 como se muestra en la IU de Analytics. Debe tener una longitud máxima de 82 caracteres, con caracteres alfanuméricos más espacios y guiones bajos que comiencen con una letra. Los nombres visibles heredados que genera el sistema pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán los corchetes.

description

string

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

measurementUnit

enum (MeasurementUnit)

Obligatorio. El tipo para el valor de la métrica personalizada.

scope

enum (MetricScope)

Obligatorio. Inmutable. 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 CURRENCY. Debe estar vacío para las métricas con una unidad de medida que no sea CURRENCY.

MeasurementUnit

Tipos posibles para representar el valor de la métrica personalizada.

La representación de la moneda puede cambiar en el futuro y requerir un cambio rotundo en la API.

Enumeraciones
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit no especificado o faltante.
STANDARD Esta métrica usa unidades predeterminadas.
CURRENCY Esta métrica mide una moneda.
FEET Esta métrica mide los pies.
METERS Esta métrica mide en metros.
KILOMETERS Esta métrica mide kilómetros.
MILES Esta métrica mide las millas.
MILLISECONDS Esta métrica mide 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 Alcance desconocido o no especificado.
EVENT Métrica que se limita a un evento.

RestrictedMetricType

Etiquetas que marcan los datos en esta métrica personalizada como datos que deben restringirse a usuarios específicos.

Enumeraciones
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconocido o sin especificar.
COST_DATA La métrica informa datos de costos.
REVENUE_DATA 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 una lista de CustomMetrics en una propiedad.

patch

Actualiza una CustomMetric en una propiedad.