מעקב אחר אימיילים

כדי להגדיר מעקב באימייל באמצעות ה-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.

דוגמה ליצירת צג חדש

הדוגמה משתמשת בפרמטרים הבאים:

• המשתמש לבדיקה הוא [e-mail].
• הערך בעמודה 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("[e-mail]", "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("[e-mail]", "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. בדוגמה הזו נעשה שימוש בפרמטרים הבאים:

• הכרטיס החדש: August 30, 2022, 23:20 hours, endDate.
• המחיר החדש של chatMonitorLevel הוא HEADER_ONLY.
• המשתמש שברצונך לערוך נשאר [e-mail].
• הערך 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("[e-mail]", "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("[e-mail]", "p@55w0rd");
MailMonitor monitorEntry = service.CreateMailMonitor("amal", monitor);

אחזור כל מעקבי האימייל של משתמש מקור

כדי לאחזר את כל המעקבים שמשויכים למשתמש מקור, יש להגיש בקשת HTTP GET ל-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 ריק.

דוגמה לאחזור כל הנתונים למעקב אחר אימייל

בדוגמה הזו מאחזרים את כל הצגים שנוצרו עבור המשתמש [e-mail]:

פרוטוקול

GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal

אם הפעולה בוצעה ללא שגיאות, השרת מחזיר קוד סטטוס 201 CREATED ופיד AtomPub עם רכיבי entry לשני מסכים, שמציגים את ההגדרות לשני משתמשי היעד ([e-mail], [e-mail]).

<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("[e-mail]", "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("[e-mail]", "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: הבודק שמקבל את הודעות האימייל שעברו ביקורת.

דוגמה למחיקת מעקב אחר אימייל

בדוגמה הזו נמחקים המוניטורים שנוצרו עבור המשתמש [e-mail] עם 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("[e-mail]", "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("[e-mail]", "p@55w0rd");
service.DeleteMailMonitor("amal", "izumi");