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

アクションの宣言で説明したとおり、ユーザーがアプリ内アクションを操作すると、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（不正なリクエスト） アクションは失敗します。
401（未承認） アクションは失敗します。
404（ファイル未検出） アクションは失敗します。
408（リクエストのタイムアウト） しばらくしてから再試行します。

エラーが発生しない場合は、操作が失敗したことと、メールに記載されている別の手順を行う必要があることがユーザーに表示されます。

関連情報

で確認できます。