REST Resource: properties.customMetrics

Recurso: CustomMetric

Uma definição de 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 este recurso CustomMetric. Formato: propriedades/{property}/customMetrics/{customMetric}
parameterName

string

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

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

Só pode conter caracteres alfanuméricos e sublinhados, a começar com uma letra. 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 exibido na interface do Google Analytics. Comprimento máximo de 82 caracteres, alfanuméricos com espaço e sublinhado começando com uma letra. Nomes de exibição legados gerados pelo sistema podem conter colchetes, mas as atualizações desse campo nunca permitirão colchetes.
description

string

Opcional. Descrição dessa dimensão personalizada. Comprimento máximo de 150 caracteres.
measurementUnit

enum (MeasurementUnit)

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

enum (MetricScope)

Obrigatório. Imutável. O escopo da 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 CURRENCY. Precisa estar em branco para métricas com uma unidade de medida diferente de CURRENCY.

MeasurementUnit

Possíveis tipos de representação do valor da métrica personalizada.

A representação de moeda pode mudar no futuro, exigindo uma alteração interruptiva da API.

Enums
MEASUREMENT_UNIT_UNSPECIFIED Unidade de medida 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.
METERS Esta métrica mede metros.
KILOMETERS Esta métrica mede quilômetros.
MILES Esta métrica mede milhas.
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.

MetricScope

O escopo da 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 Dados de custo dos relatórios de métricas.
REVENUE_DATA A métrica informa dados de receita.

Métodos

archive

 Arquiva uma CustomMetric em uma propriedade.

create

 Cria uma CustomMetric.

get

 Pesquisar uma única CustomMetric.

list

 Lista CustomMetrics em uma propriedade.

patch

 Atualiza uma CustomMetric em uma propriedade.