处理操作请求

声明操作中所述,当用户与 应用内操作互动时,Google 会向操作中声明的网址发送 HTTP 请求。

以下示例向有关费用报告的电子邮件添加了一个 ConfirmAction 按钮:

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "EmailMessage",
  "potentialAction": {
    "@type": "ConfirmAction",
    "name": "Approve Expense",
    "handler": {
      "@type": "HttpActionHandler",
      "url": "https://myexpenses.com/approve?expenseId=abc123"
    }
  },
  "description": "Approval request for John's $10.13 expense for office supplies"
}
</script>

微数据

<div itemscope itemtype="http://schema.org/EmailMessage">
  <div itemprop="potentialAction" itemscope itemtype="http://schema.org/ConfirmAction">
    <meta itemprop="name" content="Approve Expense"/>
    <div itemprop="handler" itemscope itemtype="http://schema.org/HttpActionHandler">
      <link itemprop="url" href="https://myexpenses.com/approve?expenseId=abc123"/>
    </div>
  </div>
  <meta itemprop="description" content="Approval request for John's $10.13 expense for office supplies"/>
</div>

当用户点击该按钮时,Google 会向您的服务发送 HTTP 请求,以记录确认信息。您的服务会收到来自 Google 的以下 HTTP 请求:

POST /approve?expenseId=abc123 HTTP/1.1
Host: your-domain.com
Authorization: Bearer AbCdEf123456
Content-Type: application/x-www-form-urlencoded
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/1.0 (KHTML, like Gecko; Gmail Actions)

confirmed=Approved

本页的其余部分介绍了 https://your-domain.com/approve?expenseId=abc123 处的服务需要执行哪些操作才能正确处理该操作。其中包括:

  • 验证请求
  • 处理载荷
  • 返回响应代码

第 1 步:验证请求

我们建议 https://your-domain.com/approve?expenseId=abc123 处的服务验证以下各项:

所有操作请求的用户代理均为 Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/1.0 (KHTML, like Gecko; Gmail Actions)

如果所有检查都通过,该服务可以继续执行下一步。

第 2 步:处理操作

该服务应按照网址参数中的规定处理操作,以及从用户处收集的其他信息。

来自用户的其他信息位于请求正文中,并使用 x-www-form-urlencoded 格式进行编码。这些信息设置在名称与操作的属性对应的属性中。例如, ConfirmAction 具有 属性 confirmed

第 3 步:返回响应代码

服务成功处理并记录操作后,返回响应代码 200 (OK)。在错误情况下,您可以使用以下响应代码:

响应代码 实验组
400 (Bad Request) Google 将该操作标记为失败。
401 (Unauthorized) Google 将该操作标记为失败。
404(找不到) Google 将该操作标记为失败。
408 (Request Timeout) Google 会稍后重试。

对于永久性失败,Google 会通知用户该操作失败,并告知用户应按照电子邮件中的替代说明操作。

深入阅读