REST Resource: properties.calculatedMetrics

Recurso: CalculatedMetric

Uma definição de 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 esta CalculatedMetric. Formato: 'properties/{property_id}/generatedMetrics/{processedMetricId}'
description

string

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

string

Obrigatório. Nome de exibição dessa métrica calculada, como 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 do usuário, isso é chamado de "nome da API".

O "CalculadoMetricId" é usado ao referenciar essa métrica calculada de APIs externas. Por exemplo, "calcMetric:{generatedMetricId}".
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 exclusivas referenciadas é cinco. As fórmulas são compatíveis com as seguintes operações: + (adição), - (subtração), - (negativo), * (multiplicação), / (divisão), () (parênteses). É possível aceitar números reais válidos que se encaixam em um número longo (número inteiro de 64 bits) ou duplo (número de ponto flutuante de 64 bits). Exemplo de fórmula: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

Apenas saída. Se for "true", essa métrica calculada tem uma referência inválida. Qualquer ação que use uma métrica calculada com invalidMetricReference definida como "true" pode falhar, produzir avisos ou produzir resultados inesperados.

MetricUnit

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

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

RestrictedMetricType

Rótulos que marcam os dados na métrica calculada usada em conjunto com papéis do usuário que restringem o acesso às métricas de custo e/ou receita.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconhecido ou não especificado.
COST_DATA Dados de custo dos relatórios de métricas.
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.