如「宣告動作」所述,當使用者與應用程式內動作互動時,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-urlecoded 編碼進行編碼。資訊設定在名稱與動作屬性相應的屬性中。舉例來說,ConfirmAction 標記為 confirmed
。
步驟 3:傳回回應代碼
服務處理及記錄動作之後,應會傳回回應代碼 200 (OK)
。以下回應代碼可用於出現錯誤情況:
回應代碼 | 治療方式 |
---|---|
400 (不正確的要求) | Google 會失敗這項操作。 |
401 (未授權) | Google 會失敗這項操作。 |
404 (找不到) | Google 會失敗這項操作。 |
408 (要求逾時) | Google 稍後會重試。 |
如果永久失敗,Google 會通知使用者操作失敗,並指出使用者應按照電子郵件中的替代指示操作。