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 Transcoding.

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

פרמטרים
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 מחזיר שגיאה.
  • Report's end time: סוף טווח הזמן שמוצג בדוח. לדוגמה, טווח הזמן של אירועים שמסוכמים בדוח יכול להתחיל באפריל ולהסתיים במאי. אפשר לבקש את הדוח עצמו באוגוסט.
אם לא מציינים את endTime, הדוח מחזיר את כל הפעילויות מ-startTime עד השעה הנוכחית, או מ-180 הימים האחרונים אם startTime חל לפני יותר מ-180 ימים.

בבקשות שקשורות ל-Gmail, startTime ו-endTime חייבים להיות מסופקים, וההפרש ביניהם לא יכול להיות גדול מ-30 יום.

eventName

string

שם האירוע שנשלח לגביו שאילתה באמצעות ה-API. כל eventName קשור לשירות או לתכונה ספציפיים ב-Google Workspace, שה-API מארגן לסוגים של אירועים. דוגמה לכך היא האירועים מיומן Google בדוחות של אפליקציית מסוף Admin. המבנה של Calendar Settings type כולל את כל הפעילויות ביומן eventName שמדווחות על ידי ה-API. כשמנהל משנה הגדרה ביומן, ה-API מדווח על הפעילות הזו בפרמטרים Calendar Settings 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 היא אופציונלית בבקשה. ערך ברירת המחדל הוא 1,000.

orgUnitID

string

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

pageToken

string

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

startTime

string

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

בבקשות שקשורות ל-Gmail, startTime ו-endTime חייבים להיות מסופקים, וההפרש ביניהם לא יכול להיות גדול מ-30 יום.

groupIdFilter

string

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

resourceDetailsFilter

string

אופציונלי. מחרוזת השאילתה resourceDetailsFilter היא רשימה מופרדת באמצעות AND שמורכבת משדות Resource Details שעברו מניפולציה על ידי אופרטורים יחסיים.

מסנני פרטי המשאבים הם מהצורה {resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}...

כל השדות הפנימיים עוברים דרך האופרטור ., כמו בדוגמה הבאה:

resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id =
"appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id =
"fieldValueId"

resourceDetailsFilter השאילתה תומכת באופרטורים הרלציוניים הבאים:

  • = – 'שווה ל'.
  • != – 'לא שווה לערך'.
  • : – 'קיים'. הוא משמש לסינון בשדות חוזרים.

סוגי FieldValue שחוזרים על עצמם בטבע משתמשים באופרטור exists לסינון.
הסוגים הבאים של FieldValue חוזרים על עצמם:

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

resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id =
"appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id =
"fieldValueId" AND resourceDetails.appliedLabels.fieldValue.type =
"SELECTION_LIST_VALUE" AND
resourceDetails.appliedLabels.fieldValue.selectionListValue.id: "id"

שימוש

GET...&resourceDetailsFilter=resourceDetails.id = "resourceId" AND
resourceDetails.appliedLabels.id = "appliedLabelId"
GET...&resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22

חשוב לזכור:

  • לפני ששולחים את הבקשה, צריך לבצע קידוד URL של מחרוזת השאילתה.

  • ה-API תומך ב-5 שדות לכל היותר, שמופרדים באמצעות האופרטור AND.

  • כשמסננים ברמות עמוקות יותר (לדוגמה, AppliedLabel, FieldValue), צריך לכלול במסנן את המזהים של כל הרמות הקודמות בהיררכיה. לדוגמה: כדי לסנן לפי FieldValue, צריך להזין את המזהה של AppliedLabel ואת המזהה של resourceDetails.
    שאילתה לדוגמה:

    resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId"

  • כדי לסנן לפי סוגים פנימיים של FieldValue כמו longTextValue ו-textValue, צריך להוסיף את resourceDetails.appliedLabels.fieldValue.type.

  • יש תמיכה רק בסינון לפי מזהה AppliedLabel אחד ומזהה FieldValue אחד.

networkInfoFilter

string

אופציונלי. המסנן משמש לסינון לפי השדה regionCode שמופיע בהודעה NetworkInfo.

שימוש

GET...&networkInfoFilter=regionCode="IN"
GET...&networkInfoFilter=regionCode=%22IN%22
statusFilter

string

אופציונלי. המסנן משמש לסינון לפי השדה statusCode שמופיע בהודעה Status.

שימוש

GET...&statusFilter=statusCode="200"
GET...&statusFilter=statusCode=%22200%22
applicationInfoFilter

string

אופציונלי. המסנן משמש לסינון לפי השדה oAuthClientId שמופיע בהודעה ApplicationInfo.

שימוש

GET...&applicationInfoFilter=oAuthClientId="clientId"
GET...&applicationInfoFilter=oAuthClientId=%22clientId%22
includeSensitiveData

boolean

אופציונלי. אם השדה הזה מוגדר לערך true, תוכן רגיש שנוצר על ידי משתמשים יכול להיכלל ביומני הביקורת שמוחזרים. הפרמטר הזה נתמך רק בכללים (DLP), באפליקציות של Chat ו-Workspace Studio. שימוש בו באפליקציה אחרת כלשהי יגרום לשגיאת הרשאה.

agentInfoFilter

string

אופציונלי. מסננים בשדות של פרטי הסוכן בפעילות. המסנן הזה מופעל בשילוב(AND) עם מסננים אחרים. דוגמה: "agentInfoFilter=agentId="agent-id" AND agentName="agent-name" AND agentOwnerEmail="agent-owner-email""

deviceFilter

string

אופציונלי. המסנן משמש לסינון השדות שמופיעים בהודעה UserDeviceInfo, כמו deviceId, ‏ deviceType ו-deviceOsVersion.

שימוש

GET...&deviceFilter=deviceId="123"
GET...&deviceFilter=deviceType="ANDROID"
GET...&deviceFilter=deviceOsVersion="14.0"

גוף הבקשה

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

גוף התשובה

תבנית 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.
gmail בדוחות הפעילות של אפליקציית Gmail מופיע מידע על אירועי פעילות שונים ב-Gmail.
gplus דוחות הפעילות של אפליקציית Google+‎ מחזירים מידע על אירועי פעילות שונים ב-Google+‎.
groups

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

groups_enterprise

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

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

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

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

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

saml

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

token

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

בדוחות הפעילות של Gemini ל-Workspace מופיע מידע על סוגים שונים של אירועי הפעילות עם Gemini שבוצעו על ידי משתמשים באפליקציית Workspace.

classroom בדוחות הפעילות ב-Classroom מופיע מידע על סוגים שונים של אירועי פעילות ב-Classroom.
assignments בדוחות הפעילות של כלי המשימות ללמידה אפשר לראות מידע על סוגים שונים של אירועי פעילות שקשורים למשימות.
tasks בדוחות הפעילות של אפליקציית Tasks מופיע מידע על סוגים שונים של אירועי פעילות ב-Tasks.
data_migration בדוחות הפעילות של אפליקציית העברת הנתונים מופיע מידע על אירועי פעילות שונים של העברת נתונים.
meet_hardware בדוחות הפעילות של אפליקציית ציוד ל-Meet מופיע מידע על סוגים שונים של אירועי פעילות בציוד ל-Meet.
directory_sync בדוחות הפעילות של אפליקציית Directory Sync מופיע מידע על סוגים שונים של אירועי פעילות ב-Directory Sync.
ldap בדוחות הפעילות של אפליקציית ldap מופיע מידע על סוגים שונים של אירועי פעילות ldap.
profile בדוחות הפעילות של אפליקציית הפרופיל מופיע מידע על סוגים שונים של אירועי פעילות בפרופיל.
access_evaluation בדוחות הפעילות של Access Evaluation מופיע מידע על סוגים שונים של אירועי פעילות של Access Evaluation.
admin_data_action בדוחות הפעילות של האפליקציה 'פעולה לגבי נתוני אדמין' מופיע מידע על סוגים שונים של אירועי פעילות שקשורים לפעולה לגבי נתוני אדמין.
contacts בדוחות הפעילות של אפליקציית אנשי הקשר מופיע מידע על סוגים שונים של אירועי פעילות שקשורים לאנשי הקשר.
takeout בדוחות הפעילות של אפליקציית Takeout מופיע מידע על סוגים שונים של אירועי פעילות ב-Takeout.
graduation בדוחות הפעילות של אפליקציית Graduation מופיע מידע על סוגים שונים של אירועי פעילות ב-Graduation.
voice בדוחות הפעילות של אפליקציית Voice מופיע מידע על סוגים שונים של אירועי פעילות ב-Voice.
chrome_sync דוחות הפעילות של אפליקציית סנכרון Chrome מחזירים מידע על סוגים שונים של אירועי פעילות בסנכרון Chrome.
workspace_studio בדוחות הפעילות של אפליקציית Workspace Studio מופיע מידע על סוגים שונים של אירועי פעילות ב-Workspace Studio.

פעילות

תבנית 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)
                }
              ]
            }
          ]
        }
      ],
      "sensitiveParameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ],
      "status": {
        object (Status)
      }
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    },
    "agentAttributionInfo": {
      object (AgentAttributionInfo)
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ],
  "isAgenticAction": boolean,
  "userDeviceInfo": {
    object (UserDeviceInfo)
  }
}
שדות
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 of messageValue objects.

events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

ערכי פרמטרים

events[].sensitiveParameters[]

object

כולל צמדי מפתח-ערך של פרמטרים רגישים לאפליקציות שונות.

events[].sensitiveParameters[].messageValue

object

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

events[].sensitiveParameters[].messageValue.parameter[]

object (NestedParameter)

ערכי פרמטרים

events[].sensitiveParameters[].name

string

שם הפרמטר.

events[].sensitiveParameters[].value

string

ערך המחרוזת של הפרמטר.

events[].sensitiveParameters[].multiValue[]

string

ערכי המחרוזת של הפרמטר.

events[].sensitiveParameters[].intValue

string (int64 format)

ערך הפרמטר כמספר שלם.

events[].sensitiveParameters[].multiIntValue[]

string (int64 format)

ערכים של מספרים שלמים של הפרמטר.

events[].sensitiveParameters[].boolValue

boolean

הערך הבוליאני של הפרמטר.

events[].sensitiveParameters[].multiMessageValue[]

object

activities.list of messageValue objects.

events[].sensitiveParameters[].multiMessageValue[].parameter[]

object (NestedParameter)

ערכי פרמטרים

events[].resourceIds[]

string

מזהי המשאבים שמשויכים לאירוע.

events[].status

object (Status)

הסטטוס של האירוע. הערה: לא לכל האירועים יש סטטוס.

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 או מזהה של חשבונות רובוט.

actor.applicationInfo

object

פרטים על האפליקציה שהייתה הגורם הפעיל בפעילות.

actor.applicationInfo.oauthClientId

string

מזהה הלקוח של OAuth של אפליקציית הצד השלישי ששימשה לביצוע הפעולה.

actor.applicationInfo.applicationName

string

שם האפליקציה שמשמשת לביצוע הפעולה.

actor.applicationInfo.impersonation

boolean

האם האפליקציה התחזתה למשתמש.

actor.agentAttributionInfo

object (AgentAttributionInfo)

פרטים על סוכן ה-AI שהיה הגורם המבצע של הפעילות.

networkInfo

object (NetworkInfo)

פרטי הרשת של המשתמש שמבצע את הפעולה.

resourceDetails[]

object (ResourceDetails)

פרטים על מקור המידע שעליו בוצעה הפעולה.

isAgenticAction

boolean

האם הפעילות בוצעה על ידי סוכן.

userDeviceInfo

object (UserDeviceInfo)

פרטי המכשיר של המשתמש שמבצע את הפעולה. השדה הזה מוצג רק באפליקציות contacts,‏ gemini_in_workspace_apps,‏ keep,‏ meet_hardware,‏ meet,‏ chat,‏ chrome,‏ directory_sync,‏ drive,‏ groups,‏ rules,‏ data_studio ו-saml.

NetworkInfo

פרטי הרשת של המשתמש שמבצע את הפעולה.

ייצוג JSON
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
שדות
ipAsn[]

integer

כתובת ה-IP של המשתמש שביצע את הפעולה.

regionCode

string

קוד האזור לפי תקן ISO 3166-1 alpha-2 של המשתמש שמבצע את הפעולה.

subdivisionCode

string

קוד אזור לפי תקן ISO 3166-2 (מדינות ומחוזות) במדינות של המשתמש שמבצע את הפעולה.

ResourceDetails

פרטים על מקור המידע שעליו בוצעה הפעולה.

ייצוג JSON
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string,
  "ownerDetails": {
    object (OwnerDetails)
  }
}
שדות
id

string

מזהה של המשאב, כמו doc_id למסמך ב-Drive,‏ conference_id לפגישה ב-Meet או gaia_id/rfc2822_message_id לאימייל.

title

string

שם המשאב. לדוגמה, במקרה של מסמך ב-Drive, זה יהיה שם המסמך. במקרה של אימייל, זה יהיה הנושא.

type

string

סוג המשאב – מסמך, אימייל, הודעה בצ'אט

appliedLabels[]

object (AppliedLabel)

activities.list of labels applied on the resource

relation

string

הגדרת הקשר שבין המשאב לאירועים

ownerDetails

object (OwnerDetails)

פרטי הבעלים של המשאב.

AppliedLabel

פרטים על התווית שהוחלה על המשאב.

ייצוג JSON
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
שדות
id

string

מזהה התווית – רק מזהה התווית, ולא השם המלא של המשאב ב-OnePlatform.

title

string

שם התווית

fieldValues[]

object (FieldValue)

activities.list of fields which are part of the label and have been set by the user. אם לתווית יש שדה שהמשתמש לא הגדיר, היא לא תופיע ברשימה הזו.

reason

object (Reason)

הסיבה להחלת התווית על המשאב.

FieldValue

פרטים על ערך השדה שהמשתמש הגדיר לתווית הספציפית.

ייצוג JSON
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
}
שדות
id

string

מזהה השדה

displayName

string

השם המוצג של השדה

type

string

סוג השדה

reason

object (Reason)

הסיבה להחלת השדה על התווית.

שדה איחוד value. הערכים שמאוחסנים בשדה value יכולים להיות רק אחד מהערכים הבאים:
unsetValue

boolean

אם השדה לא מוגדר, הערך יהיה true.

longTextValue

string

הגדרת ערך של טקסט ארוך.

textValue

string

הגדרת ערך טקסט.

textListValue

object (TextListValue)

הגדרת ערך של רשימת טקסט.

selectionValue

object (SelectionValue)

הגדרת ערך בחירה על ידי בחירת ערך יחיד מתוך תפריט נפתח.

selectionListValue

object (SelectionListValue)

הגדרת ערך של רשימת בחירה על ידי בחירת כמה ערכים מתוך תפריט נפתח.

integerValue

string (int64 format)

הגדרת ערך של מספר שלם.

userValue

object (UserValue)

הגדרת ערך משתמש על ידי בחירת משתמש יחיד.

userListValue

object (UserListValue)

הגדרת ערך של רשימת משתמשים על ידי בחירה של כמה משתמשים.

dateValue

object (Date)

הגדרת ערך תאריך.

TextListValue

הגדרת ערך של רשימת טקסט.

ייצוג JSON
{
  "values": [
    string
  ]
}
שדות
values[]

string

activities.list of text values.

SelectionValue

הגדרת ערך בחירה על ידי בחירת ערך יחיד מתוך תפריט נפתח.

ייצוג JSON
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
שדות
id

string

מזהה הבחירה.

displayName

string

השם המוצג של הבחירה.

badged

boolean

אם הבחירה מסומנת בתג.

SelectionListValue

הגדרת ערך של רשימת בחירה על ידי בחירת כמה ערכים מתוך תפריט נפתח.

ייצוג JSON
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
שדות
values[]

object (SelectionValue)

activities.list of selections.

UserValue

הגדרת ערך משתמש על ידי בחירת משתמש יחיד.

ייצוג JSON
{
  "email": string
}
שדות
email

string

כתובת האימייל של המשתמש.

UserListValue

הגדרת ערך של רשימת משתמשים על ידי בחירה של כמה משתמשים.

ייצוג JSON
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
שדות
values[]

object (UserValue)

activities.list of users.

תאריך

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

  • תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
  • חודש ויום, עם שנה אפס (לדוגמה, יום נישואין).
  • שנה לבד, עם חודש אפס ויום אפס.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך התפוגה של כרטיס אשראי).

סוגים קשורים:

ייצוג JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.

month

integer

החודש בשנה. הערך חייב להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום.

day

integer

יום בחודש. הערך חייב להיות בין 1 ל-31, והוא צריך להיות תקף לשנה ולחודש, או 0 כדי לציין רק שנה או שנה וחודש שבהם היום לא משמעותי.

סיבה

הסיבה להחלת התווית או השדה.

ייצוג JSON
{
  "reasonType": string
}
שדות
reasonType

string

סוג הסיבה.

OwnerDetails

פרטים על הבעלים של המשאב.

ייצוג JSON
{
  "ownerType": string,
  "ownerIdentity": [
    {
      object (OwnerIdentity)
    }
  ]
}
שדות
ownerType

string

סוג הבעלים של המשאב.

ownerIdentity[]

object (OwnerIdentity)

פרטי הזהות של הבעלים של המשאב.

OwnerIdentity

פרטי הזהות של הבעלים של המשאב.

ייצוג JSON
{

  "customerIdentity": {
    object (CustomerIdentity)
  },
  "userIdentity": {
    object (UserIdentity)
  },
  "groupIdentity": {
    object (GroupIdentity)
  },
  "sharedDriveIdentity": {
    object (SharedDriveIdentity)
  }
}
שדות
שדה איחוד identity. זהו שדה מסוג oneof, ואפשר להגדיר רק אחד מהשדות הבאים. הערך identity יכול להיות רק אחד מהבאים:
customerIdentity

object (CustomerIdentity)

הזהות של הלקוח ב-Google Workspace שהמשאב בבעלותו.

userIdentity

object (UserIdentity)

הזהות של המשתמש שהוא הבעלים של המשאב.

groupIdentity

object (GroupIdentity)

הזהות של הקבוצה שבבעלותה המשאב.

sharedDriveIdentity

object (SharedDriveIdentity)

הזהות של האחסון השיתופי שבבעלותו המשאב.

CustomerIdentity

הזהות של הלקוח ב-Google Workspace שהמשאב בבעלותו.

ייצוג JSON
{
  "id": string
}
שדות
id

string

מספר הלקוח.

UserIdentity

הזהות של המשתמש שהוא הבעלים של המשאב.

ייצוג JSON
{
  "id": string,
  "userEmail": string
}
שדות
id

string

מזהה GAIA של המשתמש.

userEmail

string

כתובת האימייל של המשתמש.

GroupIdentity

הזהות של הקבוצה שבבעלותה המשאב.

ייצוג JSON
{
  "id": string,
  "groupEmail": string
}
שדות
id

string

מזהה GAIA של הקבוצה.

groupEmail

string

כתובת אימייל קבוצתית.

SharedDriveIdentity

הזהות של האחסון השיתופי שבבעלותו המשאב.

ייצוג JSON
{
  "id": string,
  "sharedDriveName": string
}
שדות
id

string

מזהה GAIA של האחסון השיתופי.

sharedDriveName

string

השם של האחסון השיתופי.

UserDeviceInfo

פרטי המכשיר של המשתמש שמבצע את הפעולה.

ייצוג JSON
{
  "deviceId": string,
  "deviceType": string,
  "deviceOsVersion": string
}
שדות
deviceId

string

פלט בלבד. מזהה המכשיר של המשתמש.

deviceType

string

פלט בלבד. סוג המכשיר של המשתמש.

deviceOsVersion

string

פלט בלבד. גרסת מערכת ההפעלה במכשיר של המשתמש.