REST Resource: properties.customMetrics

المورد: مقياس مخصَّص

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

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

string

النتائج فقط. اسم المورد لهذا المورد في CustomMetric التنسيق: الخصائص/{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 وحدة القياس غير محدّدة أو غير متوفّرة.
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

ينشئ مقياسًا مخصّصًا.

get

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

list

يسرد المقاييس المخصَّصة على أحد المواقع.

patch

لتعديل مقياس مخصَّص على أحد المواقع