REST Resource: properties.calculatedMetrics

Recurso: CalculatedMetric

Es 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}/CalculateMetrics/{CalculateMetricId}”

description

string

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

displayName

string

Obligatorio. Es el nombre visible de esta métrica calculada como se muestra en la IU de Google Analytics. Debe tener una longitud máxima de 82 caracteres.

calculatedMetricId

string

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

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

metricUnit

enum (MetricUnit)

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

restrictedMetricType[]

enum (RestrictedMetricType)

Solo salida. Son los 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 de referencia únicas 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 formato largo (número entero de 64 bits) o 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. Cualquier elemento que use una métrica calculada con invalidMetricReference configurado como verdadero puede fallar, generar advertencias o resultados inesperados.

MetricUnit

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

Enumeraciones
METRIC_UNIT_UNSPECIFIED MetricUnit no especificada o faltante.
STANDARD Esta métrica usa unidades predeterminadas.
CURRENCY Esta métrica mide una moneda.
FEET Esta métrica mide los pies.
MILES Esta métrica mide las millas.
METERS Esta métrica mide en metros.
KILOMETERS Esta métrica mide kilómetros.
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.

RestrictedMetricType

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

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

create

Crea una CalculatedMetric.

delete

Borra una CalculatedMetric en una propiedad.

get

Búsqueda de una sola CalculatedMetric.

list

Muestra una lista de CalculatedMetrics en una propiedad.

patch

Actualiza una CalculatedMetric en una propiedad.