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

Ainda podem ser usados, mas os nomes dessa métrica foram descontinuados. Se preenchida, essa métrica ficará disponível por apiName ou deprecatedApiNames por um período. Após o período de descontinuação, a métrica vai estar disponível apenas por apiName.

type

enum (MetricType)

O tipo dessa métrica.

expression

string

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

customDefinition

boolean

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

blockedReasons[]

enum (BlockedReason)

Se os motivos forem especificados, seu acesso a essa métrica será bloqueado para essa propriedade. Suas solicitações de API para essa propriedade para essa métrica serão bem-sucedidas. No entanto, o relatório conterá somente zeros para essa métrica. As solicitações de API com filtros em métricas bloqueadas vão falhar. Se os motivos estiverem em branco, 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 a métrica pertence. Dimensões e métricas semelhantes são categorizadas em conjunto.

BlockedReason

Justificativas para o bloqueio desta métrica

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