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 של Metric. לדוגמה, eventCount.

uiName

string

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

description

string

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

deprecatedApiNames[]

string

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

type

enum (MetricType)

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

expression

string

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

customDefinition

boolean

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

blockedReasons[]

enum (BlockedReason)

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

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

category

string

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

BlockedReason

נימוקים לכך שהמדד הזה חסום.

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