觀看動作常見屬性

本節將詳細說明手錶動作的常見屬性。

動作標記屬性

屬性 預期類型 說明
@type 文字 必要 - 一律設為 WatchAction。
target EntryPoint 必要 - 目標物件，可提供各種 Google 平台深層連結的對應。
target.@type 文字 必要 - 一律設為 EntryPoint。
target.urlTemplate 網址 必要 - 深層連結，可將使用者帶往應用程式或平台，並啟動內容播放。
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 裝置上投放內容及使用 Home 平台。
  • http://schema.googleapis.com/GoogleAudioCast：在 Chromecast 裝置上投放及使用 Google Home 平台 (僅限「聆聽動作」)。
如需相關需求，請參閱「平台類型」一節。
target.additionalProperty PropertyValue 適用時為必填 - 屬性/值組合清單，代表深層連結的其他屬性。包括：
  • contentLanguage：廣播語言 (配音)，採 BCP 47 格式。如果內容配音為其他語言，則必須提供這項屬性。如要使用多個語言代碼，請使用陣列。
  • subtitleLanguage：字幕或隱藏式輔助字幕的語言，格式為 BCP 47。如要使用多個語言代碼，請使用陣列。
  • cameraAngle：內容的攝影機角度，例如「平視」和「高角度」。如果內容提供不同攝影機角度，則必須提供這項屬性。使用陣列表示多個攝影機角度。
  • videoFormat：用於儲存數位影片資料的檔案格式，例如「SD」代表標準畫質，「HD」代表高畫質。有效影片格式包括 SD、HD、2K、4K 和 8K。 如要使用多種影片格式，請使用陣列。
  • audioDescriptionLanguage：支援的音訊語言陣列，採用 BCP 47 格式，支援語音說明。這是 contentLanguage 陣列的子集。
請參閱 additionalProperty 範例。
actionAccessibilityRequirement ActionAccessSpecification 必要 - Action 存取規格物件，說明內容的存取權需求。請參閱「動作存取規格屬性」。

如要瞭解與這些屬性相關的主題，請參閱下列頁面：

動作存取規格屬性

屬性 預期類型 說明
actionAccessibilityRequirement.@type 文字 必要 - 一律設為 ActionAccessSpecification。
actionAccessibilityRequirement.category 文字

必要 - 內容的存取規定。詳情請參閱「付費牆類型」。

如果實體代表一組內容，您需要將 category 設為內容限制最少的存取權需求。舉例來說，如果 TVSeries 有些 TVEpisode 內容設為 nologinrequired，有些則設為 subscription，請將這個 TVSeries 設為 nologinrequired。
actionAccessibilityRequirement.availabilityStarts 日期

必填 - 動作可用的日期，採用 ISO 8601 格式 (包括時區)。

  • 日期可以設為未來的日期。

請務必在相應實體的 availabilityStarts 日期前至少 7 天，在動態饋給中提供該實體。這有助於內容及時顯示在 Google 服務上。
actionAccessibilityRequirement.availabilityEnds 日期 必要 - 動作的截止日期，採用ISO 8601 格式 (包括時區)。
  • 必須等於或大於 availabilityStarts 後的 72 小時。
  • 如果內容發布後會永久保留，請將這個日期設為目前日期的 20 年後。

如要更新 availabilityEnds 日期，請務必在該日期前至少 7 天，在動態饋給中進行更新。這樣一來，內容在 availabilityEnds 日期當天停止顯示於 Google 服務的機率就會提高。
actionAccessibilityRequirement.eligibleRegion Country、City、State、GeoShape 或 Text 必要 - 內容可播映的地區。如果內容在全球各地都適用，請使用特殊字串 EARTH。
actionAccessibilityRequirement.ineligibleRegion 國家/地區、城市、州/省或 GeoShape 如適用則為必填 - 內容受限的區域。如果內容在 eligibleRegion 內的所有地區都適用，就不必提供這項屬性。
actionAccessibilityRequirement.requiresSubscription MediaSubscription

適用時為必填 - 使用者必須訂閱才能存取內容的詳細資料。請參閱「媒體訂閱屬性」。

  • 如果 category 為 subscription 或 externalSubscription，請提供這項屬性。
actionAccessibilityRequirement.expectsAcceptanceOf Offer 內容需要購買時為必填 - 與內容相關聯的優惠詳細資料。請提供下列情況的價格資訊：
  • 一次性消費內容 (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 建議您使用下列語法做為 ID：
    網域名稱 + 半形冒號 (:) + 內容存取層級，例如：example.com:basic、 example.com:premium、example.com:sports
  • 如果您提供授權 API，這個屬性會與您的授權 ID相同。
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 提供單一訂閱方案，訂閱者可存取所有內容：不需要授權 ID / API
  • 公司 B 提供基本訂閱方案，可存取部分內容，以及付費訂閱方案，可存取付費內容： 需要授權 ID / API
  • C 公司提供基本訂閱方案，可存取部分內容，以及可存取第三方內容的加購套裝組合：授權 ID / API 為必要項目

如要瞭解與這些屬性相關的主題，請參閱下列頁面：

優惠屬性

屬性 預期類型 說明
expectsAcceptanceOf.@type 文字 必要 - 一律設為 Offer。
expectsAcceptanceOf.price Number 必填 - 內容的購買價格。價格必須是正數，且不得為零。如為價格為 0.00 的實體，請將類別指定為「free」。
expectsAcceptanceOf.priceCurrency 文字 必要 - 價格的幣別，採用三個英文字母組成的 ISO 4217 格式。
expectsAcceptanceOf.seller 機構組織 提供內容購買服務的機構。
expectsAcceptanceOf.seller.@type 文字 一律設為 Organization。
expectsAcceptanceOf.seller.name 文字 賣家名稱。
expectsAcceptanceOf.seller.sameAs 文字 可識別賣家的網頁網址，例如賣家首頁。

優惠相關頁面

如要瞭解與這些屬性相關的主題，請參閱下列頁面：

ID

媒體動作動態消息接受各種 ID，可協助明確識別實體。這些 ID 有助於加快比對動態饋給中的內容與 Google 資料庫中內容的程序。雖然大部分的識別項都可以使用各種實體類型的 identifier 屬性新增至動態饋給，但 EIDR 有自己的代表性屬性。以下將說明這兩種情況。

ID 屬性

屬性 預期類型 說明
identifier 文字 強烈建議 - 識別碼，通常是外部識別碼，可明確識別特定實體。可使用多個 ID。

所有 Watch Action 實體類型都支援這項屬性。

下表列出 identifier 屬性可接受的 ID 和子屬性。請參閱「觀看動作動態饋給範例」一節中的識別碼/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 Perform ID。
  • VIP_TIMES_ID：日本 VIPTimes (日本タレント名鑑) 的日本藝人 ID。
  • DMA_ID：美國指定行銷區域代碼，用於 GeoShape 物件。
  • _PARTNER_ID_：這個屬性必須包含「_PARTNER_ID_」字串，且值必須是服務供應商在內部或外部用來識別實體的專屬 ID (例如 12345 或 a5c604e2-e9e5-4ff3-b728-245799dc37f1)。
value 文字 必填 - 指定 ID 系統的值。

EIDR 屬性

EIDR (國際影視產業識別碼機構的簡稱) 是全球唯一的識別碼系統，適用於各種媒體內容，包括電影和電視節目。識別系統會將 ID 解析為與頂層影視內容、編輯內容等相關聯的中繼資料記錄。下表列出與 EIDR 相關的屬性及其用途。

屬性 預期類型 說明
titleEIDR 文字 強烈建議 - EIDR (國際影視產業識別碼機構) 識別碼代表電影或電視作品最一般/抽象的層級。

這項屬性適用於 TVSeries、TVSeason、TVEpisode 和 Movie 實體規格頁面。

舉例來說，電影「魔鬼剋星」的 titleEIDR 為「10.5240/7EC7-228A-510A-053E-CBB8-J」。

請參閱「觀看動作」動態饋給範例部分中的「ID/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 屬性為必填。

請參閱「觀看動作動態消息範例」一節中的識別碼/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) 主要成效指標 LSF
愛爾蘭 (IE) 無法使用 IFCO
義大利 (IT) AGCOM AGCOM
象牙海岸 (CI) 無法使用 CNC
牙買加 (JM) 無法使用 MPAA
日本 (JP) 不適用 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 網址 必要 - 地理區域的 ID，格式為 URI。
@type 文字 必要 - 一律設為 GeoShape。
addressCountry 文字 必填 - 包含兩個英文字母的 ISO 3166-1 alpha-2 國家/地區代碼。
postalCode 文字 選填 - 一或多個郵遞區號和/或 FSA (轉發站區域) 代碼的清單。
identifier PropertyValue 選用 - 指定行銷區域 (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"
    }
  ]
}