REST Resource: properties.customMetrics

المورد: CustomMetric

تعريف لمقياس مخصّص.

تمثيل JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
الحقول
name

string

المعرّف. اسم المورد الخاص بمورد CustomMetric هذا. التنسيق: properties/{property}/customMetrics/{customMetric}
parameterName

string

الحقل مطلوب. غير قابل للتغيير اسم وضع العلامات لهذا المقياس المخصّص.

إذا كان هذا المقياس على مستوى الحدث، سيكون هذا هو اسم مَعلمة خاصة بالحدث.

يمكن أن يحتوي على أحرف أبجدية رقمية وشرطات سفلية فقط، ويجب أن يبدأ بحرف. الحدّ الأقصى لطول المقاييس على مستوى الحدث هو 40 حرفًا.
displayName

string

الحقل مطلوب. الاسم المعروض لهذا المقياس المخصّص كما يظهر في واجهة مستخدم "إحصاءات Google". يجب ألا يزيد طولها عن 82 حرفًا، وأن تكون أبجدية رقمية بالإضافة إلى مسافة وشرطة سفلية تبدأ بحرف. قد تحتوي الأسماء المعروضة القديمة التي ينشئها النظام على أقواس مربّعة، ولكن لن تسمح التعديلات على هذا الحقل مطلقًا بالأقواس المربّعة.
description

string

اختياريّ. وصف لهذه السمة المخصّصة الحدّ الأقصى للطول هو 150 حرفًا.
measurementUnit

enum (MeasurementUnit)

الحقل مطلوب. نوع قيمة المقياس المخصّص.
scope

enum (MetricScope)

الحقل مطلوب. غير قابل للتغيير نطاق هذا المقياس المخصّص.
restrictedMetricType[]

enum (RestrictedMetricType)

اختياريّ. أنواع البيانات المحظورة التي قد يتضمّنها هذا المقياس مطلوبة للمقاييس التي تستخدم وحدة القياس CURRENCY. يجب أن يكون هذا الحقل فارغًا للمقاييس التي تستخدم وحدة قياس غير CURRENCY.

MeasurementUnit

الأنواع المحتملة لتمثيل قيمة المقياس المخصّص.

قد يتغيّر تمثيل العملة في المستقبل، ما يستلزم إجراء تغيير غير متوافق في واجهة برمجة التطبيقات.

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

MetricScope

نطاق هذا المقياس.

عمليات التعداد
METRIC_SCOPE_UNSPECIFIED النطاق غير معروف أو لم يتم تحديده.
EVENT مقياس على مستوى الحدث

RestrictedMetricType

تصنيفات تحدّد البيانات في هذا المقياس المخصّص على أنّها بيانات يجب حصرها على مستخدمين محدّدين.

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

الطُرق

archive

 تؤرشف هذه الطريقة مقياسًا مخصّصًا في موقع.

create

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

get

 البحث عن CustomMetric واحد.

list

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

patch

 تعدّل هذه الطريقة مقياسًا مخصّصًا في موقع أو تطبيق.