Recurso: CalculatedMetric
A definição de uma métrica calculada.
Representação JSON |
---|
{ "name": string, "description": string, "displayName": string, "calculatedMetricId": string, "metricUnit": enum ( |
Campos | |
---|---|
name |
Apenas saída. Nome do recurso para esta CalculatedMetric. Formato: 'properties/{property_id}/calculadoMetrics/{computeMetricId}' |
description |
Opcional. Descrição dessa métrica calculada. Comprimento máximo de 4.096 caracteres. |
displayName |
Obrigatório. Nome de exibição dessa métrica calculada como mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres. |
calculatedMetricId |
Apenas saída. O ID a ser usado para a métrica calculada. Na interface, isso é chamado de "nome da API". O computeMetricId é usado ao fazer referência a essa métrica calculada em APIs externas. Por exemplo, "calcMetric:{computeMetricId}". |
metricUnit |
Obrigatório. Tipo de valor da métrica calculada. |
restrictedMetricType[] |
Apenas saída. Tipos de dados restritos que essa métrica contém. |
formula |
Obrigatório. A definição da métrica calculada. O número máximo de métricas personalizadas referenciadas é de cinco. As fórmulas são compatíveis com as seguintes operações: + (adição), - (subtração), - (negativa), * (multiplicação), / (divisão), () (parênteses). Qualquer número real válido é aceitável que cabe em um Long (número inteiro de 64 bits) ou um Double (número de ponto flutuante de 64 bits). Exemplo de fórmula: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0" |
invalidMetricReference |
Apenas saída. Se verdadeiro, essa métrica calculada terá 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
Tipos possíveis 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 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 |
Esta métrica mede milissegundos. |
SECONDS |
Esta métrica mede segundos. |
MINUTES |
Essa métrica mede em minutos. |
HOURS |
Esta métrica mede horas. |
RestrictedMetricType
Rótulos que marcam os dados na métrica calculada usada em conjunto com as funções do usuário que restringem o acesso a métricas de custo e/ou receita.
Enums | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
Tipo desconhecido ou não especificado. |
COST_DATA |
A métrica gera relatórios de dados de custo. |
REVENUE_DATA |
A métrica informa dados de receita. |
Métodos |
|
---|---|
|
Cria uma CalculatedMetric. |
|
Exclui uma CalculatedMetric em uma propriedade. |
|
Procura uma única CalculatedMetric. |
|
Lista CalculatedMetrics em uma propriedade. |
|
Atualiza uma CalculatedMetric em uma propriedade. |