Wie unter Aktionen deklarieren beschrieben, sendet Google eine HTTP-Anfrage an eine URL, die in der Aktion deklariert ist, wenn ein Nutzer mit einer In-App-Aktion interagiert.
Im folgenden Beispiel wird einer E-Mail zu einem Spesenbericht ein ConfirmAction-Button hinzugefügt:
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>
Mikrodaten
<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>
Wenn der Nutzer auf den Button klickt, sendet Google eine HTTP-Anfrage an Ihren Dienst und zeichnet die Bestätigung auf. Ihr Dienst erhält die folgende HTTP-Anfrage von Google:
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
Auf dieser Seite wird beschrieben, was der Dienst unter https://your-domain.com/approve?expenseId=abc123 tun muss, um die Aktion ordnungsgemäß zu verarbeiten. Dazu zählen:
- Anfrage überprüfen
- Nutzlast verarbeiten
- Antwortcode zurückgeben
Schritt 1: Anfrage überprüfen
Wir empfehlen, dass der Dienst unter https://your-domain.com/approve?expenseId=abc123 Folgendes überprüft:
- Zugriffstokens mit beschränkter Nutzung: Schutz vor Replay Angriffen
- User-Agent: Sicherstellen, dass die Anfrage von Google stammt.
- Bearer-Tokens: Sicherstellen, dass die Anfrage von Google für den Dienst bestimmt ist
Der User-Agent für alle Aktionsanfragen ist Mozilla/5.0 (X11; Linux x86_64)
AppleWebKit/1.0 (KHTML, like Gecko; Gmail Actions).
Wenn alle Prüfungen erfolgreich sind, kann der Dienst mit dem nächsten Schritt fortfahren.
Schritt 2: Aktion verarbeiten
Der Dienst sollte die Aktion gemäß den URL-Parametern sowie zusätzlichen Informationen verarbeiten, die vom Nutzer erhoben wurden.
Zusätzliche Informationen vom Nutzer befinden sich im Anfragehauptteil und sind codiert im x-www-form-urlencoded. Die Informationen werden in Eigenschaften festgelegt, deren Namen den Eigenschaften der Aktion entsprechen. ConfirmAction
Schritt 3: Antwortcode zurückgeben
Nachdem der Dienst die Aktion erfolgreich verarbeitet und aufgezeichnet hat, geben Sie den Antwortcode 200 (OK) zurück. In Fehlersituationen können Sie die folgenden Antwortcodes verwenden:
| Antwortcode | Testgruppe |
|---|---|
| 400 (Bad Request) | Google markiert die Aktion als fehlgeschlagen. |
| 401 (Unauthorized) | Google markiert die Aktion als fehlgeschlagen. |
| 404 (Not Found) | Google markiert die Aktion als fehlgeschlagen. |
| 408 (Request Timeout) | Google versucht es später noch einmal. |
Bei dauerhaften Fehlern informiert Google den Nutzer darüber, dass die Aktion fehlgeschlagen ist, und gibt alternative Anweisungen in der E-Mail.