如声明操作中所述,当用户与应用内操作互动时,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
中的服务检查以下方面:
所有 Action 请求的用户代理均为 Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/1.0 (KHTML, like Gecko; Gmail Actions)
。
如果所有检查均通过,服务可以继续执行下一步。
第 2 步:处理 Action
服务应处理网址参数中指定的操作以及从用户那里收集的其他信息。
用户的其他信息位于请求正文中,且使用 x-www-form-urlecoded 编码进行编码。该信息是在名称与 Action 的属性对应的属性中设置的。例如,ConfirmAction 的属性为 confirmed
。
第 3 步:返回响应代码
服务成功处理并记录操作后,应返回响应代码 200 (OK)
。以下响应代码可用于出现错误的情况:
响应代码 | 实验组 |
---|---|
400 (Bad Request) | Google 将失败。 |
401 (Unauthorized) | Google 将失败。 |
404(找不到) | Google 将失败。 |
408(请求超时) | Google 稍后会再次重试。 |
如果发生永久性错误,Google 会告知用户操作失败,用户应按照电子邮件中的备选说明操作。