Method: properties.runAccessReport

מחזירה דוח מותאם אישית של רשומות גישה לנתונים. הדוח מספק רשומות של כל פעם שמשתמש קורא את נתוני הדיווח של Google Analytics. רשומות הגישה נשמרות עד שנתיים.

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

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

בקשת HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

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

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

פרמטרים
entity

string

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

כדי לשלוח בקשה ברמת הנכס, הישות צריכה להיות לדוגמה 'נכסים/123', אם מזהה נכס GA4 הוא '123'. כדי לשלוח בקשה ברמת החשבון, הישות צריכה להיות לדוגמה 'accounts/1234' אם מספר חשבון GA4 הוא '1234'.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
שדות
dimensions[]

object (AccessDimension)

המאפיינים שהתבקשו ומוצגים בתגובה. אפשר לשלוח בקשות ב-9 מאפיינים לכל היותר.
metrics[]

object (AccessMetric)

המדדים שהתבקשו והוצגו בתשובה. אפשר לשלוח בקשות עד 10 מדדים.
dateRanges[]

object (AccessDateRange)

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

object (AccessFilterExpression)

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

object (AccessFilterExpression)

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

string (int64 format)

מספר השורות בשורת ההתחלה. השורה הראשונה נספרת כשורה 0. אם לא צוין קיזוז, הוא יתייחס לערך 0. אם ההיסט הוא אפס, השיטה הזו תחזיר את הדף הראשון של התוצאות עם רשומות limit.

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.
limit

string (int64 format)

מספר השורות שיש להחזיר. אם לא צוין אחרת, יוחזרו 10,000 שורות. ה-API מחזיר עד 100,000 שורות לבקשה, ללא קשר לכמות שתבקש. הערך limit חייב להיות חיובי.

אם לא יהיו פחות שורות מה-limit, יכול להיות שה-API יחזיר פחות שורות מה-limit המבוקש. לדוגמה, יש פחות מ-300 ערכים אפשריים למאפיין 'country', כך שכשמדווחים רק על country, אי אפשר לקבל יותר מ-300 שורות, גם אם מגדירים ל-limit ערך גבוה יותר.

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.
timeZone

string

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

בפורמט של מחרוזות ממסד הנתונים של אזור הזמן IANA (https://www.iana.org/time-zones). לדוגמה, "America/New_York" או "Asia/Tokyo".
orderBys[]

object (AccessOrderBy)

מציין את סדר השורות בתשובה.
returnEntityQuota

boolean

הלחצן מציין אם להחזיר את המצב הנוכחי של המכסה בנכס Analytics הזה. המכסות מוחזרות בקטע AccessQuota. בבקשות ברמת החשבון, השדה הזה חייב להיות False.
includeAllUsers

boolean

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

boolean

זה שינוי אופציונלי. המדיניות הזו קובעת אם להחזיר את המשתמשים בתוך קבוצות המשתמשים. השדה הזה פועל רק כאשר IncludeAllUsers מוגדר כ-true. אם הערך הוא True, המערכת תחזיר את כל המשתמשים שיש להם גישה לנכס או לחשבון שצוינו. אם המדיניות מוגדרת כ-False, יוחזרו רק משתמשים עם גישה ישירה.

גוף התשובה

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

היקפי הרשאות

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

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