如「宣告動作」一文所述,當使用者與應用程式內動作互動時,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
的服務檢查:
- 使用次數受限的存取權杖 - 防止重送攻擊。
- 使用者代理程式 - 確保要求來自 Google。
- 不記名符記 - 確保要求來自 Google,且是服務的預期行為。
所有動作要求的 User-Agent 都是 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 會告知使用者動作失敗,並請使用者按照電子郵件中的替代說明操作。