REST Resource: properties.customMetrics

Ресурс: CustomMetric

Определение специальной метрики.

JSON-представление
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Поля
name

string

Только вывод. Имя ресурса для этого ресурса CustomMetric. Формат: свойства/{свойство}/customMetrics/{customMetric}

parameterName

string

Необходимый. Неизменный. Название тега для этой специальной метрики.

Если это метрика на уровне событий, то это имя параметра события.

Может содержать только буквенно-цифровые символы и символы подчеркивания, начинающиеся с буквы. Максимальная длина метрик на уровне событий — 40 символов.

displayName

string

Необходимый. Отображаемое имя для этой специальной метрики, как показано в пользовательском интерфейсе Analytics. Максимальная длина — 82 символа, буквенно-цифровые, плюс пробел и подчеркивание, начинающиеся с буквы. Отображаемые имена, созданные устаревшей системой, могут содержать квадратные скобки, но обновления этого поля никогда не допускают использования квадратных скобок.

description

string

Необязательный. Описание этого специального параметра. Максимальная длина 150 символов.

measurementUnit

enum ( MeasurementUnit )

Необходимый. Тип значения специальной метрики.

scope

enum ( MetricScope )

Необходимый. Неизменный. Область действия этой специальной метрики.

restrictedMetricType[]

enum ( RestrictedMetricType )

Необязательный. Типы ограниченных данных, которые может содержать эта метрика. Требуется для показателей с единицей измерения ВАЛЮТА. Должно быть пустым для показателей с единицами измерения, отличными от ВАЛЮТЫ.

Измерительное устройство

Возможные типы представления значения специальной метрики.

Представление валюты может измениться в будущем, что потребует кардинального изменения API.

Перечисления
MEASUREMENT_UNIT_UNSPECIFIED Единица измерения не указана или отсутствует.
STANDARD В этой метрике используются единицы по умолчанию.
CURRENCY Этот показатель измеряет валюту.
FEET Эта метрика измеряет футы.
METERS Эта метрика измеряется в метрах.
KILOMETERS Эта метрика измеряет километры.
MILES Эта метрика измеряет мили.
MILLISECONDS Эта метрика измеряет миллисекунды.
SECONDS Этот показатель измеряет секунды.
MINUTES Этот показатель измеряет минуты.
HOURS Этот показатель измеряет часы.

Метрикскоп

Область действия этого показателя.

Перечисления
METRIC_SCOPE_UNSPECIFIED Область применения неизвестна или не указана.
EVENT Метрика привязана к событию.

Ограниченныйметриктипе

Ярлыки, которые помечают данные в этой специальной метрике как данные, которые должны быть доступны только определенным пользователям.

Перечисления
RESTRICTED_METRIC_TYPE_UNSPECIFIED Тип неизвестен или не указан.
COST_DATA Метрика сообщает данные о затратах.
REVENUE_DATA Метрика сообщает данные о доходах.

Методы

archive

 Архивирует CustomMetric для свойства.

create

 Создает CustomMetric.

get

 Поиск одного CustomMetric.

list

 Перечисляет CustomMetrics для свойства.

patch

 Обновляет CustomMetric для свойства.