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. Формат: properties/{property}/customMetrics/{customMetric}

parameterName

string

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

Если это метрика, ограниченная областью действия события, то это имя параметра события.

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

displayName

string

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

description

string

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

measurementUnit

enum ( MeasurementUnit )

Обязательно. Тип значения пользовательской метрики.

scope

enum ( MetricScope )

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

restrictedMetricType[]

enum ( RestrictedMetricType )

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

Единица измерения

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

В будущем способ представления валюты может измениться, что потребует внесения изменений в API, нарушающих обратную совместимость.

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

MetricScope

Область применения данного показателя.

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

RestrictedMetricType

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

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

Методы

archive

 Архивирует пользовательскую метрику для объекта недвижимости.

create

 Создает пользовательскую метрику.

get

 Найдите отдельный параметр CustomMetric.

list

 Отображает пользовательские метрики для объекта недвижимости.

patch

 Обновляет пользовательский показатель (CustomMetric) в объекте недвижимости.