アクション リクエストを処理する

アクションの宣言で説明したように、ユーザーがアプリ内アクションを操作すると、Google はアクションで宣言された URL に 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>

microdata

<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: アクションを処理する

サービスは、URL パラメータで指定されたアクションと、ユーザーから収集された追加情報を処理する必要があります。

ユーザーからの追加情報はリクエストの本文にあり、x-www-form-urlecoded エンコードを使用してエンコードされます。この情報は、名前が Action のプロパティに対応するプロパティに設定されます。たとえば、ConfirmAction には confirmed プロパティがあります。

ステップ 3: レスポンス コードを返す

サービスがアクションを正常に処理して記録したら、レスポンス コード 200 (OK) を返す必要があります。エラーが発生した場合は、次のレスポンス コードを使用できます。

レスポンス コード 対応
400（不正なリクエスト） Google はアクションを失敗させます。
401（未承認） Google はアクションを失敗させます。
404（ファイル未検出） Google はアクションを失敗させます。
408（リクエスト タイムアウト） Google は後で再試行します。

永続的な失敗の場合、Google はお客様にアクションが失敗したことと、メール内の代替手順に沿って対応していただく必要があることを伝えます。

関連情報