REST Resource: properties.calculatedMetrics

Recurso: CalculatedMetric

Uma definição para uma métrica calculada.

Representação JSON 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Campos
name

string

Apenas saída. Nome do recurso para essa métrica calculada. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

Opcional. Descrição da métrica calculada. Comprimento máximo de 4.096 caracteres.
displayName

string

Obrigatório. Nome de exibição dessa métrica calculada, conforme mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres.
calculatedMetricId

string

Apenas saída. O ID a ser usado para a métrica calculada. Na interface, isso é chamado de "nome da API".

O calculatedMetricId é usado ao fazer referência a essa métrica calculada de APIs externas. Por exemplo, "calcMetric:{calculatedMetricId}".
metricUnit

enum (MetricUnit)

Obrigatório. O tipo do valor da métrica calculada.
restrictedMetricType[]

enum (RestrictedMetricType)

Apenas saída. Tipos de dados restritos que esta métrica contém.
formula

string

Obrigatório. A definição da métrica calculada. O número máximo de métricas personalizadas referenciadas únicas é 5. As fórmulas aceitam as seguintes operações: + (adição), - (subtração), - (negativo), * (multiplicação), / (divisão), () (parênteses). Qualquer número real válido que caiba em um Long (número inteiro de 64 bits) ou Double (número de ponto flutuante de 64 bits) é aceito. Exemplo de fórmula: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

Apenas saída. Se verdadeiro, essa métrica calculada tem uma referência de métrica inválida. Qualquer coisa que use uma métrica calculada com invalidMetricReference definida como "true" pode falhar, gerar avisos ou resultados inesperados.

MetricUnit

Possíveis tipos de representação do valor da métrica calculada.

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit não especificado ou ausente.
STANDARD Essa métrica usa unidades padrão.
CURRENCY Essa métrica mede uma moeda.
FEET Essa métrica mede pés.
MILES Essa métrica mede milhas.
METERS Essa métrica mede metros.
KILOMETERS Essa métrica mede quilômetros.
MILLISECONDS Essa métrica mede milissegundos.
SECONDS Essa métrica mede segundos.
MINUTES Essa métrica mede minutos.
HOURS Essa métrica mede horas.

RestrictedMetricType

Rótulos que marcam os dados na métrica calculada usada com funções do usuário que restringem o acesso a métricas de custo e/ou receita.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Digite "unknown" ou "unspecified".
COST_DATA A métrica informa dados de custo.
REVENUE_DATA A métrica informa dados de receita.

Métodos

create

 Cria uma métrica calculada.

delete

 Exclui uma métrica calculada de uma propriedade.

get

 Consulta de uma única métrica calculada.

list

 Lista as Métricas calculadas em uma propriedade.

patch

 Atualiza uma métrica calculada em uma propriedade.