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

חובה. השם המוצג של המדד המותאם אישית הזה כפי שמוצג בממשק המשתמש של Analytics. האורך המקסימלי של 82 תווים, אלפאנומריים, רווח וקווים תחתונים, שמתחיל באות. שמות תצוגה שהמערכת יצרה מדור קודם עשויים לכלול סוגריים מרובעים, אבל העדכונים בשדה הזה אף פעם לא יאפשרו שימוש בסוגריים מרובעים.
description

string

זה שינוי אופציונלי. התיאור של המאפיין המותאם אישית הזה. האורך המקסימלי הוא 150 תווים.
measurementUnit

enum (MeasurementUnit)

חובה. הסוג של הערך של המדד המותאם אישית.
scope

enum (MetricScope)

חובה. בלתי משתנה. ההיקף של המדד המותאם אישית הזה.
restrictedMetricType[]

enum (RestrictedMetricType)

זה שינוי אופציונלי. סוגי הנתונים המוגבלים שהמדד הזה עשוי להכיל. נדרש עבור מדדים עם יחידת מידה CURRENCY. חובה להשאיר את השדה ריק עבור מדדים עם יחידת מידה שאינה CURRENCY.

MeasurementUnit

סוגים אפשריים של ייצוג הערך של המדד המותאם אישית.

ייצוג המטבע עשוי להשתנות בעתיד, כך שיהיה צורך בשינוי של ה-API.

טיפוסים בני מנייה (enums)
MEASUREMENT_UNIT_UNSPECIFIED ה-MeasurementUnit לא צוין או חסר.
STANDARD במדד הזה נעשה שימוש ביחידות ברירת המחדל.
CURRENCY המדד הזה מודד מטבע.
FEET המדד הזה מודד רגל.
METERS המדד הזה מודד מטרים.
KILOMETERS המדד הזה מודד קילומטרים.
MILES המדד הזה מודד מיילים.
MILLISECONDS המדד הזה מודד אלפיות שנייה.
SECONDS המדד הזה מודד שניות.
MINUTES המדד הזה מודד דקות.
HOURS המדד הזה מודד שעות.

MetricScope

ההיקף של המדד הזה.

טיפוסים בני מנייה (enums)
METRIC_SCOPE_UNSPECIFIED ההיקף לא ידוע או לא צוין.
EVENT מדד ברמת האירוע.

RestrictedMetricType

תוויות שמסמנות את הנתונים במדד המותאם אישית הזה כנתונים שצריכים להיות מוגבלים למשתמשים ספציפיים.

טיפוסים בני מנייה (enums)
RESTRICTED_METRIC_TYPE_UNSPECIFIED סוג לא ידוע או שלא צוין.
COST_DATA נתוני עלות בדוחות מדדים.
REVENUE_DATA נתוני הכנסות מדוחות מדדים.

שיטות

archive

 מעביר לארכיון מדד מותאם אישית בנכס.

create

 יצירת מדד מותאם אישית.

get

 חיפוש מדד מותאם אישית יחיד.

list

 בתיבת הדו-שיח הזו מפורטים מדדים מותאמים אישית בנכס.

patch

 עדכון מדד מותאם אישית בנכס.