如「宣告動作」所述,當使用者與應用程式內動作互動時,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 編碼加以編碼。這項資訊是在名稱與 Action 屬性相對應的屬性中設定。例如,ConfirmAction 具有 confirmed
屬性。
步驟 3:傳回回應代碼
服務順利處理並記錄動作後,應會傳回回應代碼 200 (OK)
。下列回應代碼可能用於錯誤情況:
回應代碼 | 實驗組 |
---|---|
400 (錯誤的要求) | Google 將無法執行這項動作。 |
401 (未授權) | Google 將無法執行這項動作。 |
404 (找不到) | Google 將無法執行這項動作。 |
408 (要求逾時) | Google 稍後會重試。 |
如果永久性錯誤,Google 會通知使用者操作失敗,請使用者按照電子郵件中的替代指示進行。