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

アクションの宣言で説明したように、ユーザーがアプリ内アクションを操作すると、アクションで宣言された 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 のサービスは、次の点を確認することをおすすめします。

すべての Action リクエストのユーザー エージェントは 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（リクエストのタイムアウト） しばらくしてから再試行します。

永続的なエラーの場合は、アクションが失敗したこと、およびメールに記載されている別の手順に沿っていただく必要があることをお客様に伝えます。

関連情報