ウォッチ アクションの一般的なプロパティ

このセクションでは、ウォッチ アクションに関する一般的なプロパティの詳細について説明します。

アクション マークアップ プロパティ

プロパティ タイプ 説明
@type テキスト 必須 - 常に WatchAction に設定します。
target EntryPoint 必須 - ディープリンクをさまざまな Google プラットフォームにマッピングするためのターゲット オブジェクト
target.@type テキスト 必須 - 常に EntryPoint に設定します。
target.urlTemplate URL 必須 - アプリやプラットフォームにユーザーを誘導し、コンテンツの再生を開始するためのディープリンク
target.inLanguage テキスト 省略可 - シリーズの元の言語(BCP 47 形式)。
target.actionPlatform テキスト 必須 - urlTemplate にマッピングされるプラットフォーム。メディア アクションでは以下がサポートされます。
  • http://schema.org/DesktopWebPlatform: デスクトップ ウェブブラウザ上の検索プラットフォーム。
  • http://schema.org/MobileWebPlatform: モバイル ウェブブラウザ上の検索プラットフォーム。
  • http://schema.org/AndroidPlatform: Android アプリ上の検索および PlayGuide プラットフォーム。
  • http://schema.org/AndroidTVPlatform: Android TV アプリ上の Android TV プラットフォーム。
  • http://schema.org/IOSPlatform: iOS アプリ上の検索プラットフォーム。
  • http://schema.googleapis.com/GoogleVideoCast: Chromecast デバイス上の Cast および Home プラットフォーム。
  • http://schema.googleapis.com/GoogleAudioCast: Chromecast デバイス上の Cast および Home プラットフォーム(リッスン アクションのみ)。
要件については、プラットフォーム タイプをご覧ください。
target.additionalProperty PropertyValue 該当する場合は必須 - ディープリンクの追加プロパティを表す、プロパティと値のペアの一覧。たとえば、以下のような内容が含まれます。
  • contentLanguage: BCP 47 形式のブロードキャスト言語(吹替)。コンテンツが別の言語で吹き替えられている場合は、このプロパティは必須です。複数の言語コードは、配列を使用して指定します。
  • subtitleLanguage: 字幕の言語(BCP 47 形式)。複数の言語コードは、配列を使用して指定します。
  • cameraAngle: コンテンツのカメラ角度(「目の高さ」や「高角度」など)。複数のカメラ角度で使用可能なコンテンツの場合は、このプロパティは必須です。複数のカメラ角度は、配列を使用して指定します。
  • videoFormat: デジタル動画データを保存するためのファイル形式(標準画質の場合は「SD」、高解像度の場合は「HD」など)。有効な動画形式は、SD、HD、2K、4K、8K です。 複数の動画形式は、配列を使用して指定します。
additionalProperty の例をご覧ください。
actionAccessibilityRequirement ActionAccessSpecification 必須 - コンテンツのアクセス要件を説明するアクション アクセス指定オブジェクトアクション アクセス指定プロパティをご覧ください。

これらのプロパティに関連するトピックについては、次のページをご覧ください。

アクション アクセス指定プロパティ

プロパティ タイプ 説明
actionAccessibilityRequirement.@type テキスト 必須 - 常に ActionAccessSpecification に設定します。
actionAccessibilityRequirement.category テキスト

必須 - コンテンツのアクセス要件。詳細については、ペイウォールのタイプをご覧ください。

一群のコンテンツを表すエンティティの場合は、最も制限の緩やかなコンテンツ アクセス要件を category に設定する必要があります。たとえば、TVSeriesTVEpisode コンテンツがいくつかあり、そのうちの一部が nologinrequired に設定され、一部が subscription に設定されている場合は、この TVSeriesnologinrequired に設定します。

actionAccessibilityRequirement.availabilityStarts 日付

必須 - アクションが使用可能となる日付を ISO 8601 形式(タイムゾーンを含む)で指定します。

  • 将来の日付も設定できます。

対応するエンティティは、availabilityStarts 日の少なくとも 7 日前までにフィードで指定する必要があります。これにより、コンテンツが Google サーフェスに時間どおりに表示される可能性が高まります。

actionAccessibilityRequirement.availabilityEnds 日付 必須 - アクションが使用できなくなる日付を ISO 8601 形式(タイムゾーンを含む)で指定します。
  • availabilityStarts の 72 時間以上後の日付を指定します。
  • 公開後のコンテンツが常時利用可能である場合は、現在の日付から 20 年後の日付を設定します。

在庫終了日の更新は、在庫終了日の 7 日前までにフィードで行う必要があります。これにより、availabilityEnds の日付にコンテンツが Google サーフェスに表示されなくなる可能性が高まります。

actionAccessibilityRequirement.eligibleRegion CountryCityStateGeoShapeText 必須 - コンテンツが利用可能な地域。グローバルに利用可能なコンテンツの場合は、特殊文字列 EARTH を使用します。
actionAccessibilityRequirement.ineligibleRegion CountryCityStateGeoShape 必須(該当する場合) - コンテンツが制限されている地域。eligibleRegion 内のどこでもコンテンツが利用可能である場合は、このプロパティは不要です。
actionAccessibilityRequirement.requiresSubscription MediaSubscription

該当する場合は必須 - コンテンツにアクセスするためにユーザーに必要となる有料会員登録の詳細。メディアの有料会員登録プロパティをご覧ください。

  • categorysubscription または externalSubscription の場合は、このプロパティを指定します。
actionAccessibilityRequirement.expectsAcceptanceOf 特典 コンテンツの購入が必要な場合は必須 - コンテンツに関連付けられた特典の詳細。以下の場合の価格情報を指定します。
  • コンテンツの 1 回だけの購入(rental または purchase
  • 登録ユーザーは追加購入が必要となる、有料会員登録ベースのコンテンツ(subscription または externalsubscription)。
価格が 0.00 の場合は、Offer オブジェクトを完全に削除し、ActionAccessSpecification オブジェクトの categoryfree に設定します。特典のプロパティをご覧ください。

メディアの有料会員登録プロパティ

actionAccessibilityRequirement.categorysubscription または externalSubscription の場合は必須です。

プロパティ タイプ 説明
requiresSubscription.@type テキスト 必須 - 常に MediaSubscription に設定します。
requiresSubscription.@id URL 必須 - 有料会員登録の一意の ID。異なる複数の有料会員登録からアクセス可能なコンテンツの場合は、個々の有料会員登録に一意の ID が必要です。
requiresSubscription.name テキスト 必須 - 有料会員登録の名前。次の点に注意してください。
  • 異なる複数の有料会員登録からアクセス可能なコンテンツの場合は、この名前がユーザー認証システムで使用されている名前と一致する必要があります。たとえば、ユーザーは「Package 1」という名前の有料会員登録に基づいてコンテンツにアクセスできますが、認証システムでは「PKG1a」という名前が使用されている場合は、「PKG1」を使用します。
  • TVE プロバイダであれば、これは TVE 認証システムに登録された認証システム名となります。TVE 認証システムに対してサービス名を一意に識別する文字列です。
requiresSubscription.sameAs URL 有料会員登録を説明するページ。
requiresSubscription.identifier テキスト categorysubscription で、commonTierfalse の場合に必須 - メディア カタログ内のコンテンツ グループへのアクセス権を表す、この定期購入の一意の文字列。
  • 識別子には、
    ドメイン名 + コロン(:)+ コンテンツへのアクセスレベルの構文を使用することをおすすめします。例: example.com:basic、example.com:premium、example.com:sports
  • Entitlement API を指定している場合、このプロパティは利用資格 ID と同じになります。
requiresSubscription.authenticator 組織 categoryexternalsubscription の場合に必須 - 外部プロバイダの認証システムの詳細を提供するコンテナ。
requiresSubscription.authenticator.@type テキスト categoryexternalsubscription の場合に必須 - 常に Organization に設定します。
requiresSubscription.authenticator.name テキスト categoryexternalsubscription の場合に必須 - 認証サービスの名前。TVE プロバイダの場合は「TVE」に設定します。
requiresSubscription.commonTier ブール値 該当する場合は必須 - カテゴリが定期購入に設定されている場合は必須です。commonTier の詳細については、共通階層の要件のドキュメントをご覧ください。

Entitlement API の要件

actionAccessibilityRequirement.categorysubscription または externalSubscription で、サブスクリプション サービスに複数のパッケージまたは階層が含まれている場合、またはアドオンがサポートされている場合は、利用資格 API が必要です。サブスクリプションが 1 つの階層で、カタログ内のすべてのコンテンツにアクセスできる場合は、この項目を含めないでください。

  • 会社 A は、サブスクリプション ユーザーに利用可能なすべてのコンテンツへのアクセスを提供する単一のサブスクリプション サービスを提供しています。利用資格識別子 / API は不要です。
  • 会社 B には、一部のコンテンツにアクセスできるベース サブスクリプションと、プレミアム コンテンツにアクセスできるプレミアム サブスクリプションがあります。利用資格 ID / API が必要です。
  • 会社 C は、一部のコンテンツにアクセスできるベース サブスクリプションと、サードパーティ コンテンツにアクセスできるアドオン パッケージを備えています。利用資格 ID / API が必要です。

これらのプロパティに関連するトピックについては、次のページを確認してください。

特典のプロパティ

プロパティ タイプ 説明
expectsAcceptanceOf.@type テキスト 必須 - 常に Offer に設定します。
expectsAcceptanceOf.price 数値 必須 - コンテンツの購入価格。価格は 0 以外の正の値にする必要があります。価格が 0.00 のエンティティの場合は、カテゴリを「無料」として指定してください。
expectsAcceptanceOf.priceCurrency テキスト 必須 - 価格の通貨(3 文字の ISO 4217 形式)。
expectsAcceptanceOf.seller 組織 コンテンツの購入を提供する組織。
expectsAcceptanceOf.seller.@type テキスト 常に Organization に設定します。
expectsAcceptanceOf.seller.name テキスト 販売者の名前。
expectsAcceptanceOf.seller.sameAs テキスト 販売者を識別するウェブページの URL(販売者のホームページなど)。

これらのプロパティに関連するトピックについては、次のページを確認してください。

識別子

メディア アクション フィードは、エンティティを明確に識別できるさまざまな ID を受け入れます。これらの ID は、フィード内のコンテンツと Google のデータベース内のコンテンツを照合するプロセスを加速させるのに役立ちます。これらの識別子のほとんどは、さまざまなエンティティ タイプの identifier プロパティを使用してフィードに追加できますが、EIDR には独自の代表プロパティがあります。これらについて、以下で説明します。

ID プロパティ

プロパティ タイプ 説明
identifier テキスト 強く推奨 - 特定のエンティティを一意に識別する識別子(通常は外部 ID)。複数の識別子を使用できます。

このプロパティは、すべての Watch Action エンティティ タイプで使用できます。

次の表に、使用可能な識別子と identifier プロパティのサブプロパティを示します。ウォッチ アクション フィードの例の識別子/EIDR の例をご覧ください。
プロパティ タイプ 説明
@type テキスト 必須 - 常に PropertyValue に設定します。
propertyID テキスト 必須 - 以下の ID タイプがサポートされます。
  • TMS_ROOT_ID: Gracenote(TMS)のルート ID(15829 など)。
  • 。これは、TMS_ID のみを使用する必要がある Organization エンティティと BroadcastService エンティティには適用されません。
  • TMS_ID: Gracenote(TMS)のバリアント ID(MV000398520000 など)。
  • WIKIDATA_ID: WikiData ID(Q134773 など)。
  • IMDB_ID: IMDB ID(tt0109830 など)。
  • OPTA_ID: OPTA スポーツ ID。
  • STATS_ID: STATS Perform ID。
  • VIP_TIMES_ID: 日本のタレントに関する Japan VIPTimes(日本タレント名鑑)ID。
  • DMA_ID: GeoShape オブジェクトで使用される、米国の指定マーケティング領域コード。
  • _PARTNER_ID_: このプロパティには「_PARTNER_ID_」という文字列を含める必要があります。値は、サービス プロバイダが内部または外部でエンティティを識別するために使用する一意の ID にする必要があります(例: 12345a5c604e2-e9e5-4ff3-b728-245799dc37f1)。
value テキスト 必須 - 指定した ID システムの値。

EIDR プロパティ

EIDR(Entertainment Identifier Registry の略)は、映画やテレビ番組など、幅広いメディア コンテンツに使用されるグローバルに一意の識別子システムです。識別システムは、識別子を最上位のタイトルや編集などに関連付けられたメタデータ レコードに解決します。次の表に、EIDR に関連付けられているプロパティとその用途を示します。

プロパティ タイプ 説明
titleEIDR テキスト 強く推奨 - EIDR(Entertainment Identifier Registry)ID は、映画やテレビの作品を最も一般的な抽象レベルで表します。

このプロパティは、TVSeriesTVSeasonTVEpisodeMovie エンティティの仕様ページで使用できます。

たとえば、「Ghostbusters」という映画の titleEIDR は「10.5240/7EC7-228A-510A-053E-CBB8-J」です。

ウォッチ アクション フィードの例のセクションの識別子/EIDR の例をご覧ください。
editEIDR テキスト 強く推奨 - EIDR(Entertainment Identifier Registry)ID は、映画やテレビ作品の特定の編集/エディションを表します。

このプロパティは、TVEpisode エンティティと Movie エンティティの仕様ページで使用できます。

たとえば、「Ghostbusters」という映画のタイトル EIDR が「10.5240/7EC7-228A-510A-053E-CBB8-J」の場合、いくつかの編集があります(「10.5240/1F2A-E1C5-680A-14C6-E76B-I」や「10.5240/8A35-3BEE-6497-5D12-9E4F-3」など)。

titleEIDR プロパティは、editEIDR が指定されている場合に必須です。

[Watch Actions] フィード例のセクションの識別子/EIDR の例をご覧ください。

コンテンツのレーティング機関

BroadcastService.contentRatingMovie.contentRatingTVSeries.contentRating には、この表の値を使用します。レーティング エージェンシーはレーティング値の前に追加する必要があります。例:

  • 米国で「R」のレーティングが付けられた映画の Movie.contentRating 値は「MPAA R」にする必要があります。
  • 米国で「TV-MA」のレーティングが付けられたテレビ シリーズの TVSeries.contentRating 値は「TV_PG TV-MA」にする必要があります。

テレビ レーティング機関 映画評価機関
アルバニア(AL) 利用不可 利用不可
アンゴラ(AO) 利用不可 CCE
アンティグア バーブーダ(AG) 利用不可 MPAA
アルゼンチン(AR) INCAA INCAA
アルメニア(AM) 利用不可 MKRF/ロシア
アルバ(AW) 利用不可 利用不可
オーストラリア(AU) ACB TV ACB Movies
オーストリア(AT) FSK FSK
アゼルバイジャン(AZ) 利用不可 MKRF/ロシア
バーレーン(BH) 利用不可 MPAA

GeoShape プロパティ

GeoShape オブジェクトには、以下のいずれかの種類のデータが含まれます。

プロパティ タイプ 説明
@id URL 必須 - 地域の識別子(URI 形式)。
@type テキスト 必須 - 常に GeoShape に設定します。
addressCountry テキスト 必須 - 2 文字の ISO 3166-1 alpha-2 国コード
postalCode テキスト 省略可 - 1 つ以上の郵便番号または FSA(郵便処理地域)コードのリスト。
identifier PropertyValue 省略可 - 指定マーケット エリア(DMA)ID。全員が同じテレビ チャンネルや番組を受信する米国内地域の識別子です。
identifier.@type テキスト 必須 - 常に PropertyValue に設定します。
identifier.propertyID テキスト 必須 - 常に DMA_ID に設定します。
identifier.value テキスト 必須 - 地域の DMA コード。

郵便番号のリストを含む GeoShape オブジェクトの例を以下に示します。

{
  "@type": "GeoShape",
  "@id": "http://example.com/area1",
  "addressCountry": "US",
  "postalCode": [
    "94118",
    "94119"
  ]
}

FSA(郵便番号の配送地域)と郵便番号の組み合わせを含む GeoShape オブジェクトの例を以下に示します。

{
  "@type": "GeoShape",
  "@id": "http://example.com/area2",
  "addressCountry": "CA",
  "postalCode": [
    "1A1",
    "K1A",
    "K1AOB1"
  ]
}

DMA ID を含む GeoShape オブジェクトの例を以下に示します。

{
  "@type": "GeoShape",
  "@id": "http://example.com/area3",
  "addressCountry": "US",
  "identifier": [
    {
      "@type": "PropertyValue",
      "propertyID": "DMA_ID",
      "value": "501"
    }
  ]
}