REST Resource: properties.calculatedMetrics

Recurso: CalculatedMetric

Una definición de una métrica calculada.

Representación JSON
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Campos
name

string

Solo salida. Nombre del recurso para esta CalculatedMetric. Formato: 'properties/{property_id}/EstimatedMetrics/{ calcularMetricId}'

description

string

Opcional. Es la descripción de esta métrica calculada. La longitud máxima es de 4,096 caracteres.

displayName

string

Obligatorio. El nombre visible de esta métrica calculada, como se muestra en la IU de Google Analytics. La longitud máxima es de 82 caracteres.

calculatedMetricId

string

Solo salida. Es el ID que se usará para la métrica calculada. En la IU, esto se conoce como el “nombre de la API”.

El valor calculadoMetricId se usa cuando se hace referencia a esta métrica calculada desde APIs externas. Por ejemplo, "calcMetric:{EstimatedMetricId}".

metricUnit

enum (MetricUnit)

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

restrictedMetricType[]

enum (RestrictedMetricType)

Solo salida. Tipos de datos restringidos que contiene esta métrica.

formula

string

Obligatorio. La definición de la métrica calculada. La cantidad máxima de métricas personalizadas únicas a las que se hace referencia es 5. Las fórmulas admiten las siguientes operaciones: + (suma), - (resta), - (negativa), * (multiplicación), / (división), () (paréntesis). Se acepta cualquier número real válido que quepa en un número largo (número entero de 64 bits) o un doble (número de punto flotante de 64 bits). Fórmula de ejemplo: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

Solo salida. Si es verdadero, esta métrica calculada tiene una referencia de métrica no válida. Todo lo que use una métrica calculada con invalidMetricReference configurado como verdadero puede fallar, generar advertencias o resultados inesperados.

MetricUnit

Tipos posibles que representan el valor de la métrica calculada.

Enumeradores
METRIC_UNIT_UNSPECIFIED MetricUnit sin especificar o faltante.
STANDARD Esta métrica usa unidades predeterminadas.
CURRENCY Esta métrica mide una moneda.
FEET Esta métrica mide pies.
MILES Esta métrica mide millas.
METERS Esta métrica mide metros.
KILOMETERS Esta métrica mide kilómetros.
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.

RestrictedMetricType

Son etiquetas que marcan los datos en la métrica calculada y se usan junto con los roles del usuario que restringen el acceso a las métricas de costos o ingresos.

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

create

Crea una CalculatedMetric.

delete

Borra CalculatedMetric en una propiedad.

get

Busca un solo CalculatedMetric.

list

Muestra una lista de CalculatedMetrics en una propiedad.

patch

Actualiza una métrica CalculatedMetric en una propiedad.