Method: properties.runAccessReport

{
  "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
}

object (AccessDimension)

המאפיינים המבוקשים והמוצגים בתגובה. בקשות יכולות לכלול עד 9 מאפיינים.

object (AccessMetric)

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

object (AccessDateRange)

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

object (AccessFilterExpression)

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

object (AccessFilterExpression)

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

string (int64 format)

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

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

string (int64 format)

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

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

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

string

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

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

object (AccessOrderBy)

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

boolean

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

boolean

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

boolean

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