Recurso: CustomMetric
A definição de uma métrica personalizada.
Representação JSON |
---|
{ "name": string, "parameterName": string, "displayName": string, "description": string, "measurementUnit": enum ( |
Campos | |
---|---|
name |
Apenas saída. Nome do recurso para este recurso CustomMetric. Formato: Properties/{property}/customMetrics/{customMetric} |
parameterName |
Obrigatório. Imutável. Nome da marcação desta métrica personalizada. Se a métrica for no escopo do evento, esse vai ser o nome do parâmetro do evento. Pode conter apenas caracteres alfanuméricos e sublinhado, começando com uma letra. Comprimento máximo de 40 caracteres para métricas no escopo do evento. |
displayName |
Obrigatório. Nome de exibição dessa métrica personalizada, conforme mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres, alfanuméricos mais espaço e sublinhado começando com uma letra. Nomes de exibição gerados pelo sistema legados podem conter colchetes, mas as atualizações nesse campo nunca permitirão colchetes. |
description |
Opcional. Descrição dessa dimensão personalizada. Comprimento máximo de 150 caracteres. |
measurementUnit |
Obrigatório. O tipo do valor da métrica personalizada. |
scope |
Obrigatório. Imutável. O escopo dessa métrica personalizada. |
restrictedMetricType[] |
Opcional. Tipos de dados restritos que essa métrica pode conter. Obrigatório para métricas com unidade de medida CURRENCY. Precisa estar vazio para métricas com uma unidade de medida que não seja CURRENCY. |
MeasurementUnit
Tipos possíveis de representação do valor da métrica personalizada.
A representação da moeda pode mudar no futuro, exigindo uma alteração interruptiva na API.
Enums | |
---|---|
MEASUREMENT_UNIT_UNSPECIFIED |
MeasurementUnit 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. |
METERS |
Esta métrica mede metros. |
KILOMETERS |
Esta métrica mede quilômetros. |
MILES |
Esta métrica mede milhas. |
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. |
MetricScope
O escopo dessa métrica.
Enums | |
---|---|
METRIC_SCOPE_UNSPECIFIED |
Escopo desconhecido ou não especificado. |
EVENT |
Métrica com escopo para um evento. |
RestrictedMetricType
Rótulos que marcam os dados nessa métrica personalizada como dados que precisam ser restritos a usuários específicos.
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 |
|
---|---|
|
Arquiva uma CustomMetric em uma propriedade. |
|
Cria uma CustomMetric. |
|
Procura uma única CustomMetric. |
|
Lista CustomMetrics em uma propriedade. |
|
Atualiza uma CustomMetric em uma propriedade. |