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

Identificador. Nome do recurso para CalculatedMetric. Formato: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

Opcional. Descrição para essa métrica calculada. O tamanho 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. O tamanho 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 essa 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 exclusivas é 5. As fórmulas são compatíveis com as seguintes operações: + (adição), - (subtração), - (negativo), * (multiplicação), / (divisão), () (parênteses). Qualquer número real válido que se ajuste a um Long (número inteiro de 64 bits) ou um 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 for "true", essa métrica calculada terá uma referência de métrica inválida. Qualquer coisa que use uma métrica calculada com invalidMetricReference definido como "true" pode falhar, gerar avisos ou produzir resultados inesperados.

MetricUnit

Tipos possíveis de representação do valor da métrica calculada.

Tipos enumerados
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 em conjunto com funções de usuário que restringem o acesso a métricas de custo e/ou receita.

Tipos enumerados
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconhecido ou não especificado.
COST_DATA Os relatórios de métricas mostram dados de custo.
REVENUE_DATA A métrica informa dados de receita.

Métodos

create

 Cria uma CalculatedMetric.

delete

 Exclui uma CalculatedMetric em uma propriedade.

get

 Pesquisa por uma única CalculatedMetric.

list

 Lista CalculatedMetrics em uma propriedade.

patch

 Atualiza uma CalculatedMetric em uma propriedade.