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: Properties/{property}/customMetrics/{customMetric}

parameterName

string

Obrigatório. Imutável. Nome da inclusão de tag dessa métrica personalizada.

No caso de uma métrica no escopo do evento, esse é o nome do parâmetro.

Só pode conter caracteres alfanuméricos e sublinhados, começando 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 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 legados gerados pelo sistema podem conter colchetes, mas as atualizações nesse 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. 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 em branco para métricas com uma unidade de medição que não seja 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 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 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 Esta métrica mede em segundos.
MINUTES Esta 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 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 Relatórios de métricas sobre 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

Procure uma única CustomMetric.

list

Lista CustomMetrics em uma propriedade.

patch

Atualiza uma CustomMetric em uma propriedade.