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 שגוי.

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

MetricScope

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

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

RestrictedMetricType

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

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

שיטות

archive

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

create

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

get

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

list

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

patch

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