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

Только вывод. Имя ресурса для этого CalculatedMetric. Формат: 'свойства/{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. Формулы поддерживают следующие операции: + (сложение), — (вычитание), — (отрицательное число), * (умножение), / (деление), () (круглые скобки). Допускаются любые действительные действительные числа, которые соответствуют длинному (64-битному целому числу) или двойному числу (64-битному числу с плавающей запятой). Пример формулы: "( customEvent:parameterName + carsPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

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

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

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

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

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

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

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

Методы

create

 Создает CalculatedMetric.

delete

 Удаляет CalculatedMetric для свойства.

get

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

list

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

patch

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