REST Resource: properties.customMetrics

Recurso: CustomMetric

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

Representação JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Campos
name

string

Identificador. Nome do recurso para este recurso CustomMetric. Formato: properties/{property}/customMetrics/{customMetric}
parameterName

string

Obrigatório. Imutável. Nome da tag para essa métrica personalizada.

Se for uma métrica no escopo do evento, este será o nome do parâmetro de evento.

Pode conter apenas caracteres alfanuméricos e sublinhados, começando com uma letra. O comprimento máximo é de 40 caracteres para métricas no escopo do evento.
displayName

string

Obrigatório. Nome de exibição dessa métrica personalizada, conforme mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres, alfanumérico mais espaço e sublinhado começando com uma letra. Os nomes de exibição legados gerados pelo sistema podem conter colchetes, mas as atualizações desse campo nunca vão permitir colchetes.
description

string

Opcional. Descrição para essa dimensão personalizada. No máximo 150 caracteres.
measurementUnit

enum (MeasurementUnit)

Obrigatório. O tipo do valor da métrica personalizada.
scope

enum (MetricScope)

Obrigatório. Imutável. O escopo dessa métrica personalizada.
restrictedMetricType[]

enum (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 mudança importante na API.

Tipos enumerados
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit 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.
METERS Essa métrica mede metros.
KILOMETERS Essa métrica mede quilômetros.
MILES Essa métrica mede milhas.
MILLISECONDS Essa métrica mede milissegundos.
SECONDS Essa métrica mede segundos.
MINUTES Essa métrica mede minutos.
HOURS Essa métrica mede horas.

MetricScope

O escopo dessa métrica.

Tipos enumerados
METRIC_SCOPE_UNSPECIFIED Escopo desconhecido ou não especificado.
EVENT Métrica no escopo de um evento.

RestrictedMetricType

Rótulos que marcam os dados nessa métrica personalizada como dados que devem ser restritos a usuários específicos.

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

archive

 Arquiva uma CustomMetric em uma propriedade.

create

 Cria uma CustomMetric.

get

 Pesquisa por uma única CustomMetric.

list

 Lista CustomMetrics em uma propriedade.

patch

 Atualiza uma CustomMetric em uma propriedade.