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

النتائج فقط. اسم المورد لهذا المقياس المحسوب. Format: '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

 تُنشئ مقياسًا محسوبًا.

delete

 تؤدي هذه الوظيفة إلى حذف مقياس محسوب على موقع.

get

 ابحث عن مقياس محسوب واحد.

list

 يُدرج CalculatedMetrics في موقع.

patch

 تعديل "مقياس محسوب" على موقع