观看操作常见属性

本部分详细介绍了观看操作的常见属性。

操作标记属性

属性 预期类型 说明
@type 文本 必需 - 始终设置为 WatchAction。
target EntryPoint 必需 - 目标对象，用于提供深层链接与各种 Google 平台之间的映射。
target.@type 文本 必需 - 始终设置为 EntryPoint。
target.urlTemplate 网址 必需 - 深层链接，用于将用户定向到您的应用或平台并启动内容播放。
target.inLanguage 文本 可选 - 系列图书的原始语言，采用 BCP 47 格式。
target.actionPlatform 文本 必填 - 映射到 urlTemplate 的平台。媒体 Action 支持以下操作：
  • 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 设备上的投屏和 Home 平台。
  • http://schema.googleapis.com/GoogleAudioCast：Chromecast 设备上的 Cast 和 Home 平台（仅限“Listen”操作）。
如需了解相关要求，请参阅平台类型部分。
target.additionalProperty PropertyValue 如果适用，则必填 - 用于表示深层链接的其他属性的属性值对列表。其中可能包括：
  • contentLanguage：播出语言（配音），采用 BCP 47 格式。如果内容是其他语言配音的，则此属性是必需的。使用数组来表示多个语言代码。
  • subtitleLanguage：字幕或字幕的语言，采用 BCP 47 格式。使用数组来表示多个语言代码。
  • cameraAngle：内容的摄像头角度；例如“平视”和“高角度”。如果内容有不同的摄像头角度，则此属性是必需的。使用数组来表示多个摄像头角度。
  • videoFormat：用于存储数字视频数据的文件格式；例如，“SD”表示标清，“HD”表示高清。有效的视频格式包括标清、高清、2K、4K 和 8K。 使用数组来处理多种视频格式。
请参阅 additionalProperty 示例。
actionAccessibilityRequirement ActionAccessSpecification 必需 - Action 访问权限规范对象，用于描述内容的访问权限要求。请参阅Action 访问权限规范属性。

如需了解与这些媒体资源相关的主题，请参阅以下页面：

操作访问权限规范属性

属性 预期类型 说明
actionAccessibilityRequirement.@type 文本 必需 - 始终设置为 ActionAccessSpecification。
actionAccessibilityRequirement.category 文本

必需 - 内容的访问权限要求。如需了解详情，请参阅付费墙类型。

如果实体代表一组内容，您需要将 category 设置为其内容的最低限制性访问权限要求。例如，如果某个 TVSeries 的部分 TVEpisode 内容设置为 nologinrequired，而部分内容设置为 subscription，请将此 TVSeries 设置为 nologinrequired。
actionAccessibilityRequirement.availabilityStarts 日期

必填 - 相应操作可供使用的日期，采用 ISO 8601 格式（包括时区）。

  • 日期可以设为未来的日期。

必须在相应实体上架日期的至少 7 天前在 Feed 中提供相应实体。这样可以提高内容在 Google 平台上准时展示的几率。

actionAccessibilityRequirement.availabilityEnds 日期 必填 - 操作的失效日期，采用 ISO 8601 格式（包括时区）。
  • 必须等于或大于 availabilityStarts 后的 72 小时。
  • 如果内容在发布后始终可用，请将此日期设置为距离当前日期 20 年。

必须在 availabilityEnds 日期之前至少 7 天在 Feed 中更新 availabilityEnds 日期。这样可以提高内容在 availabilityEnds 日期停止在 Google 平台上展示的几率。

actionAccessibilityRequirement.eligibleRegion 国家/地区、城市、州/省/直辖市、GeoShape或文本 必填 - 内容的适用地区。如果内容面向全球发布，请使用特殊字符串 EARTH。
actionAccessibilityRequirement.ineligibleRegion 国家/地区、城市、州/省/直辖市或 GeoShape （如果适用）必填 - 内容受限的地区。如果内容在 eligibleRegion 的所有国家/地区均可播放，则无需提供此属性。
actionAccessibilityRequirement.requiresSubscription MediaSubscription

（如果适用）必填 - 用户访问内容所需的订阅详情。请参阅媒体订阅属性。

  • 如果 category 为 subscription 或 externalSubscription，请提供此属性。
actionAccessibilityRequirement.expectsAcceptanceOf 优惠 如果内容需要购买，则必需提供 - 与内容关联的优惠的详细信息。请提供以下情况的价格信息：
  • 一次性购买内容 (rental 或 purchase)
  • 需要订阅者额外购买的订阅内容（subscription 或 externalsubscription）
如果价格为 0.00，请完全移除 Offer 对象，并将 ActionAccessSpecification 对象中的 category 设置为 free。请参阅商品属性。

媒体订阅属性

如果 actionAccessibilityRequirement.category 为 subscription 或 externalSubscription，则必须提供此值。

属性 预期类型 说明
requiresSubscription.@type 文本 必需 - 始终设置为 MediaSubscription
requiresSubscription.@id 网址 必需 - 订阅的唯一 ID。如果内容可通过不同的订阅访问，则每个订阅都必须具有唯一 ID。
requiresSubscription.name 文本 必填 - 订阅的名称。请注意以下几点：
  • 如果用户可以通过不同的订阅访问内容，此名称需要与用户身份验证系统中的名称一致。例如，如果用户可以根据名为 Package 1 的订阅访问内容，但身份验证系统使用名称 PKG1a，请使用 PKG1。
  • 对于 TVE 提供商，这是在 TVE 身份验证器中注册的身份验证器名称。这是一个字符串，用于在 TVE 身份验证器中唯一标识您的服务名称。
requiresSubscription.sameAs 网址 用于描述订阅的页面。
requiresSubscription.identifier 文本 如果 category 为 subscription 且 commonTier 为 false，则必需 - 此订阅的唯一字符串，表示对媒体目录中一组内容的访问权限。
  • Google 建议您使用以下语法来设置标识符：
    域名 + 英文冒号 (:) + 内容访问权限级别，示例：example.com:basic、example.com:premium、example.com:sports
  • 如果您提供的是使用权 API，则此属性将与您的使用权标识符相同
requiresSubscription.authenticator 组织 如果 category 为 externalsubscription，则必需：一个容器，用于提供外部提供程序身份验证器的详细信息。
requiresSubscription.authenticator.@type 文本 如果 category 为 externalsubscription，则为必需 - 始终设置为 Organization。
requiresSubscription.authenticator.name 文本 如果 category 为 externalsubscription，则必需：身份验证服务的名称。对于 TVE 提供商，请将其设置为 TVE
requiresSubscription.commonTier 布尔值 必填（如果适用） - 如果类别设置为“订阅”，则此字段为必填字段。如需详细了解 commonTier，请参阅常规层级要求文档。

Entitlements API 要求

如果 actionAccessibilityRequirement.category 为 subscription 或 externalSubscription，并且您的订阅产品/服务包含多个套餐或层级，或者支持插件，则必须使用使用权 API。如果您的订阅只有一个层级，并且可访问目录中的所有内容，请勿添加此字段。

  • 公司 A 提供单一订阅方案，订阅者可以通过该方案访问所有可用内容：无需使用使用权标识符 / API
  • 公司 B 提供基本订阅（可访问部分内容）和付费订阅（可访问付费内容）：使用权标识符 / API 是必需的
  • 公司 C 有一个基本订阅，可提供对部分内容的访问权限，以及可提供对第三方内容的访问权限的额外套餐：使用权标识符 / API 是必需的

如需了解与这些媒体资源相关的主题，请参阅以下页面：

优惠属性

属性 预期类型 说明
expectsAcceptanceOf.@type 文本 必需 - 始终设置为 Offer。
expectsAcceptanceOf.price 编号 必需 - 内容的购买价格。价格必须为非零正值。对于价格为 0.00 的实体，请将类别指定为“免费”。
expectsAcceptanceOf.priceCurrency 文本 必需 - 价格所用币种，采用由 3 个字母表示的 ISO 4217 格式。
expectsAcceptanceOf.seller 组织 提供内容购买服务的组织。
expectsAcceptanceOf.seller.@type 文本 始终设置为 Organization。
expectsAcceptanceOf.seller.name 文本 卖方的名称。
expectsAcceptanceOf.seller.sameAs 文本 用于标识卖方的网页的网址；例如，卖方的首页。

与商品相关的页面

如需了解与这些媒体资源相关的主题，请参阅以下页面：

标识符

媒体行动 Feed 接受各种标识符，这些标识符有助于以明确的方式识别实体。这些标识符有助于加快 Feed 中的内容与 Google 数据库中的内容的匹配速度。虽然大多数此类标识符都可以使用各种实体类型的 identifier 属性添加到 Feed 中，但 EIDR 有自己的代表性属性。下文介绍了这两种类型的操作。

标识符属性

属性 预期类型 说明
identifier 文本 强烈建议 - 一个标识符（通常是外部标识符），用于明确标识给定实体。允许使用多个标识符。

此属性适用于所有观看操作实体类型。

下表列出了 identifier 属性接受的标识符和子属性。请参阅“观看操作”Feed 示例部分中的标识符/EIDR 示例。
属性 预期类型 说明
@type 文本 必需 - 始终设置为 PropertyValue。
propertyID 文本 必填 - 我们支持以下 ID 类型：
  • TMS_ROOT_ID：Gracenote (TMS) 根 ID（例如 15829）。
    • 。这不适用于 Organization 和 BroadcastService 实体，因为应仅使用 TMS_ID。
  • TMS_ID：Gracenote (TMS) 变体 ID（例如 MV000398520000）。
  • WIKIDATA_ID：WikiData ID（例如 Q134773）。
  • IMDB_ID：IMDB ID（例如 tt0109830）。
  • OPTA_ID：OPTA Sports ID。
  • STATS_ID：STATS 执行 ID。
  • VIP_TIMES_ID：日本艺人的 Japan VIPTimes (Nihon Tarento Meikan) ID。
  • DMA_ID：美国指定营销区域代码，用于 GeoShape 对象。
  • _PARTNER_ID_：此属性必须包含字符串“_PARTNER_ID_”，且值必须是服务提供商在内部或外部用于识别实体的唯一 ID（例如 12345 或 a5c604e2-e9e5-4ff3-b728-245799dc37f1）。
value 文本 必填 - 指定 ID 系统的值。

EIDR 属性

EIDR（娱乐内容标识注册的简称）是一种适用于各种媒体内容（包括电影和电视节目）的全局唯一标识符系统。识别系统会将标识符解析为与顶级影视内容、剪辑等相关联的元数据记录。下表列出了与 EIDR 关联的属性及其用途。

属性 预期类型 说明
titleEIDR 文本 强烈建议 - EIDR（娱乐业标识注册）标识符在最一般/抽象的层面上代表电影或电视作品。

TVSeries、TVSeason、TVEpisode 和 Movie 实体规范页面上提供了此属性。

例如，“Ghostbusters”这部动画的 titleEIDR 为“10.5240/7EC7-228A-510A-053E-CBB8-J”。

请参阅“Watch Actions”Feed 示例部分中的标识符/EIDR 示例。
editEIDR 文本 强烈建议 - EIDR（娱乐业标识注册）标识符代表影视作品的特定剪辑/版本。

此属性可在TVEpisode 和 Movie 实体规范页面上找到。

例如，名为“Ghostbusters”的动画片的 titleEIDR 为“10.5240/7EC7-228A-510A-053E-CBB8-J”，其中包含多个剪辑版本，例如“10.5240/1F2A-E1C5-680A-14C6-E76B-I”和“10.5240/8A35-3BEE-6497-5D12-9E4F-3”。

提供 editEIDR 时，titleEIDR 属性为必需属性。

请参阅“观看操作”Feed 示例部分中的标识符/EIDR 示例。

内容分级机构

请使用此表中的值作为 BroadcastService.contentRating、Movie.contentRating 和 TVSeries.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
12345…12

GeoShape 属性

GeoShape 对象包含以下数据类型之一：

属性 预期类型 说明
@id 网址 必需 - 地理区域的标识符，采用 URI 格式。
@type 文本 必需 - 始终设置为 GeoShape。
addressCountry 文本 必填 - 由 2 个字母组成的 ISO 3166-1 alpha-2 国家/地区代码。
postalCode 文本 可选 - 一个或多个邮政编码和/或 FSA（邮寄分拣区）代码的列表。
identifier PropertyValue 可选 - 特定媒体市场区域 (DMA) ID，是指美国境内人们可接收相同电视频道和节目的区域的标识符。
identifier.@type 文本 必需 - 始终设置为 PropertyValue。
identifier.propertyID 文本 必需 - 始终设置为 DMA_ID。
identifier.value 文本 必填 - 相应地区的特定媒体市场区域代码。

包含邮政编码列表的 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"
    }
  ]
}