REST Resource: properties.customMetrics

Recurso: CustomMetric

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 del 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, que comiencen con una letra. Longitud máxima de 40 caracteres para las métricas centradas en el evento.

displayName

string

Obligatorio. Nombre visible de esta métrica personalizada como se muestra en la IU de Analytics. Longitud máxima de 82 caracteres, caracteres alfanuméricos más un espacio y un guion bajo que comience con una letra. Los nombres visibles heredados generados por 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. La longitud máxima es de 150 caracteres.

measurementUnit

enum (MeasurementUnit)

Obligatorio. Es el tipo del 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 de representar el valor de la métrica personalizada.

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

Enumeradores
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit no se especificó 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 millas.
MILLISECONDS Esta métrica mide los milisegundos.
SECONDS Esta métrica mide segundos.
MINUTES Esta métrica mide minutos.
HOURS Esta métrica mide las horas.

MetricScope

El alcance de esta métrica.

Enumeradores
METRIC_SCOPE_UNSPECIFIED Alcance desconocido o no especificado.
EVENT Métrica 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.

Enumeradores
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconocido o no especificado.
COST_DATA Las métricas informan los 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 una lista de CustomMetrics en una propiedad.

patch

Actualiza una CustomMetric en una propiedad.