MetricMetadata

Explica uma métrica.

Representação JSON
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string
}
Campos
apiName

string

Um nome de métrica. Pode ser usado no name da Métrica. Por exemplo, eventCount.

uiName

string

Nome da métrica na interface do usuário do Google Analytics. Por exemplo, Event count.

description

string

Descrição de como essa métrica é usada e calculada.

deprecatedApiNames[]

string

Nomes ainda utilizáveis, mas descontinuados para essa métrica. Se preenchida, essa métrica fica disponível por apiName ou por uma das deprecatedApiNames por um período. Após o período de descontinuação, a métrica só vai estar disponível até apiName.

type

enum (MetricType)

O tipo da métrica.

expression

string

A expressão matemática dessa métrica derivada. Pode ser usado no campo expression da Métrica para relatórios equivalentes. A maioria das métricas não são expressões, e, para as que não são, esse campo fica vazio.

customDefinition

boolean

Verdadeiro se a métrica for personalizada para essa propriedade.

blockedReasons[]

enum (BlockedReason)

Se os motivos forem especificados, seu acesso a essa métrica para essa propriedade será bloqueado. As solicitações de API para essa propriedade vão ser bem-sucedidas, mas o relatório vai mostrar apenas zeros para essa métrica. As solicitações de API com filtros de métrica em métricas bloqueadas vão falhar. Se os motivos estiverem vazios, você terá acesso a essa métrica.

Para saber mais, consulte Gerenciamento de restrição de dados e acesso.

category

string

O nome de exibição da categoria à qual as métricas pertencem. Dimensões e métricas semelhantes são categorizadas juntas.

BlockedReason

Justificativas para o bloqueio dessa métrica.

Enums
BLOCKED_REASON_UNSPECIFIED Nunca será especificado na resposta da API.
NO_REVENUE_METRICS Se presente, seu acesso é bloqueado para as métricas relacionadas à receita dessa propriedade, e essa métrica está relacionada à receita.
NO_COST_METRICS Se presente, seu acesso é bloqueado para métricas relacionadas a custos dessa propriedade, e essa métrica está relacionada a custos.