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". الحد الأقصى للطول هو 82 حرفًا.
calculatedMetricId

string

النتائج فقط. رقم التعريف المطلوب استخدامه للمقياس المحسوب. يُشار إلى ذلك في واجهة المستخدم باسم "اسم واجهة برمجة التطبيقات".

يُستخدَم calculatedMetricId عند الإشارة إلى هذا المقياس المحسوب من واجهات برمجة تطبيقات خارجية. على سبيل المثال، "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"، أو قد يتم عرض تحذيرات أو نتائج غير متوقّعة.

MetricUnit

الأنواع المحتملة لتمثيل قيمة المقياس المحسوب.

عمليات التعداد
METRIC_UNIT_UNSPECIFIED لم يتم تحديد MetricUnit أو أنّه غير متوفّر.
STANDARD يستخدم هذا المقياس الوحدات التلقائية.
CURRENCY يقيس هذا المقياس عملة.
FEET يقيس هذا المقياس القدم.
MILES يقيس هذا المقياس المسافة بالأميال.
METERS يقيس هذا المقياس الأمتار.
KILOMETERS يقيس هذا المقياس المسافة بالكيلومترات.
MILLISECONDS يقيس هذا المقياس بالملّي ثانية.
SECONDS يقيس هذا المقياس عدد الثواني.
MINUTES يقيس هذا المقياس عدد الدقائق.
HOURS يقيس هذا المقياس الساعات.

RestrictedMetricType

التصنيفات التي تحدّد البيانات في المقياس المحسوب المستخدَم بالتزامن مع أدوار المستخدمين التي تحظر الوصول إلى مقاييس التكلفة و/أو الأرباح

عمليات التعداد
RESTRICTED_METRIC_TYPE_UNSPECIFIED النوع غير معروف أو غير محدّد.
COST_DATA تعرض المقاييس بيانات التكلفة.
REVENUE_DATA تعرض تقارير المقاييس بيانات الإيرادات.

الطُرق

create

 تنشئ هذه الطريقة CalculatedMetric.

delete

 تحذف هذه الطريقة مقياسًا محسوبًا في موقع.

get

 بحث عن CalculatedMetric واحد

list

 تعرض هذه الطريقة قائمة بـ CalculatedMetrics في موقع.

patch

 تعديل CalculatedMetric في موقع