觀看動作常見屬性

本節將詳細說明 Watch Actions 的常見屬性。

動作標記屬性

屬性 預期類型 說明
@type Text 必要：一律設為 WatchAction。
target EntryPoint 必要：目標物件，可將深層連結對應至各種 Google 平台。
target.@type Text 必要：一律設為 EntryPoint。
target.urlTemplate 網址 必要：深層連結，可將使用者帶往您的應用程式或平台，並啟動內容的播放。
target.inLanguage Text 選填：系列叢書的原始語言，採用 BCP 47 格式。
target.actionPlatform Text 必填 - 對應至 urlTemplate 的平台。Media Actions 支援以下功能：
  • 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 和 Google Home 平台 (僅限 Listen 動作)。
如需相關規定，請參閱「平台類型」一節。
target.additionalProperty PropertyValue 如適用則為必要：屬性值組合清單，用於代表深層連結的其他屬性。包括：
  • contentLanguage：廣播語言 (配音)，採用 BCP 47 格式。如果內容是用其他語言配音，則必須提供這個屬性。使用陣列來處理多個語言代碼。
  • subtitleLanguage：字幕或輔助字幕的語言，格式為 BCP 47。使用陣列來處理多個語言代碼。
  • cameraAngle：內容的攝影機角度，例如「Eye-Level」和「High-Angle」。如果內容可從不同攝影機角度觀看，則必須使用這個屬性。使用陣列來處理多個攝影機角度。
  • videoFormat：用於儲存數位影片日期的檔案格式，例如「SD」代表標準解析度，「HD」代表高畫質。有效的影片格式包括 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 格式 (包括時區)。

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

請務必在可用日期的至少 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.category 為 subscription 或 externalSubscription，則為必要欄位。

屬性 預期類型 說明
requiresSubscription.@type Text 必要 - 一律設為 MediaSubscription
requiresSubscription.@id 網址 必填：訂閱項目的專屬 ID。如果內容可透過不同訂閱項目存取，則每個訂閱項目都必須有專屬 ID。
requiresSubscription.name Text 必填 - 訂閱項目名稱。請注意以下事項：
  • 如果內容可透過不同的訂閱項目存取，則此名稱必須與使用者驗證系統中的名稱相符。舉例來說，如果使用者可以根據名為「Package 1」的訂閱項目存取內容，但驗證系統使用「PKG1a」名稱，請使用「PKG1」。
  • 對於 TVE 供應商，這是在 TVE 驗證工具中註冊的驗證工具名稱。這是一個字串，可透過 TVE Authenticator 識別服務名稱。
requiresSubscription.sameAs 網址 說明訂閱項目的頁面。
requiresSubscription.identifier Text 如果 category 為 subscription 且 commonTier 為 false，則為必填屬性 ：此為此訂閱項目的專屬字串，代表媒體目錄中一組內容的存取權。
  • Google 建議您使用以下語法做為 ID：
    網域名稱 + 冒號 (:) + 內容存取層級，例如：example.com:basic、example.com:premium、example.com:sports
  • 如果您提供授權 API，這個屬性會與授權 ID 相同
requiresSubscription.authenticator 機構組織 如果 category 為 externalsubscription，則為必要屬性 - 提供外部供應器驗證工具詳細資料的容器。
requiresSubscription.authenticator.@type Text 如果 category 為 externalsubscription，則為必填屬性 - 一律設為 Organization。
requiresSubscription.authenticator.name Text 如果 category 為 externalsubscription，則為必要元素：驗證服務的名稱。針對 TVE 供應商，請將其設為 TVE
requiresSubscription.commonTier 布林值 必要 (如適用)：如果類別設為訂閱，則必須提供這項屬性。如要進一步瞭解 commonTier，請參閱通用層級規定說明文件。

Entitlements API 規定

如果 actionAccessibilityRequirement.category 為 subscription 或 externalSubscription，且訂閱方案包含多個套裝方案或級別，或支援外掛程式，就需要使用授權 API。如果訂閱方案只有一個等級，且可存取目錄中的所有內容，請勿納入這項資訊。

  • 公司 A 提供單一訂閱方案，讓訂閱者存取所有可用內容：不需要使用授權 ID / API
  • Company B 有基本訂閱方案，可提供部分內容的存取權，以及進階訂閱方案，可提供進階內容的存取權： 需要授權 ID / API
  • Company C 有基本訂閱方案，可提供部分內容的存取權，以及可提供第三方內容存取權的加購套件：需要授權 ID / API

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

優惠屬性

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

優惠相關頁面

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

ID

媒體動作動態饋給可接受各種 ID，有助於以明確的方式識別實體。這些 ID 可協助系統加快比對動態饋給中的內容與 Google 資料庫中的內容的速度。雖然這些 ID 大多可使用各種實體類型的 identifier 屬性加入動態饋給，但 EIDR 有其專屬的代表性屬性。我們將在下文中討論這兩種情況。

ID 屬性

屬性 預期類型 說明
identifier Text 強烈建議：識別碼 (通常為外部識別碼)，可明確識別特定實體。可使用多個 ID。

此屬性適用於所有 Watch Action 實體類型。

下表列出 identifier 屬性接受的 ID 和子屬性。請參閱「觀看動作動態饋給範例」一節中的ID/EIDR 範例。
屬性 預期類型 說明
@type Text 必要：一律設為 PropertyValue。
propertyID Text 必要：我們支援以下 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：日本藝人 Japan VIPTimes (日本藝人名鑑) ID。
  • DMA_ID：在 GeoShape 物件中使用的美國指定行銷區代碼。
  • _PARTNER_ID_：這個屬性必須包含字串「_PARTNER_ID_」，且值必須是服務供應商用於內部或外部識別實體的專屬 ID (例如 12345 或 a5c604e2-e9e5-4ff3-b728-245799dc37f1)。
value Text 必填：指定 ID 系統的值。

EIDR 屬性

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

屬性 預期類型 說明
titleEIDR Text 強烈建議：EIDR (娛樂產業識別碼機構) 識別碼可在最一般/抽象的層級代表電影或電視作品。

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

舉例來說，「Ghostbusters」這部電影的 titleEIDR 為「10.5240/7EC7-228A-510A-053E-CBB8-J」。

請參閱「Watch Actions 動態饋給範例」一節中的ID/EIDR 範例。
editEIDR Text 強烈建議：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 屬性。

請參閱 Watch Actions 動態饋給範例部分的ID/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 網址 必填：地理區域的 ID，格式為 URI。
@type Text 必要：一律設為 GeoShape。
addressCountry Text 必填：兩個英文字母組成的 ISO 3166-1 alpha-2 國家/地區代碼。
postalCode Text 選填：一或多個郵遞區號和/或轉發站區域 (FSA) 代碼的清單。
identifier PropertyValue 選填：指定行銷區域 (DMA) ID，這是美國某個區域的 ID，該區域的民眾會收看相同的電視頻道和節目。
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"
    }
  ]
}