Method: properties.getMetadata

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

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

בקשת HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
שדות
name

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

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

object (ComparisonMetadata)

תיאורי ההשוואה.
conversions[]

object (ConversionMetadata)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
שדות
apiName

string

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

string

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

string

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

string

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

boolean

הערך הוא True אם המאפיין מותאם אישית לנכס הזה. המאפיינים האלה כוללים מאפיינים מותאמים אישית בהיקף משתמש, אירוע ופריט. מידע נוסף על מאפיינים מותאמים אישית זמין בכתובת https://support.google.com/analytics/answer/14240153. הדבר כולל גם קבוצות ערוצים בהתאמה אישית. מידע נוסף על קבוצות ערוצים בהתאמה אישית זמין בכתובת https://support.google.com/analytics/answer/13051316.
category

string

השם המוצג של הקטגוריה שאליה שייך המאפיין הזה. מאפיינים ומדדים דומים מסווגים יחד.
sections[]

enum (Section)

מציין את החלקים ב-Google Analytics שהמאפיין הזה חל עליהם.

MetricMetadata

הסבר על מדד.

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

string

שם המדד. אפשר להשתמש בו ב-Metric's name. לדוגמה, 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 עם מסנני מדדים על מדדים חסומים ייכשלו. אם השדה reasons ריק, יש לכם גישה למדד הזה.

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

string

השם המוצג של הקטגוריה שאליה שייכים המדדים האלה. מאפיינים ומדדים דומים מסווגים יחד.
sections[]

enum (Section)

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

BlockedReason

הסברים לסיבות שבגללן המדד הזה חסום.

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

ComparisonMetadata

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

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

string

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

string

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

string

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

ConversionMetadata

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

ייצוג JSON 
{
  "conversionAction": string,
  "displayName": string
}
שדות
conversionAction

string

המזהה הייחודי של פעולת ההמרה. המזהה הזה משמש לציון ההמרות שרוצים לכלול בדוח. לשם כך, מאכלסים את השדה conversionActions בConversionsSpec של בקשת דוח. לדוגמה, 'conversionActions/1234'.
displayName

string

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