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 משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
userKey

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 ביומן שעליהן ה-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. לאחר מכן, לוחצים על הדף Activity Events (אירועי פעילות) שבנספח של האפליקציה הרצויה.

בדוגמאות הבאות לפעילות ב-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

מזהי קבוצות מופרדים בפסיקים (מעומעמים) שבהם מסוננות פעילויות המשתמשים, כלומר התגובה תכיל פעילויות רק של משתמשים שהם חלק מאחד לפחות ממזהי הקבוצות שצוינו כאן. פורמט: "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

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

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

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

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

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

דוחות הפעילות של אפליקציית Google Groups מספקים מידע על אירועי פעילות שונים בקבוצות.
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 ו-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

זוגות ערכי פרמטרים בתצוגת עץ שמשויכים לפרמטר הזה. סוג הערך המורכב של הפרמטר מוחזר כרשימה של ערכי פרמטרים. לדוגמה, יכול להיות שהערך של פרמטר הכתובת יהיה [{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

activities.list של אובייקטים מסוג messageValue.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

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

object

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

string

שעת התרחשות הפעילות. הזמן מופיע בשניות לפי ראשית זמן יוניקס (Unix epoch).
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 של מבקש הבקשה לבקשות API של OAuth 2LO או מזהה לחשבונות של רובוטים.