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

Apenas saída. Nome do recurso para essa 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, esse é o nome do parâmetro do evento.

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

string

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

string

Opcional. Descrição da dimensão personalizada. O tamanho máximo é de 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 a unidade de medida MOEDA. Precisa estar vazio para métricas com uma unidade de medida que não seja MOEDA.

MeasurementUnit

Possíveis tipos 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.

Enums
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.

Enums
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 precisam ser restritos a usuários específicos.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Digite "unknown" ou "unspecified".
COST_DATA A métrica informa dados de custo.
REVENUE_DATA A métrica informa dados de receita.

Métodos

archive

 Arquiva uma métrica personalizada em uma propriedade.

create

 Cria uma métrica personalizada.

get

 Procure uma única métrica personalizada.

list

 Lista as Métricas personalizadas em uma propriedade.

patch

 Atualiza uma métrica personalizada em uma propriedade.