Method: properties.getMetadata

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

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

בקשת HTTP

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

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

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

פרמטרים
name

string

חובה. שם המשאב של המטא-נתונים שרוצים לאחזר. שדה השם הזה מצוין בנתיב של כתובת ה-URL ולא בפרמטרים של כתובת ה-URL. נכס הוא מזהה מספרי של נכס ב-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

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