处理操作请求

声明 Action 中所述,当用户与应用内 Action 互动时,Google 会向 Action 中声明的网址发送 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 的服务检查以下内容:

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

如果所有检查均通过,服务便可继续执行后续步骤。

第 2 步:处理操作

服务应根据网址参数以及从用户收集的其他信息处理相应操作。

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

第 3 步:返回响应代码

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

响应代码 实验组
400 (Bad Request) Google 会拒绝执行此操作。
401 (Unauthorized) Google 会拒绝执行此操作。
404(找不到) Google 会拒绝执行此操作。
408 (Request Timeout) Google 稍后会重新尝试。

如果永久失败,Google 会告知用户操作失败,并要求用户按照电子邮件中的备用说明操作。

延伸阅读