手表 Action 的通用属性

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

操作标记属性

属性 预期类型 说明
@type Text 必需 - 始终设置为 WatchAction
target 入口点 必需 - 一个目标对象,可将深层链接映射到各种 Google 平台。
target.@type Text 必需 - 始终设置为 EntryPoint
target.urlTemplate 网址 必需 - 一种深层链接,可将用户引导至您的应用或平台并启动内容播放。
target.inLanguage Text 可选 - 系列的原始语言,采用 BCP 47 格式。
target.actionPlatform Text 必需 - 映射到 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 设备上的投射和主屏幕平台。
  • http://schema.googleapis.com/GoogleAudioCast:Chromecast 设备上的投射和主屏幕平台(仅限收听操作)。
如需了解相关要求,请参阅平台类型部分。
target.additionalProperty PropertyValue 如果适用 - 表示属性值的其他属性的列表,表示深层链接的其他属性。其中可能包括:
  • contentLanguage:广播语言 (dub),采用 BCP 47 格式。如果内容使用其他语言进行配音,则此属性是必需的。使用多语言代码数组。
  • subtitleLanguage:字幕的语言,采用 BCP 47 格式。使用多语言代码数组。
  • cameraAngle:内容的相机角度;例如,“视线高度”和“高角度”。如果内容以不同的镜头角度拍摄,则必须提供此属性。使用多角度相机数组。
  • videoFormat:用于存储数字视频日期的文件格式。例如,“SD”表示标清,“HD”表示高清。有效的视频格式包括标清、高清、2K、4K 和 8K。 针对多种视频格式使用数组。
请参阅 additionalProperty 示例。
actionAccessibilityRequirement ActionAccessSpecification 必需 - 操作访问规范对象,用于说明内容的访问权限要求。请参阅操作访问规范属性

请查看以下页面,了解与这些属性相关的主题:

操作访问规范属性

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

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

如果某个实体代表一组内容,您需要将 category 设置为对其内容的限制性最低的要求。例如,如果 TVSeries 将一些 TVEpisode 内容设置为 nologinrequired,还有一些内容设置为 subscription,请将此 TVSeries 设置为 nologinrequired

actionAccessibilityRequirement.availabilityStarts 日期

必需 - 可执行此操作的日期,采用 ISO 8601 格式(包括时区)。

  • 可以设置将来的日期。

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

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

您必须在 FeedEnds 日期前至少 7 天在 Feed 中更新 availabilityEnds 日期。这将增加内容在 availabilityEnds 日期停止在 Google 平台上展示的几率。

actionAccessibilityRequirement.eligibleRegion 国家/地区城市地理形状文本 必需 - 提供内容的区域。如果内容可在全球范围内访问,请使用特殊字符串 EARTH
actionAccessibilityRequirement.ineligibleRegion 国家/地区城市GeoShape 如果适用 - 限制内容的区域。如果相应内容在 eligibleRegion 中随处可用,则您无需提供此属性。
actionAccessibilityRequirement.requiresSubscription MediaSubscription

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

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

媒体订阅属性

如果 actionAccessibilityRequirement.categorysubscriptionexternalSubscription,则必须提供此值。

属性 预期类型 说明
requiresSubscription.@type Text 必需 - 一律设置为 MediaSubscription
requiresSubscription.@id 网址 必需 - 订阅的唯一 ID。如果内容可通过不同的订阅访问,则每个订阅都必须具有唯一的 ID。
requiresSubscription.name Text 必需 - 订阅的名称。请注意以下事项:
  • 如果内容可通过不同的订阅访问,则此名称需要与您用户身份验证系统中的名称一致。例如,如果用户可以根据名为“软件包 1”的订阅来访问内容,但身份验证系统使用名称“PKG1a”,请使用 PKG1
  • 对于 TVE 提供程序,这是在 TVE 身份验证器中注册的身份验证器名称。它是一个使用 TVE 身份验证器对服务名称进行唯一标识的字符串。
requiresSubscription.sameAs 网址 描述订阅的页面。
requiresSubscription.identifier Text 如果 categorysubscriptioncommonTierfalse,则为必需参数 - 此订阅的唯一字符串,表示对媒体目录中一组内容的访问权限。
  • Google 建议您使用以下语法作为标识符:
    域名 + 冒号 (:) + 对内容的访问权限级别,例如:example.com:basic、example.com:premium、example.com:sports
  • 如果您要提供授权 API,则此属性将与您的权利标识符相同
requiresSubscription.authenticator 组织 如果 categoryexternalsubscription,则必须提供此属性 - 该容器提供外部提供程序的身份验证器详情。
requiresSubscription.authenticator.@type Text 如果 categoryexternalsubscription,则必须提供此属性 - 一律设置为 Organization
requiresSubscription.authenticator.name Text 如果 categoryexternalsubscription 是必需的。- 身份验证服务的名称。对于 TVE 提供商,请将其设置为 TVE
requiresSubscription.commonTier Boolean 如果适用是必需字段 - 如果类别设置为“订阅”,则必须执行此操作。如需详细了解 commonTier,请参阅通用层级要求文档。

授权 API 要求

如果 actionAccessibilityRequirement.categorysubscriptionexternalSubscription,并且您的订阅产品包含多个软件包或层级或者具有附加支持,则必须使用 entitlement API。如果您的订阅是分层的,并且允许访问目录中的所有内容,请勿添加此字段。

  • A 公司提供一项订阅产品,可让订阅用户访问所有可用内容:需要权利标识符/API
  • 公司 B 提供提供部分内容的访问权限的付费订阅和提供付费内容访问权限的付费订阅:必须提供权利标识符/API
  • C 公司提供基本内容订阅,提供对部分内容的访问权限,并额外提供可访问第三方内容的软件包:必须提供权利标识符 / API

请查看以下页面,了解与这些属性相关的主题:

优惠属性

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

请查看以下页面,了解与这些属性相关的主题:

标识符

媒体操作 Feed 接受各种标识符,这些标识符有助于明确识别实体。这些标识符有助于加快 Feed 中的内容与 Google 数据库中的内容保持一致的过程。虽然这些标识符大多可在各种实体类型上使用 identifier 属性添加到 Feed 中,但 EIDR 有自己的代表性属性。下文对这两种方式进行了讨论。

标识符属性

属性 预期类型 说明
identifier Text 强烈建议 - 一种标识符(通常是外部标识符),用于明确识别指定实体。允许使用多个标识符。

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

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

EIDR 属性

EIDR(全称为 Entertainment Identifier Registry,是 Entertainment Identifier Registry,简称 娱乐标识符)的全球唯一标识符系统,具有广泛的媒体内容系统,包括电影和电视节目。标识系统会将标识符解析为与顶级标题、修改等内容相关联的元数据记录。下表列出了与 EIDR 及其用法相关联的属性。

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

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

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

请参阅 ID 示例:观看操作 ID 部分。
editEIDR Text 强烈建议 - EIDR(娱乐标识符注册)标识符代表电影或电视作品的特定修改/版本。

此属性可在 TVEpisodeMovie 实体规范页面上提供。

例如,名称为“Ghostbusters”的电影,其标题 EIDR 为“10.5240/7EC7-228A-510A-053E-CBB8-J”,例如“10
.F.

内容分级代理机构

对于 BroadcastService.contentRatingMovie.contentRatingTVSeries.contentRating,请使用此表中的值。分级机构应位于分级的前面。示例:

  • 在美国分级为“R”的电影的 Movie.contentRating 值应为“MPAA R”。
  • 在美国分级为“TV-MA”的电视节目的 TVSeries.contentRating 值应该为“TVPG TV-MA”。

国家/地区 电视分级机构 电影分级机构
阿尔巴尼亚 (AL) 不可用 不可用
安哥拉 (AO) 不可用 CECE
安提瓜和巴布达 (AG) 不可用 MPAA
阿根廷 (AR) 墨西哥航空 墨西哥航空
亚美尼亚 (AM) 不可用 MKRF/俄罗斯
阿鲁巴 (AW) 不可用 不可用
澳大利亚 (AU) ACB 电视 ACB 电影
奥地利 (AT) FSK FSK
阿塞拜疆 (AZ) 不可用 MKRF/俄罗斯
巴林 (BH) 不可用 MPAA
白俄罗斯 (BY) 不可用 MKRF/俄罗斯
比利时 (BE) 不可用 MPAA
伯利兹 (BZ) 不可用 不可用
贝宁 (BJ) 不可用 CNC
玻利维亚 (BO) 不可用 MPAA
波斯尼亚和黑塞哥维那 (BA) 不可用 MPAA
博茨瓦纳 (BW) 不可用 MPAA
巴西(BR) 已分类 已分类
布基纳法索 (BF) 不可用 CNC
柬埔寨 (KH) 不可用 不可用
加拿大 (CA) CA_TV CHVRS
佛得角 (CV) 不可用 CECE
智利 (CL) 不可用 MPAA
哥伦比亚 (CO) 不可用 MPAA
哥斯达黎加 (CR) 不可用 MPAA
克罗地亚 (HR) 不可用 不可用
塞浦路斯 (CY) 不可用 GRFILM
捷克 (CZ) 不可用 捷克
丹麦 (DK) 不可用 MCCYP
厄瓜多尔 (EC) 不可用 MPAA
埃及 (EG) 不可用 MPAA
萨尔瓦多 (SV) 不可用 MPAA
爱沙尼亚 (EE) 不可用 EEFILM
斐济 (FJ) 不可用 不可用
芬兰 (FI) 不可用 菜单
法国(FR) 自定义搜索广告 自定义搜索广告
加蓬 (GA) 不可用 CNC
德国 (DE) FSK FSK
希腊 (GR) 西班牙比索 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) 不适用 爱尔兰航空
约旦 (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) 不可用 医学
阿曼 (OM) 不可用 MPAA
巴拿马 (PA) 不可用 MPAA
巴布亚新几内亚 (PG) 不可用 MPAA
巴拉圭 (PY) 不可用 MPAA
秘鲁 (PE) 不可用 MPAA
菲律宾 (PH) MTRCB MTRCB
波兰 (PL) 不可用 MPAA
葡萄牙 (PT) 不可用 CECE
卡塔尔 (QA) 不可用 MPAA
俄罗斯 (RU) MKRF/俄罗斯 MKRF/俄罗斯
卢旺达 (RW) 不可用 CNC
沙特阿拉伯 (SA) 不可用 MPAA
塞内加尔 (SN) 不可用 MPAA
新加坡 (SG) 不可用 MDA
斯洛伐克 (SK) 不可用 MPAA
斯洛文尼亚 (SI) 不可用 MPAA
南非 (ZA) FPB FPB
西班牙(ES) 设置 ICAA
斯里兰卡 (LK) 不可用 不可用
瑞典 (SE) 不可用 短信
瑞士 (CH) FSK FSK
台湾 (TW) 不可用 MOCTW
塔吉克斯坦 (TJ) 不可用 MKRF/俄罗斯
坦桑尼亚 (TZ) 不可用 MPAA
泰国 (TH) 不可用 BFVC
多哥 (TG) 不可用 CNC
特立尼达和多巴哥 (TT) 不可用 不可用
土耳其 (TR) RTEUK ECBMCT
土库曼斯坦 (TM) 不可用 MKRF/俄罗斯
乌干达 (UG) 不可用 MPAA
乌克兰 (UA) 不可用 不可用
阿拉伯联合酋长国 (AE) 不可用 MPAA
英国 (GB) BBFC BBFC
美国 (US) TV_PG MPAA
乌拉圭 (UY) 不可用 MPAA
乌兹别克斯坦 (UZ) 不可用 MKRF/俄罗斯
委内瑞拉 (VE) 不可用 RESORTEVIOLENCIA
越南 (VN) 不可用 多客户营销
赞比亚 (ZM) 不可用 MPAA
津巴布韦 (ZW) 不可用 MPAA

GeoShape 属性

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

属性 预期类型 说明
@id 网址 必需 - 地理区域的标识符(采用 URI 格式)。
@type Text 必需 - 始终设置为 GeoShape
addressCountry Text 必需 - 由两个字母组成的 ISO 3166-1 alpha-2 国家/地区代码
postalCode Text 可选 - 由一个或多个邮政编码和/或 FSA(正向排序区域)代码组成的列表。
identifier PropertyValue 可选 - 特定媒体市场区域 (DMA),是美国地区同一电视频道和节目播出的地区的标识符。
identifier.@type Text 必需 - 始终设置为 PropertyValue
identifier.propertyID Text 必需 - 始终设置为 DMA_ID
identifier.value Text 必需 - 区域的 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"
    }
  ]
}