アクションを宣言する

schema.org では、アクションは構造化データに対して実行できるアクティビティを表します。Gmail では複数のタイプの アクションがサポートされており、それぞれを同様の構造化 データで定義できます。

移動アクション

schema.org エンティティを使用してコンテンツにマークアップを追加すると、移動アクションを追加できます。たとえば、EmailMessage エンティティに ViewAction 移動リンクを設定するには、次の例のようにメールの potentialAction プロパティを設定します。

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "EmailMessage",
  "potentialAction": {
    "@type": "ViewAction",
    "target": "https://watch-movies.com/watch?movieId=abc123",
    "name": "Watch movie"
  },
  "description": "Watch the 'Avengers' movie online"
}
</script>

microdata

<div itemscope itemtype="http://schema.org/EmailMessage">
  <div itemprop="potentialAction" itemscope itemtype="http://schema.org/ViewAction">
    <link itemprop="target" href="https://watch-movies.com/watch?movieId=abc123"/>
    <meta itemprop="name" content="Watch movie"/>
  </div>
  <meta itemprop="description" content="Watch the 'Avengers' movie online"/>
</div>

メールでスキーマをサポートしていない他のメール クライアントでは、このマークアップは自動的に無視されます。

モバイル ディープリンク

移動アクションは、Android と iOS のモバイルアプリのコンテンツに直接リンクすることもできます。 Android および iOS。 アプリにディープリンクするには、次の例のように、android-app:// スキームと ios-app:// スキームでエンコードされた追加の target URL を含めます。

JSON-LD

"target": [
  "<web url>",
  "android-app://<android package name>/<scheme>/<host>/<path+query>",
  "ios-app://<App store ID>/<scheme>/<host><path+query>"
]

microdata

<link itemprop="target" href="<web url>"/>
<link itemprop="target" href="android-app://<android package name>/<scheme>/<host>/<path+query>"/>
<link itemprop="target" href="ios-app://<App store ID>/<scheme>/<host>/<path+query>"/>

前の EmailMessage の例を拡張します。

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "EmailMessage",
  "name": "Watch movie",
  ... information about the movie ...
  "potentialAction": {
    "@type": "ViewAction",
    "target": [
      "https://watch-movies.com/watch?movieId=abc123",
      "android-app://com.watchmovies.app/http/watch-movies.com/watch?movieId=abc123",
      "ios-app://12345/movieapp/watch-movies.com/watch?movieId=abc123"
    ]
  }
}
</script>

microdata

<div itemscope itemtype="http://schema.org/EmailMessage">
  <meta itemprop="name" content="Watch movie"/>
  ... information about the movie ...
  <div itemprop="potentialAction" itemscope itemtype="http://schema.org/ViewAction">
    <meta itemprop="target" content="https://watch-movies.com/watch?movieId=abc123"/>
    <meta itemprop="target" content="android-app://com.watchmovies.android/http/watch-movies.com/watch?movieId=abc123"/>
    <meta itemprop="target" content="ios-app://12345/movieapp/watch-movies.com/watch?movieId=abc123"/>
 </div>
</div>

ユーザーがアプリをインストールしていない場合、アクションによってユーザーは指定したウェブ URL に移動します。

アプリ内ユーザー行動

Gmail では、アプリ内ユーザー行動は別のウェブサイトにユーザーを移動させることなく、その場で処理されます。アプリ内ユーザー行動は 移動アクションと同様に宣言しますが、メール クライアント（Gmail など）がアクションをインラインで処理するのに役立つ追加情報を含めます。

target を使用してアクションを宣言する代わりに、適切な構成でアクションの HttpActionHandler を宣言します。

たとえば、ユーザーに承認、確認、または同意を求めるメールに確認ボタンを追加できます。ユーザーがボタンをクリックすると、Google はサービスに HTTP リクエストを送信し、確認を記録します。ユーザーが ConfirmAction を操作できるのは 1 回のみです。

次の例では、経費レポートに関するメールに 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>

有効期限切れのアクション

多くの場合、アクションは限られた期間のみ関連します。旅行の予約など、日付がわかっているエンティティに関連付けられたアクションは自動的に期限切れになります。旅行が終わると、Gmail にアクションは表示されなくなります。

アクションに有効期限を明示的に追加することもできます。たとえば、クーポンをクリップするアクションや特典コードを保存するアクションは、限られた期間のみ有効にできます。アクションが表示される期間を設定するには、アクションの startTime プロパティと endTime プロパティを設定します。

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "EmailMessage",
  "potentialAction": {
    "@type": "ConfirmAction",
    "name": "Save coupon",
    "handler":  {
       "@type": "HttpActionHandler",
       "url": "https://my-coupons.com/approve?couponId=abc123"
    },
    "startTime": "2015-06-01T12:00:00Z",
    "endTime": "2015-06-05T12:00:00Z"
  }
}
</script>

microdata

<div itemscope itemtype="http://schema.org/EmailMessage">
  <div itemprop="potentialAction" itemscope itemtype="http://schema.org/ConfirmAction">
    <meta itemprop="name" content="Save coupon"/>
    <div itemprop="handler" itemscope itemtype="http://schema.org/HttpActionHandler">
      <link itemprop="url" href="https://my-coupons.com/approve?couponId=abc123"/>
    </div>
    <meta itemprop="startTime" content="2015-06-01T12:00:00Z" />
    <meta itemprop="endTime" content="2015-06-05T12:00:00Z" />
  </div>
</div>

関連情報

アクションの詳細については、以下をご覧ください。