用量限额和配额

限额和配额可保护 Google 的基础架构免受自动流程以不当方式使用 Email Audit API 所造成的影响。API 发出的请求过多可能是由于无害的拼写错误所致,也可能是由于低效系统进行不必要的 API 调用所致。无论是何种原因,您都应在来自特定来源的流量达到某一级别时阻止该流量,这是保证 Google Workspace 系统总体运行良好所必需的。限制有助于确保一个开发者的行为所造成的负面影响不会波及更大范围的开发者群体。

在极少数情况下,您的 API 请求会失败,此时您会收到 HTTP 状态代码响应。状态代码 403 包含有关输入不正确的错误信息,而 HTTP 状态代码 503 包含错误信息,指示哪些 API 配额已超出。通过这些响应,您的自定义应用可以检测到这些错误并采取适当的措施。

如果您的请求需要在固定时间内完成,请并行发送请求,或在 Java 或 C# 应用中使用多个线程。并行请求的一个示例是请求来自不同用户的少量电子邮件,而不是同时添加或移除来自一个用户的许多电子邮件。对于线程,请尝试从 10 个线程开始,每个用户电子邮件地址对应一个线程。请注意,线程建议有利有弊,并非适用于所有 API 情况。如果请求数量过高,就会出现配额错误。另一个权衡示例是 Email Audit API 的配额,用于限制总体消息上传速率。上传速率为每个用户每秒一个 API 请求,无论有多少个线程发出上传请求。

对于所有基于时间的错误(每个线程每 N 秒最多 N 个),尤其是 503 状态代码错误,我们建议您的代码捕获异常,并使用指数退避算法等待一小段时间,然后再重试失败的调用。一个线程的电子邮件审核 API 示例是等待 5 秒,然后重试失败的调用。如果请求成功,请针对其他线程重复此模式。如果第二次请求不成功,您的应用应减少请求频率,直到某次调用成功为止。例如,将初始 5 秒延迟时间增加到 10 秒,然后再次重试失败的调用。此外,还要确定重试限制。例如,在应用向用户返回错误之前,重试请求 5 到 7 次,每次重试使用不同的延迟时间。

下表列出了电子邮件审核 API 的限制:

API 限额类别 限制
加密的邮箱文件,创建

系统可能需要几天时间来准备加密的邮箱文件,具体取决于文件大小。

加密的邮箱文件,删除时出错

删除加密邮箱时发生错误,系统会为相应请求分配 MARKED_DELETE 状态。Google 会在 24 小时内再次自动删除这些摘要和导出文件(可能还会有剩余文件)。如果系统始终返回 MARKED_DELETE 状态,请尝试使用指数退避算法策略。

下表列出了电子邮件审核 API 的配额:

API 配额类别 配额
ClientLogin 身份验证令牌

有效期为 24 小时。错误为 401 token expired

日期格式

在使用电子邮件审核 API 之前,请将所有日期转换为世界协调时间 (UTC) 格式。如需了解详情,请参阅 UTC 转换器

加密的邮箱文件、EXPIRED摘要和导出文件

Google 会将加密的邮箱文件保留 3 周。之后,这些数据会被删除。网域管理员有责任在此时间段内下载这些邮箱文件。

加密的邮箱文件,格式

加密的邮箱文件采用 mbox 格式。

加密邮箱文件,最大创建请求数

每天最多可创建 100 个邮箱导出请求(网域中所有管理员的请求总数)。

加密邮箱文件状态,分页

请求所有邮箱请求的状态时,响应可能会返回大量数据。电子邮件审核 API 会将这些数据分批处理为多个页面,每个页面最多包含 100 个条目,并且 link rel='next'标记中的 URI 指向下一页结果。在开发客户端应用时,您的代码需要管理这些额外的结果。

电子邮件监控事件

每天的电子邮件监控请求数量上限为 1,500。此限制适用于网域,包括任何管理员在一天内发出的所有请求。

公钥

电子邮件审核 API 仅支持一个密钥。

公钥使用 GNU Privacy Guard (GPG) 软件。采用 PGP 格式,并且是 ASCII 编码的 RSA 加密密钥。在上传公钥之前,您必须先将其转换为 base64 编码的字符串。 公钥文件应使用字符集 US-ASCII(ASCII 的首选 IANA 字符集名称)读取。

正在搜索

searchQueryincludeDeleted 参数是互斥的。如果出现 includeDeleted="true",则无法进行搜索查询。