如宣告動作所述,當使用者與應用程式內動作互動時,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:處理動作
服務應處理網址參數中指定的動作,以及從使用者收集的其他資訊。
使用者提供的其他資訊會位於要求的內容中,並使用 x-www-form-urlecoded 編碼進行編碼。這項資訊會在屬性中設定,屬性名稱會對應至 Action 的屬性。例如,ConfirmAction 具有 confirmed
屬性。
步驟 3:傳回回應代碼
服務成功處理並記錄動作後,應傳回回應碼 200 (OK)
。下列回應碼可用於錯誤情況:
回應代碼 | 實驗組 |
---|---|
400 (Bad Request) | Google 會將該動作設為失敗。 |
401 (未授權) | Google 會將該動作設為失敗。 |
404 (找不到) | Google 會將該動作設為失敗。 |
408 (要求逾時) | Google 稍後會再次嘗試。 |
如果永久失敗,Google 會告知使用者該動作失敗,並請使用者按照電子郵件中的其他操作說明進行。