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

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

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

גוף הבקשה

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

ייצוג 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 חייב להיות חיובי.

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

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

string

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

בפורמט של מחרוזות ממסד הנתונים של אזור הזמן IANA (https://www.iana.org/time-zones); לדוגמה "America/New_York" או 'אסיה/טוקיו'.
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