REST Resource: properties.calculatedMetrics

Recurso: CalculatedMetric

Es una definición para 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. Es el nombre del recurso de esta CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

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

displayName

string

Obligatorio. Es el nombre visible de esta métrica calculada, tal 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, se hace referencia a esto como el "nombre de la API".

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

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. Es 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), - (negativo), * (multiplicación), / (división), () (paréntesis). Se aceptan todos los números reales válidos que se ajusten a un Long (número entero de 64 bits) o un Double (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. Cualquier elemento que use una métrica calculada con invalidMetricReference establecida como verdadera puede fallar, generar advertencias o producir resultados inesperados.

MetricUnit

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

Enumeraciones
METRIC_UNIT_UNSPECIFIED MetricUnit no se especificó o falta.
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 kilómetros.
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 los segundos.
MINUTES Esta métrica mide los minutos.
HOURS Esta métrica mide las horas.

RestrictedMetricType

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

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

create

Crea una CalculatedMetric.

delete

Borra una CalculatedMetric en una propiedad.

get

Busca una sola CalculatedMetric.

list

Muestra las CalculatedMetrics en una propiedad.

patch

Actualiza una CalculatedMetric en una propiedad.