アクションを宣言する

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

定番のアクション

schema.org エンティティを使用してコンテンツにマークアップを追加する場合は、そのマークアップ用の Go-To アクションを追加できます。たとえば、EmailMessage エンティティに ViewAction Go-To リンクを指定するには、メールの 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>

上記のマークアップは、メールのスキーマをサポートしていない他のメール クライアントでは自動的に無視されることに注意してください。

モバイルのディープリンク

Go-To アクションは、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://12345/movieapp/watch-movies.com/watch?movieId=abc123"/>
 </div>
</div>

ユーザーがアプリを持っていない場合は、指定されたウェブ URL にユーザーを誘導します。

アプリ内コンバージョンの数

アプリ内コンバージョンは、ユーザーを別のウェブサイトに誘導することなく、Gmail 内でその場で処理されます。アプリ内アクションは Go-To Actions と同様に宣言されていますが、ユーザー エージェント（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>

期限切れのアクション

多くの場合、アクションが関連するのは限られた期間だけです。日付がわかっているエンティティ（旅行の予約など）に関連付けられているアクションは自動的に期限切れになります。ルートが過ぎると、その操作は表示されません。

有効期限をアクションに明示的に追加することもできます。たとえば、クーポンのクリップや特典コードの保存といった操作は、限られた期間のみ有効です。アクションを表示する時間枠を設定するには、アクションの 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>

関連情報

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