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

O nome dessa 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

Os nomes desta métrica ainda podem ser usados, mas estão descontinuados. Se preenchida, essa métrica fica disponível por apiName ou deprecatedApiNames por um período. Após o período de descontinuação, a métrica estará disponível apenas a partir de apiName.

type

enum (MetricType)

Tipo da métrica.

expression

string

A expressão matemática para a 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. No caso de não expressões, esse campo fica vazio.

customDefinition

boolean

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

blockedReasons[]

enum (BlockedReason)

Se os motivos forem especificados, o acesso a essa métrica será bloqueado para essa propriedade. As solicitações de API enviadas por você para essa propriedade referentes a essa métrica serão bem-sucedidas. No entanto, o relatório terá 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 esta métrica.

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

category

string

O nome de exibição da categoria a que essa métrica pertence. Dimensões e métricas semelhantes são categorizadas juntas.

BlockedReason

Justificativas do bloqueio dessa métrica.

Enums
BLOCKED_REASON_UNSPECIFIED Nunca será especificado na resposta da API.
NO_REVENUE_METRICS Se estiver presente, seu acesso às métricas relacionadas à receita dessa propriedade será bloqueado, e essa métrica estará relacionada à receita.
NO_COST_METRICS Se estiver presente, seu acesso às métricas relacionadas ao custo dessa propriedade será bloqueado, e essa métrica estará relacionada ao custo.