Method: properties.getMetadata

מחזירה מטא-נתונים של מאפיינים ומדדים שזמינים בשיטות הדיווח. משמש לעיון במאפיינים ובמדדים. בשיטה הזו, מזהה נכס GA4 של Google Analytics מצוין בבקשה, והתגובה במטא-נתונים כוללת מאפיינים ומדדים מותאמים אישית, וגם מטא-נתונים של Universal.

לדוגמה, אם מדד מותאם אישית עם שם הפרמטר levels_unlocked רשום בנכס, תגובת המטא-נתונים תכיל את הערך customEvent:levels_unlocked. מטא-נתונים אוניברסליים הם מאפיינים ומדדים שרלוונטיים לכל נכס, כמו country ו-totalUsers.

בקשת HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של המטא-נתונים שיש לאחזר. שדה השם הזה מצוין בנתיב כתובת ה-URL ולא בפרמטרים של כתובת ה-URL. הנכס הוא מזהה מספרי של נכס GA4 ב-Google Analytics. למידע נוסף, אפשר לעיין במאמר איפה למצוא את מזהה הנכס.

דוגמה: properties/1234/metadata

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

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

ייצוג JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
שדות
name

string

שם המשאב של המטא-נתונים האלה.
dimensions[]

object (DimensionMetadata)

תיאורי המאפיינים.
metrics[]

object (MetricMetadata)

תיאורי המדדים.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

DimensionMetadata

מסביר מאפיין.

ייצוג JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
שדות
apiName

string

השם של המאפיין הזה. לשימוש במאפיין של name. לדוגמה, eventName.
uiName

string

השם של המאפיין הזה בממשק המשתמש של Google Analytics. לדוגמה, Event name.
description

string

תיאור אופן השימוש והחישוב של המאפיין הזה.
deprecatedApiNames[]

string

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

boolean

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

MetricMetadata

מסביר מדד.

ייצוג JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
שדות
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 אם המדד הוא מדד מותאם אישית לנכס הזה.