MetricMetadata

מסביר מדד.

ייצוג JSON
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string
}
שדות
apiName

string

שם של מדד. ניתן לשימוש ב-name של המדד. לדוגמה, eventCount.

uiName

string

השם של המדד הזה בממשק המשתמש של Google Analytics. לדוגמה, Event count.

description

string

תיאור אופן השימוש והחישוב של המדד הזה.

deprecatedApiNames[]

string

עדיין אפשר להשתמש בשמות של המדד הזה, אבל הם הוצאו משימוש. אם המדד הזה מאוכלס, הוא יהיה זמין על ידי apiName או על ידי אחד מתוך deprecatedApiNames במשך תקופה מסוימת. אחרי תקופת ההוצאה משימוש, המדד יהיה זמין רק עד apiName.

type

enum (MetricType)

הסוג של המדד הזה.

expression

string

הביטוי המתמטי של המדד הנגזר. אפשר להשתמש בהן בשדה expression של Metric כדי להציג דוחות מקבילים. רוב המדדים הם לא ביטויים. לגבי ביטויים שאינם ביטויים, השדה הזה ריק.

customDefinition

boolean

הערך הוא True אם המדד הוא מדד מותאם אישית לנכס הזה.

blockedReasons[]

enum (BlockedReason)

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

מידע נוסף זמין במאמר ניהול גישה והגבלת נתונים.

category

string

השם המוצג של הקטגוריה שאליה משתייך המדד. מאפיינים ומדדים דומים מסווגים ביחד.

BlockedReason

הצדקות לכך שהמדד הזה חסום.

טיפוסים בני מנייה (enums)
BLOCKED_REASON_UNSPECIFIED אף פעם לא יצוינו בתגובת ה-API.
NO_REVENUE_METRICS אם היא קיימת, הגישה שלכם תיחסם למדדים שקשורים להכנסות בנכס הזה, והמדד הזה קשור להכנסה.
NO_COST_METRICS אם היא קיימת, הגישה שלך תיחסם למדדים הקשורים לעלות בנכס הזה, והמדד קשור לעלות.