Method: properties.runAccessReport

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

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

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

כדי לשלוח משוב על ה-API הזה, יש למלא את הטופס משוב על דוחות הגישה של Google Analytics.

בקשת HTTP

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

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

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

פרמטרים
entity

string

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

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

גוף הבקשה

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

ייצוג ב-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)

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

string (int64 format)

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

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

string (int64 format)

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

יכול להיות שה-API יחזיר פחות שורות מ-limit המבוקש, אם אין מספיק שורות שנותרו כדי למלא את הערך של 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