MetricMetadata

Объясняет метрику.

JSON-представление
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string
}
Поля
apiName

string

Имя метрики. Используется в name Метрики . Например, eventCount .

uiName

string

Название этого показателя в пользовательском интерфейсе Google Analytics. Например, Event count .

description

string

Описание того, как эта метрика используется и рассчитывается.

deprecatedApiNames[]

string

По-прежнему используемые, но устаревшие имена для этой метрики. Если эта метрика заполнена, она доступна либо по apiName , либо по одному из deprecatedApiNames в течение определенного периода времени. После периода прекращения поддержки метрика будет доступна только по apiName .

type

enum ( MetricType )

Тип этой метрики.

expression

string

Математическое выражение для этой производной метрики. Может использоваться в поле expression показателя для эквивалентных отчетов. Большинство показателей не являются выражениями, а для невыражений это поле пусто.

customDefinition

boolean

Значение true, если метрика является специальной метрикой для этого свойства.

blockedReasons[]

enum ( BlockedReason )

Если указаны причины, ваш доступ к метрике для этого ресурса блокируется. Запросы API от вас к этому свойству для этой метрики будут успешными; однако отчет будет содержать только нули для этой метрики. Запросы API с фильтрами метрик по заблокированным метрикам завершатся ошибкой. Если причины пусты, у вас есть доступ к этой метрике.

Дополнительные сведения см. в разделе Управление доступом и ограничением данных .

category

string

Отображаемое имя категории, к которой принадлежит этот показатель. Похожие параметры и показатели объединены в одну категорию.

БлокедПричина

Обоснования того, почему этот показатель заблокирован.

Перечисления
BLOCKED_REASON_UNSPECIFIED Никогда не будет указан в ответе API.
NO_REVENUE_METRICS Если они есть, ваш доступ заблокирован к показателям, связанным с доходом для этого ресурса, и этот показатель связан с доходом.
NO_COST_METRICS Если они есть, ваш доступ к показателям, связанным со стоимостью для этого ресурса, заблокирован, а этот показатель связан со стоимостью.