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

تعمل على إنشاء مقياس مخصّص.

get

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

list

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

patch

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