观看操作常见属性

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

操作标记属性

属性 预期类型 说明
@type 文本 必需 - 始终设置为 WatchAction
target EntryPoint 必需 - 一个目标对象, 提供了 深度 指向不同 Google 平台的链接
target.@type 文本 必需 - 始终设置为 EntryPoint
target.urlTemplate 网址 必需 - A 深度 该链接可将用户引导至您的应用或平台, 播放相应内容。
target.inLanguage 文本 可选 - 连续剧的原始语言 BCP 47 格式。
target.actionPlatform 文本 必需 - 映射到的平台 urlTemplate。媒体操作支持以下各项:
  • http://schema.org/DesktopWebPlatform:搜索平台 。
  • http://schema.org/MobileWebPlatform:启用搜索平台 移动网络浏览器。
  • http://schema.org/AndroidPlatform:Google 搜索和 PlayGuide 平台。
  • http://schema.org/AndroidTVPlatform:Android TV Android TV 应用平台。
  • http://schema.org/IOSPlatform:iOS 上的搜索平台 应用。
  • http://schema.googleapis.com/GoogleVideoCast:投放和 Chromecast 设备上的家居平台。
  • http://schema.googleapis.com/GoogleAudioCast:投放和 Chromecast 设备上的主屏幕平台(仅限聆听操作)。
。 请参阅 平台 类型部分了解相关要求。
target.additionalProperty PropertyValue 必需(如果适用)-“属性-值”对列表,用于 表示深层链接的其他属性。其中可能包括 以下:
  • contentLanguage:直播语言(配音),语言 BCP 47 格式。如果内容配音使用的是其他语言, 属性是必需属性。针对多种语言代码使用数组。
  • subtitleLanguage:字幕的语言。 字幕 BCP 47 格式。针对多种语言代码使用数组。
  • cameraAngle:内容的镜头角度;用于 例如“眼睛水平”和“高角度”。如果相应内容已在下列国家/地区推出: 不同镜头角度,此属性为必需属性。针对以下查询使用数组: 多个镜头角度。
  • videoFormat:用于存储数字 视频日期;例如“SD”对于标清和“高清”用于 高清画质有效视频格式包括标清、高清、2K、4K 和 8K。 针对多种视频格式使用数组。
。 请参阅 additionalProperty 示例。
actionAccessibilityRequirement ActionAccessSpecification 必需 - 操作 一个访问规范对象,用于描述 内容。请参阅操作 访问规范属性。

您可以访问以下页面,了解与这些属性相关的主题:

操作访问规范属性

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

必需 - 内容的访问权限要求。有关 请参阅 付费墙类型

如果实体代表一组内容,则您需要设置 category到 其内容。例如,如果 TVSeries 有 已将“TVEpisode”的内容设置为“nologinrequired” 还有一些设置为 subscription,则将此 TVSeriesnologinrequired

actionAccessibilityRequirement.availabilityStarts 日期

必填 - 可以执行该操作的日期,以 感光度 8601 格式(包括时区)。

  • 日期可设置为将来的日期。

您必须在以下网址的 Feed 中提供相应的实体: 至少提前 7 天这将增强 相应内容准时在 Google 平台上展示的几率。

actionAccessibilityRequirement.availabilityEnds 日期 必填 - 操作失效的日期。 (ISO 格式) 8601 格式(包括时区)。
  • 必须等于或晚于 72 小时 availabilityStarts
  • 如果内容在发布后始终可供查看,请将此项 日期设置为从当前日期起 20 年后的日期。

必须更新 availabilityEnds 日期 。这个 将提高相关内容在 Google 上停止显示的几率 。

actionAccessibilityRequirement.eligibleRegion 国家/地区城市 GeoShape文本 必需属性 - 提供相应内容的地区。使用 特殊字符串 EARTH(如果内容可在全球范围内使用)。
actionAccessibilityRequirement.ineligibleRegion 国家/地区城市 StateGeoShape 如果适用,则必须提供 - 内容所在的地区 受限。如果内容是 eligibleRegion的任何地方均可使用。
actionAccessibilityRequirement.requiresSubscription MediaSubscription

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

  • 如果 category 为以下值,请提供此属性: subscriptionexternalSubscription
actionAccessibilityRequirement.expectsAcceptanceOf 优惠 如果内容需要购买,则必须提供 - 与相应内容相关联的优惠。为 以下情况:
  • 一次性购买内容(rentalpurchase)
  • 需要额外购买的基于订阅的内容 位订阅者(subscriptionexternalsubscription)
。 如果价格为 0.00,则完全移除 Offer 对象,并将 ActionAccessSpecification 对象中的 category 设置为 free。请参阅 优惠属性

媒体订阅属性

如果 actionAccessibilityRequirement.category 为必需项,则为必需项 subscriptionexternalSubscription

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

Entitlement API 要求

entitlement API 是 如果 actionAccessibilityRequirement.categorysubscription,则必须提供此值;或者 externalSubscription,您的订阅产品/服务 或具有附加支持。如果您的 订阅是分级订阅,可让您访问目录中的所有内容。

  • A 公司有一项订阅服务,为订阅用户提供 对所有可用内容的访问权:使用权标识符 / API 必需
  • B 公司拥有基本订阅,可提供对部分内容的访问权限 一种付费订阅服务: 必须提供使用权标识符 / API
  • C 公司拥有基本订阅,可提供对部分内容的访问权限 附加给可访问第三方内容的软件包: 必须提供使用权标识符 / API

您可以访问以下页面,了解与这些属性相关的主题:

优惠属性

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

您可以访问以下页面,了解与这些属性相关的主题:

标识符

媒体操作 Feed 接受各种标识符, 以明确的方式存储实体这些标识符有助于加快 使 Feed 中的内容与 Google 的 数据库。虽然大部分标识符可以使用 identifier 属性,EIDR 有自己的 代表性属性。下面将对这两种方式进行讨论。

标识符属性

属性 预期类型 说明
identifier 文本 强烈推荐 - 用于明确标识指定实体的标识符(通常为外部标识符)。允许使用多个标识符。

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

下表列出了 identifier 媒体资源可接受的标识符和子属性。请参阅观看操作 Feed 示例部分中的标识符/EIDR 示例
属性 预期类型 说明
@type 文本 必需 - 始终设置为 PropertyValue
propertyID 文本 必需 - 我们支持以下身份证件类型:
  • 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 表演 ID。
  • VIP_TIMES_ID:面向日本人才的日本 VIPTimes (Nihon Tarento Meikan) ID。
  • DMA_ID:美国特定营销区号,用于 GeoShape 对象。
  • _PARTNER_ID_:此属性必须包含字符串 “_PARTNER_ID_”,则该值必须是由 用于识别实体的 (例如 12345a5c604e2-e9e5-4ff3-b728-245799dc37f1).
value 文本 必需 - 指定 ID 系统的值。

EIDR 属性

EIDR(The Entertainment Identifier Registry 的英文缩写)是适用于众多媒体内容(包括电影和电视节目)的全球唯一标识符系统。标识系统将标识符解析为与顶级影视内容、修改内容等相关联的元数据记录。下表列出了与 EIDR 相关联的属性及其用法。

属性 预期类型 说明
titleEIDR 文本 强烈建议使用 - EIDR(娱乐标识符注册)标识符在最一般/抽象级别代表电影或电视作品。

此属性可在 TVSeriesTVSeasonTVEpisodeMovie 实体规范页面上使用。

例如,名为“Ghostbusters”的电影的 titleEIDR为“10.5240/7EC7-228A-510A-053E-CBB8-J”。

请参阅“观看操作”Feed 示例部分中的标识符/EIDR 示例
editEIDR 文本 强烈建议使用 - EIDR(娱乐标识符注册)标识符表示电影或电视作品的特定剪辑版本/版本。

此属性可在 TVEpisodeMovie 实体规范页面上找到。

例如,名为“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”。

当提供 editEIDR 时,必须提供 titleEIDR 属性。

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

内容分级机构

使用此表中的 BroadcastService.contentRatingMovie.contentRatingTVSeries.contentRating 值。应将评级机构作为评级值的前缀。示例:

  • 评级为“R”的电影美国的 Movie.contentRating 值应为“MPAA R”。
  • 评级为“TV-MA”的电视连续剧美国的 TVSeries.contentRating 值应为“TVPG TV-MA”。

国家/地区 电视分级机构 电影分级机构
阿尔巴尼亚 (AL) 不可用 不可用
安哥拉 (AO) 不可用 CCE
安提瓜和巴布达 (AG) 不可用 MPAA
阿根廷 (AR) INCAA INCAA
亚美尼亚 (AM) 不可用 MKRF/RUSSIA
阿鲁巴 (AW) 不可用 不可用
澳大利亚 (AU) ACB 电视 ACB 电影
奥地利 (AT) FSK FSK
阿塞拜疆 (AZ) 不可用 MKRF/RUSSIA
巴林 (BH) 不可用 MPAA
白俄罗斯 (BY) 不可用 MKRF/RUSSIA
比利时 (BE) 不可用 MPAA
伯利兹 (BZ) 不可用 不可用
贝宁 (BJ) 不可用 CNC
玻利维亚 (BO) 不可用 MPAA
波斯尼亚和黑塞哥维那 (BA) 不可用 MPAA
博茨瓦纳 (BW) 不可用 MPAA
巴西(BR) 分类 分类
布基纳法索 (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) 不可用 中东和北非
法国(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) 不适用 EIRIN
约旦 (JO) 不可用 MPAA
哈萨克斯坦 (KZ) 不可用 MRKF
韩国 (KR) KMRB KMRB
科威特 (KW) 不可用 MPAA
吉尔吉斯斯坦 (KG) 不可用 MKRF/RUSSIA
老挝 (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/RUSSIA MKRF/RUSSIA
卢旺达 (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/RUSSIA
坦桑尼亚 (TZ) 不可用 MPAA
泰国 (TH) 不可用 BFVC
多哥 (TG) 不可用 CNC
特立尼达和多巴哥 (TT) 不可用 不可用
土耳其 (TR) RTÜK ECBMCT
土库曼斯坦 (TM) 不可用 MKRF/RUSSIA
乌干达 (UG) 不可用 MPAA
乌克兰 (UA) 不可用 不可用
阿拉伯联合酋长国 (AE) 不可用 MPAA
英国 (GB) BBFC BBFC
美国 (US) TV_PG MPAA
乌拉圭 (UY) 不可用 MPAA
乌兹别克斯坦 (UZ) 不可用 MKRF/RUSSIA
委内瑞拉 (VE) 不可用 RESORTEVIOLENCIA
越南 (VN) 不可用 MCST
赞比亚 (ZM) 不可用 MPAA
津巴布韦 (ZW) 不可用 MPAA

GeoShape 属性

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

属性 预期类型 说明
@id 网址 必需 - 地理区域的标识符(采用 URI 格式)。
@type 文本 必需 - 始终设置为 GeoShape
addressCountry 文本 必需 - 由两个字母构成的 感光度 3166-1 alpha-2 国家/地区代码
postalCode 文本 可选 - 一个或多个邮政编码和/或 FSA(前向分拣区)代码的列表。
identifier PropertyValue 可选 - A 特定媒体市场区域 (DMA) ID,该 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"
    }
  ]
}