Method: properties.getMetadata

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

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
name

string

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

דוגמה: properties/1234/metadata

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

גוף הבקשה

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

גוף התשובה

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

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

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

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

תיאורי המדדים.
comparisons[]

object (ComparisonMetadata)

תיאורי ההשוואה.

היקפי הרשאות

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

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

ComparisonMetadata

המטא-נתונים של השוואה בודדת.

ייצוג JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
שדות
apiName

string

שם המשאב של ההשוואה הזו. אפשר להשתמש בו בשדה השוואה של comparison. לדוגמה, 'comparisons/1234'.
uiName

string

השם של ההשוואה הזו בממשק המשתמש של Google Analytics.
description

string

התיאור של ההשוואה הזו.