Giám sát email

Để thiết lập tính năng giám sát email bằng API kiểm tra email, quản trị viên sẽ đặt phạm vi ngày để trình kiểm tra nhận được bản sao 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á màn hình tối đa mỗi ngày là 1.000 yêu cầu. Giới hạn này áp dụng theo từng miền và bao gồm tất cả yêu cầu mà quản trị viên bất kỳ đưa ra trong ngày.

Tình huống email được giám sát bao gồm 3 kiểu 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á màn hình giám sát email bằng cách sử dụng tài nguyên giám sát 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. Những thao tác này chỉ có thể được thực hiện trong miền mà quản trị viên thực thi quyề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. Bất kỳ quản trị viên miền nào 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 ở trong cùng 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à kiểm tra viên nhận được email đã kiểm tra.

    • Nhận bản sao ẩn (Bcc) của tất cả thư email đến và đi, bao gồm cả tệp đính kèm đến và đi, thư được chuyển tiếp và thư email gửi từ thiết bị di động.
    • Có thể chọn quản trị viên miền để 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 kiểm tra các email nháp đã lưu, kiểm tra các cuộc trò chuyện trên Hangouts đã lưu trữ với những người dùng khác có thể ở trong hoặc ngoài miền.
    • Mặc dù người dùng đích nhận được bản sao Bcc của thư, nhưng mối liên kết Bcc không hiển thị trong các tiêu đề thư (có thể truy cập trong tài khoản của người dùng nguồn).
    • Mỗi thông báo qua email đã kiểm tra sẽ được gửi tới người dùng đích dưới dạng một tệp đính kèm email. Và quản trị viên miền có thể định cấu hình các thông báo này thành nội dung email đầy đủ hoặc chỉ là tiêu đề thông báo.
    • Người dùng đích này phải có tài khoản email đang hoạt động trong miền được giám sát. Đây phải là 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. Đồng thời, 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 và người dùng này sẽ nhận được bản sao của tất cả email đã kiểm tra được gửi cho người dùng đích đầu tiên.
    • Quản trị viên miền tạo một 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 với một người dùng nguồn. Mỗi quá trình kiểm tra được thực hiện bằng một tài nguyên giám sát API. Khi sử dụng nhiều trình theo dõi API, người dùng đích đến có thể kiểm tra nhiều người dùng trong miền. Ngoài ra, bằng cách 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 trình theo dõi API bổ sung được tạo hoặc trình theo dõi API hiện có được cập nhật 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 có sẵn từ trước cho cặp này. Về cơ bản, đây là cách bạn cập nhật trình giám sát API. Để biết thêm thông tin về việc cập nhật màn hình, hãy xem Cập nhật màn hình email.

Tạo 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 kèm theo tài nguyên email giám sát:

POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME

Thay thế đoạn mã sau:

  • DOMAIN_NAME: tên miền Google Workspace, ví dụ: example.com.
  • SOURCE_USERNAME: tên người dùng bạn muốn theo dõi.

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ố dùng trong yêu cầu giám sát email, hãy xem phần Tài nguyên: monitor.

Ví dụ về cách tạo màn hình 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ột 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 tính năng giám sát email

Khi cập nhật một màn hình có cùng người dùng nguồn và người dùng đích, các chế độ cài đặt thuộc tính của trình giám sát 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 giám sát email, hãy gửi yêu cầu POST đến URI của nguồn cấp dữ liệu giám sát và thêm tiêu đề Authorization vào:

POST https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME

Thay thế đoạn mã 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 giám sát email mà bạn muốn cập nhật.

Ví dụ về cách cập nhật giám sát email

Ví dụ này cập nhật trình giám sát được tạo trong ví dụ về cách tạo dịch vụ giám sát 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 tham số sau:

  • endDate mới là August 30, 2022, 23:20 hours.
  • chatMonitorLevel đổi tên thành HEADER_ONLY.
  • Người dùng được kiểm tra vẫn là amal@example.com.
  • destUserName vẫn là izumi.

Các thuộc tính giám sát chưa được cập nhật sẽ chuyển về giá trị mặc định. Ví dụ: trong ví dụ này, các thuộc tính incomingEmailMonitorLeveloutgoingEmailMonitorLevel chuyển về FULL_MESSAGE, còn draftMonitorLevel chuyển về 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ột 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ẽ trở về 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 giám sát email của người dùng nguồn

Để truy xuất tất cả trình theo dõi được liên kết với người dùng nguồn, hãy thực hiện yêu cầu HTTP GET đến URI nguồn cấp dữ liệu giám sát, 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ế đoạn mã 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 giám sát email mà bạn muốn truy xuất.

Thao tác này không có tham số trong phần nội dung yêu cầu, vì vậy phần nội dung XML sẽ trống.

Ví dụ về cách truy xuất tất cả trình giám sát 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ột mã trạng thái 201 CREATED và một nguồn cấp dữ liệu AtomPub có các phần tử entry cho hai trình theo dõi hiển thị các chế độ cài đặt cho 2 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á giám sát email

Để xoá trình giám sát email, hãy gửi yêu cầu HTTP DELETE đến URI xoá của nguồn cấp dữ liệu giám sát và thêm tiêu đề Authorization vào:

DELETE https://apps-apis.google.com/a/feeds/compliance/audit/mail/monitor/DOMAIN_NAME/SOURCE_USERNAME/DESTINATION_USERNAME

Thay thế đoạn mã 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 giám sát email mà bạn muốn xoá.
  • DESTINATION_USERNAME: kiểm tra viên nhận được email đã kiểm tra.

Ví dụ về cách xoá thiết bị giám sát email

Ví dụ này sẽ xoá các màn hình được tạo cho người dùng amal@example.com với destinationUserName dưới dạng 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");