Để thiết lập tính năng giám sát email bằng Email Audit API, quản trị viên sẽ đặt một phạm vi ngày để người kiểm tra nhận được bản sao của email đã gửi và nhận của một người dùng cụ thể dưới dạng tệp đính kèm. Số lượng yêu cầu tạo và xoá trình theo dõi tối đa mỗi ngày là 1.000 yêu cầu. Giới hạn này là trên mỗi miền và bao gồm tất cả các yêu cầu do bất kỳ quản trị viên nào đưa ra trong ngày.
Một trường hợp email được theo dõi bao gồm 3 loại người dùng:
Quản trị viên – Mọi quản trị viên miền đều có thể tạo, truy xuất, cập nhật và xoá trình theo dõi email bằng tài nguyên trình theo dõi của API Kiểm tra email. Ngoài ra, quản trị viên có thể sử dụng API để tải hộp thư xuống. Bạn chỉ có thể thực hiện các thao tác này trong miền mà quản trị viên kiểm soát.
Người dùng nguồn — Người dùng nguồn là người dùng nhận hoặc gửi thông báo đang được người dùng đích giám sát kiểm tra. Mọi quản trị viên miền hoặc người dùng tài khoản đều có thể là người dùng nguồn. Người dùng nguồn phải thuộc cùng một miền với quản trị viên và người dùng đích.
Người dùng đích — Người dùng đích là người kiểm tra nhận được các email đã được kiểm tra.
- Nhận bản sao ẩn (Bcc) của tất cả email đến và đi, bao gồm cả tệp đính kèm đến và đi, thư chuyển tiếp và email được gửi từ thiết bị di động.
- Quản trị viên miền có thể bật các tính năng kiểm tra bổ sung cho người dùng đích. Các tính năng không bắt buộc bao gồm việc kiểm tra bản nháp email đã lưu, kiểm tra các cuộc trò chuyện đã lưu trữ trên Hangouts với những người dùng khác có thể ở trong hoặc bên ngoài miền.
- Mặc dù người dùng đích nhận được bản sao Bcc của thư, nhưng liên kết Bcc sẽ không xuất hiện trong tiêu đề thư có thể truy cập trong tài khoản của người dùng nguồn.
- Mỗi thư email được kiểm tra sẽ được gửi đến người dùng đích dưới dạng tệp đính kèm email. Ngoài ra, quản trị viên miền có thể định cấu hình các thông báo này thành toàn bộ email hoặc chỉ tiêu đề email.
- Người dùng đích này phải có tài khoản email đang hoạt động trong miền được theo dõi. Đây phải là cùng một miền được liên kết với quản trị viên và người dùng nguồn.
- Người dùng đích có thể là quản trị viên hoặc người dùng trong miền. Ngoài ra, người dùng đích này có thể chuyển đổi vai trò để trở thành người dùng nguồn được một người dùng đích khác kiểm tra. Người dùng đích này sẽ nhận được bản sao của tất cả thư email đã kiểm tra được gửi đến người dùng đích đầu tiên.
- Quản trị viên miền tạo một trình giám sát email được kiểm tra cho một cặp "người dùng đích – người dùng nguồn" duy nhất. Nói cách khác, mối quan hệ kiểm tra là một người dùng đích đến với một người dùng nguồn. Mỗi quy trình kiểm tra được thực hiện bằng cách sử dụng tài nguyên trình theo dõi API. Khi sử dụng nhiều trình theo dõi API, người dùng đích có thể kiểm tra nhiều người dùng trong miền. Ngoài ra, khi sử dụng nhiều trình theo dõi API, nhiều người dùng đích có thể kiểm tra một người dùng nguồn.
- Nếu bạn tạo thêm một trình theo dõi API hoặc cập nhật một trình theo dõi API hiện có cho cặp "người dùng đích – người dùng nguồn", thì trình theo dõi được tạo gần đây nhất sẽ thay thế mọi trình theo dõi hiện có cho cặp này. Về cơ bản, đây là cách bạn cập nhật trình quan sát API. Để biết thêm thông tin về cách cập nhật trình theo dõi, hãy xem bài viết Cập nhật trình theo dõi email.
Tạo trình giám sát email
Để tạo trình giám sát email, hãy gửi yêu cầu POST
sau đây bằng tài nguyên trình giám sát email:
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
Thay thế nội dung sau:
DOMAIN_NAME
: tên miền Google Workspace, ví dụ: example.com.SOURCE_USERNAME
: tên người dùng mà bạn muốn giám sát.
Yêu cầu POST
chứa tiêu đề Content-type
sau:
Content-type: application/atom+xml
Để biết danh sách đầy đủ các thông số cần sử dụng trong yêu cầu theo dõi email, hãy xem phần Tài nguyên: monitor
.
Ví dụ về cách tạo một trình quan sát mới
Ví dụ này sử dụng các tham số sau:
- Người dùng cần được kiểm tra là
amal@example.com
. destUserName
mới làizumi
.beginDate
mới làJune 15, 2022, 00:00 hours
.endDate
mới làJune 30, 2022, 23:20 hours
.incomingEmailMonitorLevel
mới làFULL_MESSAGE
.outgoingEmailMonitorLevel
mới làHEADER_ONLY
.draftMonitorLevel
mới làFULL_MESSAGE
.chatMonitorLevel
mới làFULL_MESSAGE
.
Giao thức
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>
Nếu thành công, máy chủ sẽ trả về mã trạng thái 201 CREATED
và mục nhập AtomPub có phần tử entry
hiển thị các chế độ cài đặt màn hình mới:
<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);
Cập nhật trình giám sát email
Khi cập nhật một trình theo dõi có cùng người dùng nguồn và người dùng đích, chế độ cài đặt tài sản của trình theo dõi ban đầu sẽ được thay thế bằng chế độ cài đặt mới.
Để cập nhật cấu hình kiểm tra trong trình theo dõi email, hãy gửi yêu cầu POST
đến URI của nguồn cấp dữ liệu trình theo dõi và thêm tiêu đề Authorization
:
POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
Thay thế nội dung sau:
DOMAIN_NAME
: tên miền Google Workspace, ví dụ: example.com.SOURCE_USERNAME
: tên người dùng của trình theo dõi email mà bạn muốn cập nhật.
Ví dụ về cách cập nhật trình theo dõi email
Ví dụ này cập nhật trình theo dõi được tạo trong ví dụ về cách tạo trình theo dõi email bằng cách cập nhật thuộc tính bắt buộc endDate
và thuộc tính không bắt buộc chatMonitorLevel
. Ví dụ này sử dụng các thông số sau:
endDate
mới làAugust 30, 2022, 23:20 hours
.chatMonitorLevel
hiện làHEADER_ONLY
.- Người dùng cần được kiểm tra vẫn là
amal@example.com
. destUserName
vẫn làizumi
.
Các thuộc tính màn hình không được cập nhật sẽ được chuyển về giá trị mặc định. Ví dụ: trong ví dụ này, các thuộc tính incomingEmailMonitorLevel
và outgoingEmailMonitorLevel
sẽ quay lại FULL_MESSAGE
và draftMonitorLevel
sẽ quay lại NONE
.
Giao thức
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>
Nếu thành công, máy chủ sẽ trả về mã trạng thái 201 CREATED
và mục nhập AtomPub có các phần tử entry
đã cập nhật. Các thuộc tính không được cập nhật và hiển thị trong phản hồi sẽ quay lại giá trị mặc định.
<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);
Truy xuất tất cả trình theo dõi email của một người dùng nguồn
Để truy xuất tất cả màn hình được liên kết với một người dùng nguồn, hãy tạo một yêu cầu GET
HTTP đến URI nguồn cấp dữ liệu màn hình, sử dụng định dạng UTC cho ngày và thêm tiêu đề Authorization
:
GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME
Thay thế nội dung sau:
DOMAIN_NAME
: tên miền Google Workspace, ví dụ: example.com.SOURCE_USERNAME
: tên người dùng của trình theo dõi email mà bạn muốn truy xuất.
Thao tác này không có tham số nào trong phần nội dung yêu cầu, do đó phần nội dung XML sẽ trống.
Ví dụ về cách truy xuất tất cả trình theo dõi email
Ví dụ này truy xuất tất cả màn hình được tạo cho người dùng amal@example.com
:
Giao thức
GET https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/example.com/amal
Nếu thành công, máy chủ sẽ trả về mã trạng thái 201 CREATED
và nguồn cấp dữ liệu AtomPub có các phần tử entry
cho hai màn hình hiển thị chế độ cài đặt cho hai người dùng đích (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");
Xoá trình giám sát email
Để xoá một trình giám sát email, hãy tạo một yêu cầu DELETE
HTTP đến URI xoá của nguồn cấp dữ liệu trình giám sát và thêm tiêu đề Authorization
:
DELETE https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME/DESTINATION_USERNAME
Thay thế nội dung sau:
DOMAIN_NAME
: tên miền Google Workspace, ví dụ: example.com.SOURCE_USERNAME
: tên người dùng của trình theo dõi email mà bạn muốn xoá.DESTINATION_USERNAME
: người kiểm tra nhận được các email được kiểm tra.
Ví dụ về cách xoá trình giám sát email
Ví dụ này xoá các màn hình được tạo cho người dùng amal@example.com
với destinationUserName
là izumi
.
Giao thức
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");