观看操作常见属性

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

操作标记属性

属性 预期类型 说明
@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 设备上的 Cast 和 Home 平台。
  • http://schema.googleapis.com/GoogleAudioCast：Chromecast 设备上的 Cast 和 Home 平台（仅限“聆听”操作）。
如需了解相关要求，请参阅平台类型部分。
target.additionalProperty PropertyValue 如果适用，则为必需属性 - 用于表示深层链接的其他属性的属性-值对列表。这可能包括以下内容：
  • contentLanguage：广播语言（配音），采用 BCP 47 格式。如果内容配音为其他语言，则此属性为必需属性。使用数组表示多个语言代码。
  • subtitleLanguage：字幕或字幕的语言，采用 BCP 47 格式。使用数组表示多个语言代码。
  • cameraAngle：内容的拍摄角度；例如“平视”和“高角度”。如果内容以不同的拍摄角度呈现，则此属性是必需的。使用数组表示多个拍摄角度。
  • videoFormat：用于存储数字视频数据的文件格式；例如，“SD”表示标清，“HD”表示高清。有效视频格式包括标清、高清、2K、4K 和 8K。 使用数组表示多种视频格式。
  • audioDescriptionLanguage：支持音频描述的受支持音频语言数组，采用 BCP 47 格式。 这是 contentLanguage 数组的子集。
请参阅 additionalProperty 示例。
actionAccessibilityRequirement ActionAccessSpecification 必需 - 一个操作访问权限规范对象，用于描述内容的访问权限要求。请参阅操作访问权限规范属性。

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

操作访问权限规范属性

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

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

如果实体代表一组内容，您需要将 category 设置为相应内容的最宽松访问要求。例如，如果某个 TVSeries 的部分 TVEpisode 内容设置为 nologinrequired，另有部分设置为 subscription，则将此 TVSeries 设置为 nologinrequired。
actionAccessibilityRequirement.availabilityStarts 日期

必需 - 操作可用的日期，采用 ISO 8601 格式（包括时区）。

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

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

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

必须在 feed 中将 availabilityEnds 日期更新为至少比该日期提前 7 天。这样可以提高内容在 availabilityEnds 日期停止显示在 Google 平台上的几率。

actionAccessibilityRequirement.eligibleRegion Country、City、State、GeoShape 或 Text 必需 - 内容的上架地区。如果内容在全球范围内提供，请使用特殊字符串 EARTH。
actionAccessibilityRequirement.ineligibleRegion 国家/地区、城市、州/省或 GeoShape 如果适用，则为必需 - 内容受限的地区。如果内容在 eligibleRegion 内的所有国家/地区均可观看，则无需提供此属性。
actionAccessibilityRequirement.requiresSubscription MediaSubscription

必需（如果适用）- 用户需要订阅才能访问内容的订阅详细信息。请参阅媒体订阅属性。

  • 如果 category 为 subscription 或 externalSubscription，请提供此属性。
actionAccessibilityRequirement.expectsAcceptanceOf 优惠 如果内容需要购买，则为必需属性 - 与内容关联的优惠的详细信息。提供以下情况的价格信息：
  • 一次性购买的内容（rental 或 purchase）
  • 需要订阅者额外购买的基于订阅的内容（subscription 或 externalsubscription）
如果价格为 0.00，则完全移除 Offer 对象，并将 ActionAccessSpecification 对象中的 category 设置为 free。请参阅优惠属性。
actionAccessibilityRequirement.additionalProperty PropertyValue 必需（如果适用）- 将在体验中显示的订阅软件包的引用。
actionAccessibilityRequirement.additionalProperty.name 文本 必需 - 始终设置为 “DisplaySubscriptionIdentifier”
actionAccessibilityRequirement.additionalProperty.value 文本 必需 - 将为实体显示的 requiresSubscription.@id。

媒体订阅属性

如果 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，请参阅通用层要求文档。

Entitlement 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）。
    • 。这不适用于仅应使用 TMS_ID 的组织和 BroadcastService 实体。
  • TMS_ID：Gracenote (TMS) 变体 ID（例如 MV000398520000）。
  • WIKIDATA_ID：WikiData ID（例如 Q134773）。
  • IMDB_ID：IMDB ID（例如 tt0109830）。
  • OPTA_ID：OPTA Sports ID。
  • STATS_ID：STATS Perform 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 实体的规范页面上找到。

例如，电影《捉鬼敢死队》的 titleEIDR 为“10.5240/7EC7-228A-510A-053E-CBB8-J”。

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

此属性可在 TVEpisode 和 Movie 实体的规范页面上使用。

例如，电影《捉鬼敢死队》的 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
白俄罗斯 (BY) 不可用 MKRF/俄罗斯
比利时 (BE) 不可用 MPAA
伯利兹 (BZ) 不可用 不可用
贝宁 (BJ) 不可用 CNC
玻利维亚 (BO) 不可用 MPAA
波斯尼亚和黑塞哥维那 (BA) 不可用 MPAA
博茨瓦纳 (BW) 不可用 MPAA
巴西 (BR) CLASSIND CLASSIND
布基纳法索 (BF) 不可用 CNC
柬埔寨 (KH) 不可用 不可用
加拿大 (CA) CA_TV CHVRS
佛得角 (CV) 不可用 CCE
智利 (CL) 不可用 MPAA
哥伦比亚 (CO) 不可用 MPAA
哥斯达黎加 (CR) 不可用 MPAA
克罗地亚 (HR) 不可用 不可用
塞浦路斯 (CY) 不可用 GRFILM
捷克 (CZ) 不可用 CZFILM
丹麦 (DK) 不可用 MCCYP
厄瓜多尔 (EC) 不可用 MPAA
埃及 (EG) 不可用 MPAA
萨尔瓦多 (SV) 不可用 MPAA
爱沙尼亚 (EE) 不可用 EEFILM
斐济 (FJ) 不可用 不可用
芬兰 (FI) 不可用 MEKU
法国 (FR) CSA CSA
加蓬 (GA) 不可用 CNC
德国 (DE) FSK FSK
希腊 (GR) ESR GRFILM
危地马拉 (GT) 不可用 MPAA
海地 (HT) 不可用 不可用
洪都拉斯 (HN) 不可用 MPAA
香港 (HK) CA FCO
匈牙利 (HU) 不可用 MPAA
冰岛 (IS) 不可用 KIJKWIJZER
印度 (IN) CBFC CBFC
印度尼西亚 (ID) KPI LSF
爱尔兰 (IE) 不可用 IFCO
意大利 (IT) AGCOM AGCOM
科特迪瓦 (CI) 不可用 CNC
牙买加 (JM) 不可用 MPAA
日本 (JP) NA EIRIN
约旦 (JO) 不可用 MPAA
哈萨克斯坦 (KZ) 不可用 MRKF
韩国 (KR) KMRB KMRB
科威特 (KW) 不可用 MPAA
吉尔吉斯斯坦 (KG) 不可用 MKRF/俄罗斯
老挝 (LA) 不可用 不可用
拉脱维亚 (LV) 不可用 NKCLV
黎巴嫩 (LB) 不可用 MPAA
立陶宛 (LT) 不可用 不可用
卢森堡 (LU) 不可用 KIJKWIJZER
马其顿 (MK) 不可用 MPAA
马来西亚 (MY) 不可用 FCBM
马里 (ML) 不可用 CNC
马耳他 (MT) 不可用 MCCAA
毛里求斯 (MU) 不可用 BBFC
墨西哥 (MX) RTC RTC
摩尔多瓦 (MD) 不可用 不可用
纳米比亚 (NA) 不可用 不可用
尼泊尔 (NP) 不可用 MPAA
荷兰 (NL) KIJKWIJZER KIJKWIJZER
新西兰 (NZ) BSA OFLC
尼加拉瓜 (NI) 不可用 MPAA
尼日尔 (NE) 不可用 CNC
挪威 (NO) 不可用 MEDIETILSYNET
阿曼 (OM) 不可用 MPAA
巴拿马 (PA) 不可用 MPAA
巴布亚新几内亚 (PG) 不可用 MPAA
巴拉圭 (PY) 不可用 MPAA
秘鲁 (PE) 不可用 MPAA
菲律宾 (PH) MTRCB MTRCB
波兰 (PL) 不可用 MPAA
葡萄牙 (PT) 不可用 CCE
卡塔尔 (QA) 不可用 MPAA
俄罗斯 (RU) MKRF/俄罗斯 MKRF/俄罗斯
卢旺达 (RW) 不可用 CNC
沙特阿拉伯 (SA) 不可用 MPAA
塞内加尔 (SN) 不可用 MPAA
新加坡 (SG) 不可用 MDA
斯洛伐克 (SK) 不可用 MPAA
斯洛文尼亚 (SI) 不可用 MPAA
南非 (ZA) FPB FPB
西班牙 (ES) SETSI ICAA
斯里兰卡 (LK) 不可用 不可用
瑞典 (SE) 不可用 SMSA
瑞士 (CH) FSK FSK
台湾 (TW) 不可用 MOCTW
塔吉克斯坦 (TJ) 不可用 MKRF/俄罗斯
坦桑尼亚 (TZ) 不可用 MPAA
泰国 (TH) 不可用 BFVC
多哥 (TG) 不可用 CNC
特立尼达和多巴哥 (TT) 不可用 不可用
土耳其 (TR) RTÜK ECBMCT
土库曼斯坦 (TM) 不可用 MKRF/俄罗斯
乌干达 (UG) 不可用 MPAA
乌克兰 (UA) 不可用 不可用
阿拉伯联合酋长国 (AE) 不可用 MPAA
英国 (GB) BBFC BBFC
美国 (US) TV_PG MPAA
乌拉圭 (UY) 不可用 MPAA
乌兹别克斯坦 (UZ) 不可用 MKRF/俄罗斯
委内瑞拉 (VE) 不可用 RESORTEVIOLENCIA
越南 (VN) 不可用 MCST
赞比亚 (ZM) 不可用 MPAA
津巴布韦 (ZW) 不可用 MPAA

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 文本 必需 - 相应地区的 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"
    }
  ]
}