使用 CMS API 管理成績單

在本主題中，您將了解如何使用 CMS API 更新視頻的轉錄本。

簡介

你可以使用PATCH請求更新與成績單相關的元數據。

注意事項

本文檔中介紹的方法用於更新添加到您的視頻中的腳本文件。目前，您可以讓 Brightcove 在攝取期間生成轉錄文件（連同字幕）。將來的版本將支持提取您自己的成績單文件。

授權

對 CMS API 的請求需要一個包含您的訪問令牌的授權標頭。如需有關如何取得用戶端認證並使用它們來擷取存取權杖的詳細資訊，請參閱 Brightcove OAuth 概觀。

您需要更新視頻元數據的操作是video-cloud/video/update要么video-cloud/video/all。

語法

我們建議首先發出以下請求以獲取完整的數組：


GET
https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}

更新成績單

在更新 Transcripts 時， Transcripts Fields 中的某些字段可以根據其類型進行不同的處理。

文字追蹤欄位
欄位	類型	描述
`id`	字串	只讀值。需要係統生成的 ID 來標識需要更新的 TT。
`account_id`	字串	只讀值。該字段的更新將被忽略。
`src`	字串	只讀。轉錄文件的位置。
`srclang`	字串	2 或 4 個字母的語言代碼，例如`es`或者`es-MX`
`label`	字串	人類可讀的標籤。限制為 255 個字符。
`status`	枚舉	有效值（區分大小寫）： `published` - 成績單將提供給觀眾 `draft` - 成績單將不會提供給觀眾
`sources`	陣列	只讀值。`http`和`https`成績單的 URL。
`default`	布林值	`true`或者`false` .您不能添加多個`default=true`不同的成績單`srclang` . 該字段的更新將被忽略。

請求

PATCH https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}

請求正文示例

請求正文將是一個包含轉錄本數組的 JSON 對象：

"transcripts": [
  {
      "id": "d5967d03-1de1-a2de-47db-73486c7474c1",
      "account_id": "12345678910",
      "src": "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10",
      "srclang": "en-IE",
      "label": "Irish English",
      "status": "draft",
      "sources": [
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10",
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10"
      ],
      "default": false
  },
  {
      "id": "2d0cb632-8753-a68a-4143-aea0429eac7f",
      "account_id": "12345678910",
      "src": "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt*~hmac=8ae7069ac9717559e9439f5112ee133d955ec18a09563e7a3e2a48a83637c108",
      "srclang": "en-US",
      "label": "American English",
      "status": "draft",
      "sources": [
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt*~hmac=8ae7069ac9717559e9439f5112ee133d955ec18a09563e7a3e2a48a83637c108",
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt*~hmac=8ae7069ac9717559e9439f5112ee133d955ec18a09563e7a3e2a48a83637c108"
      ],
      "default": false
  }
]