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. قالب: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

اختیاری. توضیحات برای این متریک محاسبه شده. حداکثر طول 4096 کاراکتر.

displayName

string

مورد نیاز. نام نمایشی برای این معیار محاسبه شده همانطور که در رابط کاربری Google Analytics نشان داده شده است. حداکثر طول 82 کاراکتر.

calculatedMetricId

string

فقط خروجی شناسه مورد استفاده برای متریک محاسبه شده. در UI، این به عنوان "نام API" نامیده می شود.

محاسبه‌شدهMetricId هنگام ارجاع به این معیار محاسبه‌شده از APIهای خارجی استفاده می‌شود. به عنوان مثال، "calcMetric:{calculatedMetricId}".

metricUnit

enum ( MetricUnit )

مورد نیاز. نوع مقدار متریک محاسبه شده.

restrictedMetricType[]

enum ( RestrictedMetricType )

فقط خروجی انواع داده های محدود شده که این معیار شامل می شود.

formula

string

مورد نیاز. تعریف متریک محاسبه شده حداکثر تعداد معیارهای سفارشی مرجع منحصر به فرد 5 است. فرمول ها از عملیات زیر پشتیبانی می کنند: + (جمع)، - (تفریق)، - (منفی)، * (ضرب)، / (تقسیم)، () (پرانتز). هر عدد واقعی معتبری قابل قبول است که در یک Long (عدد صحیح 64 بیتی) یا یک دو (عدد ممیز شناور 64 بیتی) قرار گیرد. فرمول مثال: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

فقط خروجی اگر درست باشد، این معیار محاسبه شده دارای یک مرجع متریک نامعتبر است. هر چیزی که از یک متریک محاسبه‌شده استفاده می‌کند و invalidMetricReference روی درست تنظیم شده است، ممکن است شکست بخورد، اخطار ایجاد کند یا نتایج غیرمنتظره ایجاد کند.

واحد متریک

انواع احتمالی نمایش مقدار متریک محاسبه شده.

Enums
METRIC_UNIT_UNSPECIFIED واحد متریک مشخص نشده یا وجود ندارد.
STANDARD این معیار از واحدهای پیش فرض استفاده می کند.
CURRENCY این معیار یک واحد پولی را اندازه گیری می کند.
FEET این متریک پاها را اندازه گیری می کند.
MILES این متریک مایل ها را اندازه گیری می کند.
METERS این متریک متر را اندازه گیری می کند.
KILOMETERS این متریک کیلومتر را اندازه گیری می کند.
MILLISECONDS این متریک میلی ثانیه را اندازه گیری می کند.
SECONDS این متریک ثانیه ها را اندازه گیری می کند.
MINUTES این متریک دقیقه ها را اندازه گیری می کند.
HOURS این متریک ساعت ها را اندازه گیری می کند.

RestrictedMetricType

برچسب‌هایی که داده‌ها را در معیارهای محاسبه‌شده علامت‌گذاری می‌کنند، در ارتباط با نقش‌های کاربر که دسترسی به معیارهای هزینه و/یا درآمد را محدود می‌کنند، استفاده می‌شوند.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED تایپ ناشناخته یا نامشخص
COST_DATA داده های هزینه گزارش های متریک
REVENUE_DATA Metric داده های درآمد را گزارش می دهد.

روش ها

create

 یک CalculatedMetric ایجاد می کند.

delete

 یک متریک محاسبه شده را در یک ویژگی حذف می کند.

get

 جستجو برای یک CalculatedMetric واحد.

list

 CalculatedMetrics را در یک ویژگی فهرست می کند.

patch

 یک متریک محاسبه شده را در یک ویژگی به روز می کند.