כדי להגדיר מעקב אחרי אימייל באמצעות Email Audit API, אדמין מגדיר טווח התאריכים שבו המבקר יקבל עותק של הודעות השגיאה שנשלחות קיבל הודעות אימייל כקובץ מצורף. המספר המקסימלי של יצירת צג ו המספר של בקשות מחיקה ביום הוא 1,000. מגבלה זו היא לכל דומיין, וכן הדוח כולל את כל הבקשות שנשלחו על ידי כל אדמין במהלך היום.
תרחיש של מעקב אחר אימייל כולל שלושה סוגי משתמשים:
מנהל מערכת — כל מנהל דומיין יכול ליצור, לאחזר, לעדכן וכן למחוק מעקב אחר אימייל באמצעות משאב המעקב של Email Audit API. לחשבון בנוסף, מנהל מערכת יכול להשתמש ב-API כדי להוריד את תיבת הדואר. האלה פעולות אפשריות רק בתוך הדומיין שבו מנהל המערכת שליטה בתרגילים.
משתמש מקור – משתמש המקור הוא המשתמש שמקבל או שולח הודעות שמבוקרים על ידי משתמש היעד למעקב. כל דומיין האדמין או משתמש בחשבון יכולים להיות משתמשי מקור. משתמש המקור חייב להיות באותו הדומיין של האדמין ושל משתמש היעד.
משתמש יעד — משתמש היעד הוא המבקר שמקבל את של הודעות אימייל מבוקרות.
- מקבל עותקים עיוורים של פליטת פחמן (עותק מוסתר) של כל הקבצים הנכנסים והודעות אימייל יוצאות, כולל קבצים מצורפים נכנסים ויוצאים, הודעות מועברות והודעות אימייל שנשלחות ממכשירים ניידים.
- כאפשרות, מנהל דומיין יכול להפעיל ביקורת נוספת תכונות של משתמש היעד. התכונות האופציונליות כוללות את ביקורת על טיוטות אימייל שמורות, ביקורת על צ'אטים ב-Hangouts שהועברו לארכיון עם משתמשים אחרים בתוך הדומיין או מחוצה לו.
- למרות שמשתמש היעד מקבל עותק מוסתר של ההודעה, השיוך 'עותק מוסתר' לא גלוי בכותרות של ההודעות שאפשר לגשת אליהן בחשבון של משתמש המקור.
- כל הודעת אימייל מבוקרת נשלחת למשתמש היעד קובץ מצורף לאימייל. ומנהל הדומיין יכול להגדיר את הודעות כהודעות אימייל מלאות או רק הודעות כותרות עליונות.
- למשתמש היעד הזה צריך להיות חשבון אימייל פעיל בדומיין שבמעקב. הדומיין צריך להיות זהה לדומיין שמשויך אל אדמין ומשתמש המקור.
- משתמש יעד יכול להיות אדמין או משתמש בדומיין. משתמש היעד הזה יכול גם להחליף תפקיד כדי להפוך למשתמש מקור מבוקרת על ידי משתמש יעד אחר, שבתורו, מקבל עותקים של כל הודעות האימייל המבוקרות שנשלחו למשתמש היעד הראשון.
- מנהל דומיין יוצר מעקב אחר אימייל מבוקר אחד לכל 'משתמש יעד – משתמש מקור' להתאים בין מכשירים. ובמילים אחרות, הבדיקה לקשר הוא משתמש יעד אחד למשתמש מקור אחד. כל ביקורת מתבצעת באמצעות משאב של מעקב API. באמצעות מספר צגים של API, משתמש יעד יכול לערוך ביקורת של משתמשים רבים בדומיין. ובעזרת מספר ניטורים של API, משתמשי יעד רבים יכולים לערוך ביקורת על משתמש מקור אחד.
- אם נוצר מעקב נוסף אחר API או אם קיים מעקב קיים של ה-API עודכן עבור 'משתמש יעד – משתמש מקור' צמדים, שהמסך האחרון שנוצר מחליף את כל המסכים הקיימים של הצמד הזה. בגדול, כך מעדכנים מעקב אחרי API. אפשר לקבל מידע נוסף על עדכון צג, עדכון מעקב אחר אימייל
יצירת מעקב אחר אימייל
כדי ליצור מעקב אחר אימייל, צריך לשלוח את בקשת POST
הבאה עם האימייל
מעקב אחר משאב:
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
מחליפים את מה שכתוב בשדות הבאים:
DOMAIN_NAME
: שם הדומיין של Google Workspace – עבור example.com.SOURCE_USERNAME
: שם המשתמש הרצוי לעקוב אחריהם.
הבקשה POST
מכילה את כותרת Content-type
הבאה:
Content-type: application/atom+xml
רשימה מלאה של הפרמטרים שבהם אפשר להשתמש בבקשה למעקב אחרי אימיילים זמינה בכתובת
מקורות מידע: monitor
.
דוגמה ליצירת מעקב חדש
בדוגמה נעשה שימוש בפרמטרים הבאים:
- המשתמש לבדיקה הוא
amal@example.com
. - הערך בעמודה
destUserName
הואizumi
. - הערך בעמודה
beginDate
הואJune 15, 2022, 00:00 hours
. - הערך בעמודה
endDate
הואJune 30, 2022, 23:20 hours
. - הערך בעמודה
incomingEmailMonitorLevel
הואFULL_MESSAGE
. - הערך בעמודה
outgoingEmailMonitorLevel
הואHEADER_ONLY
. - הערך בעמודה
draftMonitorLevel
הואFULL_MESSAGE
. - הערך בעמודה
chatMonitorLevel
הואFULL_MESSAGE
.
פרוטוקול
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal <atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <apps:property name='destUserName' value='izumi'/> <apps:property name='beginDate' value='2022-06-15 00:00'/> <apps:property name='endDate' value='2022-06-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='HEADER_ONLY'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </atom:entry>
אם הפעולה בוצעה ללא שגיאות, השרת יחזיר קוד סטטוס 201 CREATED
רשומת AtomPub עם הרכיב entry
שמציג מוניטור חדש
ההגדרות:
<entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/id</id> <updated>2022-04-17T15:02:45.646Z</updated/> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/id'/> <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/id'/> <apps:property name='destUserName' value='izumi'/> <apps:property name='beginDate' value='2022-06-15 00:00'/> <apps:property name='endDate' value='2022-06-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='HEADER_ONLY'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </entry>
Java
import java.util.Calendar; import com.google.gdata.client.appsforyourdomain.audit.AuditService; import com.google.gdata.data.appsforyourdomain.generic.GenericEntry; import com.google.gdata.client.appsforyourdomain.audit.MailMonitor; ... MailMonitor monitor = new MailMonitor(); Calendar beginDate = Calendar.getInstance(); beginDate.set(2022, Calendar.JUNE, 15, 0, 0) monitor.setBeginDate(beginDate.getTime()); Calendar endDate = Calendar.getInstance(); endDate.set(2022, Calendar.JUNE, 30, 23, 20); monitor.setEndDate(endDate.getTime()); monitor.setIncomingEmailMonitorLevel("FULL_MESSAGE"); monitor.setOutgoingEmailMonitorLevel("HEADER_ONLY"); monitor.setDraftMonitorLevel("FULL_MESSAGE"); monitor.setChatMonitorLevel("FULL_MESSAGE"); monitor.setDestUserName("izumi"); AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); GenericEntry entry = service.createMailMonitor("amal", monitor);
.NET
using System; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... MailMonitor monitor = new MailMonitor(); monitor.BeginDate = new DateTime(2022, 6, 15); monitor.EndDate = new DateTime(2022, 6, 30, 23, 20, 0); monitor.IncomingEmailMonitorLevel = MonitorLevel.FULL_MESSAGE; monitor.OutgoingEmailMonitorLevel = MonitorLevel.HEADER_ONLY; monitor.DraftMonitorLevel = MonitorLevel.FULL_MESSAGE; monitor.ChatMonitorLevel = MonitorLevel.FULL_MESSAGE; monitor.DestinationUserName = "izumi"; AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); MailMonitor monitorEntry = service.CreateMailMonitor("amal", monitor);
עדכון מעקב אחר אימייל
כשמעדכנים צג עם אותו משתמש מקור ואותו משתמש יעד, הגדרות הנכס של המעקב הראשוני יוחלפו בהגדרות החדשות.
כדי לעדכן את הגדרות הביקורת במעקב באימייל, צריך לשלוח בקשת POST
אל
ה-URI של פיד המעקב וכוללים את הכותרת Authorization
:
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
מחליפים את מה שכתוב בשדות הבאים:
DOMAIN_NAME
: שם הדומיין של Google Workspace – עבור example.com.SOURCE_USERNAME
: שם המשתמש במעקב אחר האימייל שרוצים לעדכן.
דוגמה לעדכון מעקב אחר אימייל
בדוגמה הזו מתעדכנים המעקב שנוצר
דוגמה ליצירת מעקב אחרי אימייל
על ידי עדכון המאפיין הנדרש endDate
והמאפיין האופציונלי
chatMonitorLevel
בדוגמה הזו נעשה שימוש בפרמטרים הבאים:
- השדה
endDate
החדש הואAugust 30, 2022, 23:20 hours
. - הערך בשדה
chatMonitorLevel
הואHEADER_ONLY
עכשיו. - המשתמש לבדיקה יישאר
amal@example.com
. - השדה
destUserName
נשארizumi
.
מאפייני המעקב שלא עודכנו חוזרים לערכי ברירת המחדל שלהם. עבור
למשל, בדוגמה הזו, incomingEmailMonitorLevel
הנכסים של outgoingEmailMonitorLevel
חוזרים לערך FULL_MESSAGE
,
draftMonitorLevel
חוזר/ת ל-NONE
.
פרוטוקול
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal <atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <apps:property name='destUserName' value='izumi'/> <apps:property name='endDate' value='2022-08-30 23:20'/> <apps:property name='chatMonitorLevel' value='HEADER_ONLY'/> </atom:entry>
אם הפעולה בוצעה ללא שגיאות, השרת יחזיר קוד סטטוס 201 CREATED
רשומת AtomPub עם רכיבי entry
המעודכנים. המאפיינים
שלא עודכנו ומוצגות בתשובה, חוזרים לערכי ברירת המחדל שלהם.
<entry> <entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi</id> <updated>2022-08-20T00:28:57.319Z</updated> <link rel='self' type='application/atom+xml' href="https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi" /> <link rel='edit' type='application/atom+xml' href="https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi" /> <apps:property name='chatMonitorLevel' value='HEADER_ONLY' /> <apps:property name='destUserName' value='izumi' /> <apps:property name='endDate' value='2022-08-30 23:20' /> </entry>
Java
import java.util.Calendar; import com.google.gdata.client.appsforyourdomain.audit.AuditService; import com.google.gdata.client.appsforyourdomain.audit.MailMonitor; import com.google.gdata.data.appsforyourdomain.generic.GenericEntry; ... MailMonitor monitor = new MailMonitor(); Calendar endDate = Calendar.getInstance(); endDate.set(2022, Calendar.AUGUST, 30, 23, 20); monitor.setEndDate(endDate.getTime()); monitor.setChatMonitorLevel("HEADER_ONLY"); monitor.setDestUserName("izumi"); AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); GenericEntry entry = service.createMailMonitor("amal", monitor);
.NET
using System; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... MailMonitor monitor = new MailMonitor(); monitor.EndDate = new DateTime(2022, 8, 30, 23, 20, 0); monitor.ChatMonitorLevel = MonitorLevel.HEADER_ONLY; monitor.DestinationUserName = "izumi"; AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); MailMonitor monitorEntry = service.CreateMailMonitor("amal", monitor);
אחזור כל המעקבים אחר אימייל של משתמש מקור
כדי לאחזר את כל צגי המחשב שמשויכים למשתמש המקור, צריך ליצור GET
מסוג HTTP
את הבקשה ל-URI של הפיד למעקב, תוך שימוש בפורמט UTC עבור התאריך, וכלול
הכותרת Authorization
:
GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
מחליפים את מה שכתוב בשדות הבאים:
DOMAIN_NAME
: שם הדומיין של Google Workspace – עבור example.com.SOURCE_USERNAME
: שם המשתמש במעקב אחר האימייל שרוצים לאחזר.
לפעולה זו אין פרמטרים בגוף הבקשה, ולכן גוף ה-XML ריק.
דוגמה לאחזור כל המעקבים אחר אימייל
הדוגמה הזו מאחזרת את כל צגי המחשב שנוצרו עבור המשתמש amal@example.com
:
פרוטוקול
GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal
אם הפעולה בוצעה ללא שגיאות, השרת יחזיר קוד סטטוס 201 CREATED
פיד AtomPub עם הרכיבים entry
בשביל שני צגים שמראים את
ההגדרות לשני משתמשי יעד (izumi@example.com,
taylor@example.com
).
<feed xmlns:atom='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:apps='http://schemas.google.com/apps/2006'> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal</id> <updated>2010-03-17T15:29:21.064Z</updated> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal'/> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal'/> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal'/> <openSearch:startIndex>1</openSearch:startIndex> <entry> <id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi</id> <updated>2022-04-17T15:29:21.064Z</updated> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi&'/> <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/feeds/compliance/audit/mail/monitor/example.com/amal/izumi&'/> <apps:property name='requestId' value='53156'/> <apps:property name='destUserName' value='izumi'/> <apps:property name='beginDate' value='2022-06-15 00:00'/> <apps:property name='endDate' value='2022-06-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </entry> <entry> <id>>https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/taylor</id> <updated>2022-05-17T15:29:21.064Z</updated> <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/taylor'/> <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/taylor'/> <apps:property name='requestId' value='22405'/> <apps:property name='destUserName' value='taylor'/> <apps:property name='beginDate' value='2022-06-20 00:00'/> <apps:property name='endDate' value='2022-07-30 23:20'/> <apps:property name='incomingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='outgoingEmailMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='draftMonitorLevel' value='FULL_MESSAGE'/> <apps:property name='chatMonitorLevel' value='FULL_MESSAGE'/> </entry> </feed>
Java
import com.google.gdata.client.appsforyourdomain.audit.AuditService; import com.google.gdata.data.appsforyourdomain.generic.GenericFeed; ... AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); GenericFeed feed = service.retrieveMonitors("amal");
.NET
using System; using System.Collections.Generic; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); GenericFeed<MailMonitor> monitors = service.RetrieveMailMonitors("amal");
מחיקת מעקב אחר אימייל
כדי למחוק מעקב אחר אימייל, צריך לשלוח בקשת HTTP DELETE
אל פיד המעקב
מחיקת ה-URI והוספת הכותרת Authorization
:
DELETE https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME/DESTINATION_USERNAME
מחליפים את מה שכתוב בשדות הבאים:
DOMAIN_NAME
: שם הדומיין של Google Workspace – עבור example.com.SOURCE_USERNAME
: שם המשתמש במעקב אחר האימייל שרוצים למחוק.DESTINATION_USERNAME
: המבקר שמקבל את של הודעות אימייל מבוקרות.
דוגמה למחיקת מעקב אחר אימייל
בדוגמה הזו נמחקים המעקבים שנוצרו עבור המשתמש amal@example.com
עם destinationUserName
בתור izumi
.
פרוטוקול
DELETE https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal/izumi
Java
import com.google.gdata.client.appsforyourdomain.audit.AuditService; ... AuditService service = new AuditService("admin@example.com", "p@55w0rd", "example.com", "example.com-auditapp-v1"); service.deleteMonitor("amal", "izumi");
.NET
using System; using Google.GData.Apps; using Google.GData.Extensions.Apps; ... AuditService service = new AuditService("example.com", "example.com-auditapp-v1"); service.setUserCredentials("admin@example.com", "p@55w0rd"); service.DeleteMailMonitor("amal", "izumi");