- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- ApplicationName
- Activity
- NetworkInfo
- ResourceDetails
- AppliedLabel
- FieldValue
- TextListValue
- SelectionValue
- SelectionListValue
- UserValue
- UserListValue
- תאריך
- הסיבה
- כדאי לנסות!
מאחזר רשימה של פעילויות בחשבון ובאפליקציה ספציפיים של לקוח, כמו אפליקציית Google 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 |
מייצג את מזהה הפרופיל או את האימייל של המשתמש שלפיו צריך לסנן את הנתונים. יכול להיות |
applicationName |
שם האפליקציה שממנה רוצים לאחזר את האירועים. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
actorIpAddress |
כתובת פרוטוקול האינטרנט (IP) של המארח שבו בוצע האירוע. זו דרך נוספת לסנן את הסיכום של דוח לפי כתובת ה-IP של המשתמש שהפעילות שלו מדווחת. יכול להיות שכתובת ה-IP הזו תשקף את המיקום הפיזי של המשתמש, ויכול להיות שלא. לדוגמה, כתובת ה-IP יכולה להיות הכתובת של שרת ה-proxy של המשתמש או כתובת של רשת וירטואלית פרטית (VPN). הפרמטר הזה תומך בגרסאות של כתובות IPv4 ו-IPv6. |
customerId |
המזהה הייחודי של הלקוח שאליו רוצים לאחזר נתונים. |
endTime |
מגדיר את סוף טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. ערך ברירת המחדל הוא הזמן המשוער של בקשת ה-API. בדוח API יש שלושה מושגי זמן בסיסיים:
endTime , הדוח מחזיר את כל הפעילויות מ-startTime עד השעה הנוכחית, או מ-180 הימים האחרונים אם startTime חל לפני יותר מ-180 ימים. בבקשות שקשורות ל-Gmail, startTime ו-endTime חייבים להיות מצורפים, וההפרש ביניהם לא יכול להיות גדול מ-30 יום.
|
eventName |
שם האירוע שנשלח לגביו שאילתה באמצעות ה-API. כל |
filters |
מחרוזת השאילתה פרמטרים של אירועים כאלה משויכים ל בדוגמאות הבאות של פעילות ב-Drive, הרשימה שמוחזרת כוללת את כל האירועים מסוג
הערה: ה-API לא מקבל כמה ערכים של אותו פרמטר. אם פרמטר מסופק יותר מפעם אחת בבקשת ה-API, ה-API מקבל רק את הערך האחרון של הפרמטר הזה. בנוסף, אם בבקשת ה-API מצוין פרמטר לא תקין, ה-API מתעלם מהפרמטר הזה ומחזיר את התגובה שמתאימה לפרמטרים התקינים שנותרו. אם לא נשלחת בקשה לפרמטרים, כל הפרמטרים מוחזרים. |
maxResults |
קובע כמה רשומות של פעילות מוצגות בכל דף של תשובות. לדוגמה, אם הבקשה מגדירה |
orgUnitID |
המזהה של היחידה הארגונית שעליה רוצים לדווח. רשומות הפעילות יוצגו רק למשתמשים ששייכים ליחידה הארגונית שצוינה. |
pageToken |
הטוקן שמשמש לציון הדף הבא. דוח עם כמה דפים כולל את המאפיין |
startTime |
מגדיר את תחילת טווח הזמן שמוצג בדוח. התאריך הוא בפורמט RFC 3339, לדוגמה 2010-10-28T10:26:35.000Z. הדוח מחזיר את כל הפעילויות מ- |
groupIdFilter |
מזהי קבוצות (מוסתרים) מופרדים בפסיקים שפעילויות המשתמשים מסוננות לפיהם, כלומר התגובה תכיל פעילויות רק של משתמשים ששייכים לפחות לאחד ממזהי הקבוצות שמוזכרים כאן. פורמט: id:abc123,id:xyz456 |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
תבנית JSON לאוסף פעילויות.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
שדות | |
---|---|
kind |
סוג משאב ה-API. בדוח פעילות, הערך הוא |
etag |
ETag של המשאב. |
items[] |
כל רשומה של פעילות בתגובה. |
nextPageToken |
טוקן לאחזור הדף הבא של הדוח. הערך |
היקפי הרשאה
נדרש היקף ההרשאות הבא של 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 |
בדוחות הפעילות של אפליקציית האסימון מופיע מידע על החשבון לגבי סוגים שונים של אירועי פעילות של אסימונים. |
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. |
gemini_in_workspace_apps |
דוחות הפעילות ב-Gemini ל-Workspace מחזירים מידע על סוגים שונים של אירועי פעילות ב-Gemini שבוצעו על ידי משתמשים באפליקציית Workspace. |
classroom |
בדוחות הפעילות ב-Classroom מופיע מידע על סוגים שונים של אירועי פעילות ב-Classroom. |
פעילות
תבנית JSON למשאב הפעילות.
ייצוג ב-JSON |
---|
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object ( |
שדות | |
---|---|
kind |
סוג משאב ה-API. בדוח פעילות, הערך הוא |
etag |
ETag של הרשומה. |
ownerDomain |
זהו הדומיין שהושפע מהאירוע בדוח. לדוגמה, הדומיין של מסוף Admin או של הבעלים של המסמך באפליקציית Drive. |
ipAddress |
כתובת ה-IP של המשתמש שביצע את הפעולה. זוהי כתובת פרוטוקול האינטרנט (IP) של המשתמש בזמן הכניסה ל-Google Workspace, שיכולה לשקף את המיקום הפיזי של המשתמש או לא. לדוגמה, כתובת ה-IP יכולה להיות הכתובת של שרת ה-proxy של המשתמש או כתובת של רשת וירטואלית פרטית (VPN). ה-API תומך ב-IPv4 וב-IPv6. |
events[] |
אירועי פעילות בדוח. |
events[].type |
סוג האירוע. שירות או תכונה של Google Workspace שאדמין משנה מזוהים במאפיין |
events[].name |
שם האירוע. זהו השם הספציפי של הפעילות שדווחה על ידי ה-API. כל
מידע נוסף על מאפייני eventName זמין ברשימת שמות האירועים של אפליקציות שונות שמופיעה למעלה בקטע applicationName .
|
events[].parameters[] |
זוגות של ערכי פרמטרים לאפליקציות שונות. מידע נוסף על פרמטרים של |
events[].parameters[].messageValue |
צמדי ערכי פרמטרים מקוננים שמשויכים לפרמטר הזה. סוג ערך מורכב של פרמטר מוחזר כרשימה של ערכי פרמטרים. לדוגמה, לפרמטר של הכתובת יכול להיות ערך כמו |
events[].parameters[].messageValue.parameter[] |
ערכי פרמטרים |
events[].parameters[].name |
שם הפרמטר. |
events[].parameters[].value |
ערך המחרוזת של הפרמטר. |
events[].parameters[].multiValue[] |
ערכי המחרוזת של הפרמטר. |
events[].parameters[].intValue |
ערך הפרמטר כמספר שלם. |
events[].parameters[].multiIntValue[] |
ערכים שלמים של הפרמטר. |
events[].parameters[].boolValue |
הערך הבוליאני של הפרמטר. |
events[].parameters[].multiMessageValue[] |
activities.list of |
events[].parameters[].multiMessageValue[].parameter[] |
ערכי פרמטרים |
events[].resourceIds[] |
מזהי משאבים שמשויכים לאירוע. |
id |
מזהה ייחודי לכל רשומה של פעילות. |
id.time |
השעה שבה הפעילות התרחשה. הערך הזה הוא חותמת זמן של מערכת Unix בשניות. |
id.uniqueQualifier |
מזהה ייחודי אם לכמה אירועים יש את אותו זמן. |
id.applicationName |
שם האפליקציה שאליה משויך האירוע. רשימת הערכים האפשריים מופיעה למעלה בקטע |
id.customerId |
המזהה הייחודי של חשבון Google Workspace. |
actor |
המשתמש שמבצע את הפעולה. |
actor.profileId |
המזהה הייחודי של הפרופיל ב-Google Workspace של השחקן. יכול להיות שהערך הזה לא יופיע אם השחקן הוא לא משתמש Google Workspace, או שהוא יהיה המספר 105250506097979753968 שמשמש כמזהה placeholder. |
actor.email |
כתובת האימייל הראשית של המשתמש. יכול להיות שלא יופיע אם אין כתובת אימייל שמשויכת לשחקן. |
actor.callerType |
סוג המשתמש. |
actor.key |
מוצג רק אם הערך של |
actor.applicationInfo |
פרטים של האפליקציה שהייתה הגורם הפעיל בפעילות. |
actor.applicationInfo.oauthClientId |
מזהה הלקוח ב-OAuth של אפליקציית הצד השלישי ששימשה לביצוע הפעולה. |
actor.applicationInfo.applicationName |
שם האפליקציה שבה השתמשתם כדי לבצע את הפעולה. |
actor.applicationInfo.impersonation |
האם האפליקציה התחזתה למשתמש. |
networkInfo |
מידע על הרשת של המשתמש שמבצע את הפעולה. |
resourceDetails[] |
פרטים על המשאב שעליו בוצעה הפעולה. |
NetworkInfo
מידע על הרשת של המשתמש שמבצע את הפעולה.
ייצוג ב-JSON |
---|
{ "ipAsn": [ integer ], "regionCode": string, "subdivisionCode": string } |
שדות | |
---|---|
ipAsn[] |
כתובת ה-IP של המשתמש שביצע את הפעולה. |
regionCode |
קוד אזור לפי תקן ISO 3166-1 alpha-2 של המשתמש שמבצע את הפעולה. |
subdivisionCode |
קוד אזור לפי תקן ISO 3166-2 (מדינות ומחוזות) במדינות של המשתמש שמבצע את הפעולה. |
ResourceDetails
פרטים על המשאב שעליו בוצעה הפעולה.
ייצוג ב-JSON |
---|
{
"id": string,
"title": string,
"type": string,
"appliedLabels": [
{
object ( |
שדות | |
---|---|
id |
מזהה המשאב. |
title |
שם המשאב. לדוגמה, במקרה של מסמך ב-Drive, זה יהיה שם המסמך. במקרה של אימייל, זה יהיה הנושא. |
type |
סוג המשאב – מסמך, אימייל, הודעה בצ'אט |
appliedLabels[] |
activities.list of labels applied on the resource |
relation |
הגדרת הקשר בין המשאב לבין האירועים |
AppliedLabel
פרטים על התווית שהוחלה על המשאב.
ייצוג ב-JSON |
---|
{ "id": string, "title": string, "fieldValues": [ { object ( |
שדות | |
---|---|
id |
מזהה התווית – רק מזהה התווית, ולא שם המשאב המלא ב-OnePlatform. |
title |
שם התווית |
fieldValues[] |
activities.list of fields which are part of the label and have been set by the user. אם לתווית יש שדה שהמשתמש לא הגדיר, היא לא תופיע ברשימה הזו. |
reason |
הסיבה להחלת התווית על המשאב. |
FieldValue
פרטים על ערך השדה שהמשתמש הגדיר לתווית הספציפית.
ייצוג ב-JSON |
---|
{ "id": string, "displayName": string, "type": string, "reason": { object ( |
שדות | |
---|---|
id |
מזהה השדה |
displayName |
השם המוצג של השדה |
type |
סוג השדה |
reason |
הסיבה להחלת השדה על התווית. |
שדה איחוד value . הערכים שמאוחסנים בשדה value יכולים להיות רק אחד מהערכים הבאים: |
|
unsetValue |
אם השדה לא מוגדר, הערך יהיה true. |
longTextValue |
הגדרת ערך של טקסט ארוך. |
textValue |
הגדרת ערך טקסט. |
textListValue |
הגדרת ערך של רשימת טקסט. |
selectionValue |
הגדרת ערך בחירה על ידי בחירת ערך יחיד מתוך תפריט נפתח. |
selectionListValue |
הגדרת ערך של רשימת בחירה על ידי בחירת כמה ערכים מתוך תפריט נפתח. |
integerValue |
הגדרת ערך של מספר שלם. |
userValue |
הגדרת ערך משתמש על ידי בחירת משתמש יחיד. |
userListValue |
הגדרת ערך של רשימת משתמשים על ידי בחירה של כמה משתמשים. |
dateValue |
הגדרת ערך תאריך. |
TextListValue
הגדרת ערך של רשימת טקסט.
ייצוג ב-JSON |
---|
{ "values": [ string ] } |
שדות | |
---|---|
values[] |
activities.list of text values. |
SelectionValue
הגדרת ערך בחירה על ידי בחירת ערך יחיד מתוך תפריט נפתח.
ייצוג ב-JSON |
---|
{ "id": string, "displayName": string, "badged": boolean } |
שדות | |
---|---|
id |
המזהה של הבחירה. |
displayName |
השם המוצג של הבחירה. |
badged |
האם הבחירה מסומנת בתג. |
SelectionListValue
הגדרת ערך של רשימת בחירה על ידי בחירת כמה ערכים מתוך תפריט נפתח.
ייצוג ב-JSON |
---|
{
"values": [
{
object ( |
שדות | |
---|---|
values[] |
activities.list of selections. |
UserValue
הגדרת ערך משתמש על ידי בחירת משתמש יחיד.
ייצוג ב-JSON |
---|
{ "email": string } |
שדות | |
---|---|
email |
כתובת האימייל של המשתמש. |
UserListValue
הגדרת ערך של רשימת משתמשים על ידי בחירה של כמה משתמשים.
ייצוג ב-JSON |
---|
{
"values": [
{
object ( |
שדות | |
---|---|
values[] |
activities.list of users. |
תאריך
מייצג תאריך מלא או חלקי ביומן, כמו יום הולדת. השעה ביום ואזור הזמן צוינו במקום אחר או שהם לא משמעותיים. התאריך הוא ביחס ללוח השנה הגרגוריאני. הערך הזה יכול לייצג את אחת מהאפשרויות הבאות:
- תאריך מלא, עם ערכים שאינם אפס לשנה, לחודש וליום.
- חודש ויום, עם שנה אפסית (לדוגמה, יום נישואין).
- שנה לבד, עם חודש אפס ויום אפס.
- שנה וחודש, עם יום אפס (לדוגמה, תאריך התפוגה של כרטיס אשראי).
סוגים קשורים:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
ייצוג ב-JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
שדות | |
---|---|
year |
השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה. |
month |
החודש בשנה. הערך חייב להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום. |
day |
יום בחודש. הערך חייב להיות בין 1 ל-31, והוא צריך להיות תקף לשנה ולחודש, או 0 כדי לציין רק שנה או שנה וחודש שבהם היום לא משמעותי. |
סיבה
הסיבה להחלת התווית או השדה.
ייצוג ב-JSON |
---|
{ "reasonType": string } |
שדות | |
---|---|
reasonType |
סוג הסיבה. |