REST Resource: properties.calculatedMetrics

Источник: CalculatedMetric

Определение вычисляемой метрики.

JSON-представление 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Поля
name

string

Идентификатор. Имя ресурса для этого вычисляемого показателя. Формат: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

Необязательно. Описание для этого вычисляемого показателя. Максимальная длина — 4096 символов.

displayName

string

Обязательно. Отображаемое имя для этого вычисляемого показателя, как оно отображается в пользовательском интерфейсе Google Analytics. Максимальная длина 82 символа.

calculatedMetricId

string

Только для вывода. Идентификатор, используемый для вычисляемой метрики. В пользовательском интерфейсе это называется «имя API».

Параметр calculatedMetricId используется при обращении к этому вычисляемому показателю из внешних API. Например, "calcMetric:{calculatedMetricId}".

metricUnit

enum ( MetricUnit )

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

restrictedMetricType[]

enum ( RestrictedMetricType )

Только для вывода. Типы данных, которые содержит этот показатель, ограничены.

formula

string

Обязательно. Определение вычисляемой метрики. Максимальное количество уникальных пользовательских метрик, на которые можно ссылаться, — 5. Формулы поддерживают следующие операции: + (сложение), - (вычитание), - (отрицание), * (умножение), / (деление), () (скобки). Допускаются любые действительные числа, помещающиеся в тип Long (64-битное целое число) или Double (64-битное число с плавающей запятой). Пример формулы: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

Только для вывода. Если значение равно true, значит, вычисляемая метрика имеет недопустимую ссылку на метрику. Любое использование вычисляемой метрики с параметром invalidMetricReference, равным true, может привести к ошибке, предупреждениям или неожиданным результатам.

Метрическая единица

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

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

RestrictedMetricType

Метки, обозначающие данные в вычисляемых метриках, используются в сочетании с ролями пользователей, ограничивающими доступ к показателям затрат и/или доходов.

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

Методы

create

 Создает вычисляемый показатель.

delete

 Удаляет вычисляемый показатель (CalculatedMetric) в свойстве.

get

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

list

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

patch

 Обновляет вычисляемый показатель (CalculatedMetric) в свойстве.