Method: activities.list

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

בקשת HTTP

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

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

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

פרמטרים
userKey or all

string

מזהה הפרופיל או כתובת האימייל של המשתמש שעבורם יש לסנן את הנתונים. יכול להיות all לכל המידע, או userKey עבור מזהה פרופיל Google Workspace הייחודי של המשתמש או כתובת האימייל הראשית שלו. המשתמש לא יכול להיות משתמש שנמחק. במקרה של משתמש שנמחק, קוראים לפונקציה users.list ב-Directory API עם showDeleted=true, ולאחר מכן משתמשים במספר ID שמוחזר בתור userKey.
applicationName

enum (ApplicationName)

שם האפליקציה שעבורה רוצים לאחזר את האירועים.

פרמטרים של שאילתה

פרמטרים
actorIpAddress

string

כתובת פרוטוקול האינטרנט (IP) של המארח שבו בוצע האירוע. זוהי דרך נוספת לסנן סיכום דוח באמצעות כתובת ה-IP של המשתמש שהפעילות שלו מדווחת. כתובת IP זו עשויה לשקף את מיקומו הפיזי של המשתמש, וייתכן שלא. לדוגמה, כתובת ה-IP יכולה להיות כתובת שרת ה-proxy של המשתמש, או כתובת רשת וירטואלית פרטית (VPN). הפרמטר הזה תומך בגרסאות של כתובות IPv4 ו-IPv6.
customerId

string

המזהה הייחודי של הלקוח שעבורו רוצים לאחזר נתונים.
endTime

string

קביעת הסוף של טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. ערך ברירת המחדל הוא הזמן המשוער של בקשת ה-API. דוח API כולל שלושה מושגי זמן בסיסיים:

  • תאריך הבקשה לקבלת דוח מ-API: התאריך שבו ה-API יצר ואחזר את הדוח.
  • שעת ההתחלה של הדוח: תחילת פרק הזמן שמוצג בדוח. הערך startTime חייב לחול לפני endTime (אם צוין) והמועד הנוכחי שבו הבקשה נשלחת, או שה-API מחזיר שגיאה.
  • שעת הסיום של הדוח: סוף טווח הזמן שמוצג בדוח. לדוגמה, טווח הזמן של אירועים שסוכמו בדוח יכול להתחיל באפריל ולהסתיים במאי. את הדוח עצמו אפשר לבקש באוגוסט.
אם לא מציינים את endTime, הדוח מחזיר את כל הפעילויות מ-startTime עד השעה הנוכחית או 180 הימים האחרונים אם startTime מכיל יותר מ-180 ימים בעבר.
eventName

string

שם האירוע שה-API שולח לו שאילתה. כל eventName קשור לשירות או לתכונה ספציפיים של Google Workspace שה-API מארגן לפי סוגים של אירועים. לדוגמה: האירועים ביומן Google שמופיעים בדוחות של אפליקציית מסוף Admin. המבנה של הגדרות היומן type כולל את כל הפעילויות של eventName ביומן Google שדווחו על ידי ה-API. כשאדמין משנה הגדרה של יומן Google, ה-API מדווח על הפעילות הזו בפרמטרים type ו-eventName בהגדרות היומן. למידע נוסף על eventName מחרוזות ופרמטרים של שאילתות, כדאי לעיין ברשימת שמות האירועים לאפליקציות שונות שלמעלה, בקטע applicationName.
filters

string

מחרוזת השאילתה filters היא רשימה מופרדת בפסיקים שמורכבת מפרמטרים של אירועים שעברו מניפולציה על ידי אופרטורים יחסיים. הפרמטרים של האירועים מופיעים בפורמט {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

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

בדוגמאות הבאות של פעילויות ב-Drive, הרשימה שהוחזרה כוללת את כל האירועים מסוג edit שבהם ערך הפרמטר doc_id תואם לתנאים שהוגדרו על ידי האופרטור הרלציוני. בדוגמה הראשונה, הבקשה מחזירה את כל המסמכים שנערכו עם ערך doc_id השווה ל-12345. בדוגמה השנייה, הדוח מחזיר מסמכים שנערכו שבהם הערך של doc_id לא שווה ל-98765. האופרטור <> מקודד בכתובת ה-URL במחרוזת השאילתה של הבקשה (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

שאילתת filters תומכת באופרטורים היחסיים הבאים:

  • == —'שווה ל-'.
  • <>—'לא שווה ל-'. הקידוד של כתובת ה-URL חייב להיות (%3C%3E).
  • <—'פחות מ-'. קידוד כתובת ה-URL חייב להיות %3C.
  • <= —'קטן מ- או שווה ל-'. הקידוד של כתובת ה-URL חייב להיות (%3C=).
  • >—'גדול מ-'. הקידוד חייב להיות כתובת URL (%3E).
  • >=—'גדול מ- או שווה ל-'. הקידוד חייב להיות בכתובת URL (%3E=).

הערה: ה-API לא מקבל כמה ערכים של אותו פרמטר. אם פרמטר סופק יותר מפעם אחת בבקשת ה-API, ה-API מקבל רק את הערך האחרון של אותו פרמטר. בנוסף, אם צוין פרמטר לא חוקי בבקשת ה-API, ה-API מתעלם מהפרמטר הזה ומחזיר את התשובה שתואמת לשאר הפרמטרים החוקיים. אם לא מבקשים פרמטרים, מוחזרים כל הפרמטרים.
maxResults

integer

ההגדרה הזו קובעת כמה רשומות פעילות יוצגו בכל דף תגובה. לדוגמה, אם הבקשה מגדירה את הערך maxResults=1 ובדוח יש שתי פעילויות, בדוח יש שני דפים. המאפיין nextPageToken של התגובה כולל את האסימון לדף השני. מחרוזת השאילתה maxResults היא אופציונלית בבקשה. ערך ברירת המחדל הוא 1000.
orgUnitID

string

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

pageToken

string

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

string

מגדיר את תחילת טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. הדוח מחזיר את כל הפעילויות מ-startTime עד endTime. הערך startTime חייב לחול לפני endTime (אם צוין) והמועד הנוכחי שבו הבקשה נשלחת, או שה-API מחזיר שגיאה.
groupIdFilter

string

מזהי קבוצות מופרדים בפסיקים (obfuscated) שבהם פעילויות המשתמש מסוננות. כלומר, התגובה תכלול פעילויות רק עבור המשתמשים שנכללים לפחות באחד ממזהי הקבוצות המוזכרים כאן. פורמט: "id:abc123,id:xyz456"

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תבנית JSON לאוסף של פעילויות.

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

ייצוג JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

הסוג של משאב ה-API. בדוח פעילות, הערך הוא reports#activities.
etag

string

ה-ETag של המשאב.
items[]

object (Activity)

כל רשומה של פעילות בתגובה.
nextPageToken

string

אסימון לאחזור דף המעקב הבא של הדוח. הערך nextPageToken משמש במחרוזת השאילתה pageToken של הבקשה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

למידע נוסף, עיינו במדריך ההרשאות.

ApplicationName

טיפוסים בני מנייה (enums)
access_transparency

בדוחות הפעילות של Google Workspace Access Transparency מוצגים מידע על סוגים שונים של אירועי פעילות של Access Transparency.
admin

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

דוחות הפעילות של אפליקציית יומן Google מחזירים מידע על אירועי פעילות שונים ביומן.
chat בדוחות הפעילות ב-Chat מוצג מידע על אירועים שונים של פעילות ב-Chat.
drive

דוחות הפעילות של אפליקציית Google Drive מחזירים מידע על אירועי פעילות שונים ב-Google Drive. דוח הפעילות ב-Drive זמין רק ללקוחות Google Workspace Business ו-Google Workspace Enterprise.
gcp בדוחות הפעילות של אפליקציית Google Cloud Platform מוצג מידע על אירועי פעילות שונים ב-GCP.
gplus דוחות הפעילות של אפליקציית Google+ מחזירים מידע על אירועי פעילות שונים ב-Google+.
groups

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

דוחות הפעילות בקבוצות Enterprise מציגים מידע על אירועים שונים של פעילות בקבוצות Enterprise.
jamboard בדוחות הפעילות ב-Jamboard מוצג מידע על אירועי פעילות שונים ב-Jamboard.
login

דוחות הפעילות של אפליקציית ההתחברות מחזירים פרטי חשבון לגבי סוגים שונים של אירועי פעילות התחברות.
meet בדוח פעילות הביקורת ב-Meet מוצג מידע על סוגים שונים של אירועי פעילות ביקורת ב-Meet.
mobile בדוח 'פעילות ביקורת מכשירים' מוצג מידע על סוגים שונים של אירועי פעילות ביקורת מכשירים.
rules

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

דוח הפעילות של SAML מחזיר מידע על סוגים שונים של אירועי פעילות SAML.
token

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

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

בדוחות 'פעילות מבוססת-הקשר' מוצג מידע על אירועים של דחיית גישה של משתמשים בגלל כללים לבקרת גישה מבוססת-הקשר.
chrome

דוחות הפעילות ב-Chrome מחזירים מידע על אירועים בדפדפן Chrome וב-Chrome OS.
data_studio דוחות הפעילות ב-Data Studio מציגים מידע על סוגים שונים של אירועי פעילות ב-Data Studio.
keep דוחות הפעילות של אפליקציית Keep מחזירים מידע על אירועי פעילות שונים ב-Google Keep. דוח הפעילות ב-Keep זמין רק ללקוחות Google Workspace Business ו-Google Workspace Enterprise.
vault בדוחות הפעילות ב-Vault מוצגים מידע על סוגים שונים של אירועי פעילות ב-Vault.

פעילות

תבנית JSON למשאב הפעילות.

ייצוג JSON 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
שדות
kind

string

הסוג של משאב ה-API. בדוח פעילות, הערך הוא audit#activity.
etag

string

ה-ETag של הרשומה.
ownerDomain

string

זהו הדומיין שמושפע מהאירוע בדוח. לדוגמה, הדומיין של מסוף Admin או הבעלים של המסמך של אפליקציית Drive.
ipAddress

string

כתובת ה-IP של המשתמש שמבצע את הפעולה. זוהי כתובת פרוטוקול האינטרנט (IP) של המשתמש כשהוא מתחבר ל-Google Workspace, והיא לא בהכרח משקפת את המיקום הפיזי של המשתמש. לדוגמה, כתובת ה-IP יכולה להיות כתובת שרת ה-proxy של המשתמש, או כתובת רשת וירטואלית פרטית (VPN). ה-API תומך ב-IPv4 וב-IPv6.
events[]

object

אירועי פעילות בדוח.
events[].type

string

סוג האירוע. השירות או התכונה של Google Workspace שאדמין משנה מזוהים בנכס type, שמזהה אירוע באמצעות הנכס eventName. הרשימה המלאה של הקטגוריות type של ה-API מופיעה ברשימת שמות האירועים של האפליקציות השונות, שמופיעה למעלה בapplicationName.
events[].name

string

שם האירוע. זהו השם הספציפי של הפעילות שמדווחת על ידי ה-API. כל eventName קשור לשירות או לתכונה ספציפיים של Google Workspace שה-API מארגן לפי סוגי אירועים.
לפרמטרים של בקשה מסוג eventName באופן כללי:

  • אם לא צוין eventName, הדוח יחזיר את כל המופעים האפשריים של eventName.
  • כשמבקשים eventName, התגובה של ה-API מחזירה את כל הפעילויות שמכילות את אותו eventName.

מידע נוסף על נכסי eventName זמין ברשימת שמות האירועים השונים של האפליקציות שלמעלה בקטע applicationName.
events[].parameters[]

object

זוגות של ערכי פרמטרים לאפליקציות שונות. למידע נוסף על פרמטרים של eventName, כדאי לעיין ברשימת שמות האירועים של האפליקציות השונות שמופיעה למעלה בקטע applicationName.
events[].parameters[].messageValue

object

צמדים של ערכי פרמטר מקוננים המשויכים לפרמטר הזה. סוג של ערך מורכב של פרמטר מוחזר כרשימה של ערכי פרמטרים. לדוגמה, לפרמטר address יכול להיות ערך [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

ערכי פרמטרים
events[].parameters[].name

string

שם הפרמטר.
events[].parameters[].value

string

ערך המחרוזת של הפרמטר.
events[].parameters[].multiValue[]

string

ערכי המחרוזת של הפרמטר.
events[].parameters[].intValue

string (int64 format)

ערך מספר שלם של הפרמטר.
events[].parameters[].multiIntValue[]

string (int64 format)

מספרים שלמים של הפרמטר.
events[].parameters[].boolValue

boolean

ערך בוליאני של הפרמטר.
events[].parameters[].multiMessageValue[]

object

activity.list של messageValue אובייקטים.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

ערכי פרמטרים
id

object

מזהה ייחודי לכל רשומת פעילות.
id.time

string

שעת ההתרחשות של הפעילות. מדובר בפרק זמן של מערכת UNIX בשניות.
id.uniqueQualifier

string (int64 format)

מזהה ייחודי אם למספר אירועים יש את אותו זמן.
id.applicationName

string

שם האפליקציה שהאירוע שייך אליה. לערכים אפשריים ברשימת האפליקציות שלמעלה, אפשר לעיין בapplicationName.
id.customerId

string

המזהה הייחודי של חשבון Google Workspace.
actor

object

המשתמש מבצע את הפעולה.
actor.profileId

string

מזהה הפרופיל הייחודי של מבצע הפעולה ב-Google Workspace. יכול להיות שהערך הזה חסר אם הגורם אינו משתמש ב-Google Workspace, או שהוא יכול להיות המספר 105250506097979753968 המשמש כמזהה placeholder.
actor.email

string

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

string

סוג השחקן.
actor.key

string

מוצג רק אם הערך של callerType הוא KEY. יכול להיות consumer_key של מגיש הבקשה לבקשות OAuth 2LO API או מזהה של חשבונות רובוט.