使用 CMS API 管理自定義字段

本主題說明如何使用 CMS API 來管理帳戶的自定義字段。

簡介

自定義字段允許您將自定義元數據添加到您的視頻以滿足您組織的需求。它們可用於組織視頻、將它們分組以播放列表，以及許多其他事情。您可以使用 CMS API 創建、更新、刪除和列出帳戶的自定義字段，這在您將 Video Cloud 與 CMS 或其他系統集成時特別有用。

創建自定義字段

要創建自定義字段，您發送POST帶有自定義字段詳細信息的請求。

請求網址

https://cms.api.brightcove.com/v1/accounts/{account_id}/video_fields/custom_fields

方法

POST

請求主體範例

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
示例響應（成功狀態代碼：201） 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
請求主體欄位
欄位 類型 描述
id 串 字段的內部名稱。可以更新。請注意，更新它會觸發一個內部過程來更新id在任何具有自定義字段的視頻中。

要求：

  • 全部小寫
  • 沒有空格（改用下劃線 [_]）
  • 僅限字母和數字 - 無特殊字符
  • 最長長度：128個單字節字符
  • 在帳戶的所有自定義字段中必須是唯一的
  • 不能是 保留名稱之一
display_name 串 UI 的顯示名稱。可以更新。

要求：

  • 最長長度：128個單字節字符
description 串 字段說明。可以更新。

要求：

  • 最長長度：500 個單字節字符
type 枚舉（字符串） 字段類型。無法更新。

要求：

  • 允許的值為：string或者enum（不區分大小寫）
required 布林 激活視頻是否需要該字段。可以更新。。

默認：false
enum_values 數組（字符串） 的允許值enum場地。可以更新。

要求：

  • 最多 150 個項目（注意：此最大值可以增加到 1000 - 如果您希望增加它，請創建 支持請求 ）
  • 每個項目的最大長度為 100 個單字節字符
  • 需要enum類型字段
  • 不允許string類型字段

獲取自定義字段

獲取所有自定義字段的列表

要獲取所有自定義字段的數組，您發送GET帶有自定義字段詳細信息的請求。

請求網址

https://cms.api.brightcove.com/v1/accounts/{account_id}/video_fields/custom_fields

方法

GET
示例響應（成功狀態代碼：200） 
[{
  "id" : "display_name_1",
  "display_name" : "Display name 1",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
},
{
  "id" : "display_name_2",
  "display_name" : "Display name 2",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}]

獲取一個自定義字段

要獲取所有自定義字段的數組，您發送GET帶有自定義字段詳細信息的請求。

請求網址

https://cms.api.brightcove.com/v1/accounts/{account_id}/video_fields/custom_fields/{custom_field_id}

方法

GET
示例響應（成功狀態代碼：200） 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
響應字段
欄位 類型 描述
id 串 字段的內部名稱。可以更新。
display_name 串 UI 的顯示名稱。可以更新。
description 串 字段說明。可以更新。
type 枚舉（字符串） 字段類型（string或者enum ).無法更新。
required 布林 激活視頻是否需要該字段。可以更新。。
enum_values 數組（字符串） 的允許值enum場地。可以更新。

更新自定義字段

要更新自定義字段，您發送PATCH帶有自定義字段詳細信息的請求。

請求網址

https://cms.api.brightcove.com/v1/accounts/{account_id}/video_fields/custom_fields/{custom_field_id}

方法

PATCH

請求主體範例

枚舉類型

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
示例響應（成功狀態代碼：201） 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}

字符串類型

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
}
示例響應（成功狀態代碼：201） 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "string",
  "required" : true
}
請求主體欄位
欄位 類型 描述
id 串 字段的內部名稱。可以更新。筆記更新它會觸發一個內部過程來更新id在任何具有自定義字段的視頻中。

要求：

  • 全部小寫
  • 沒有空格（改用下劃線 [_]）
  • 僅限字母和數字 - 無特殊字符
  • 最長長度：128個單字節字符
  • 在帳戶的所有自定義字段中必須是唯一的
display_name 串 UI 的顯示名稱。可以更新。

要求：

  • 最長長度：128個單字節字符
description 串 字段說明。可以更新。

要求：

  • 最長長度：500 個單字節字符
required 布林 激活視頻是否需要該字段。可以更新。。

默認：false
enum_values 數組（字符串） 的允許值enum場地。可以更新。

要求：

  • 最多 150 個項目
  • 每個項目的最大長度為 100 個單字節字符
  • 需要enum類型字段
  • 不允許string類型字段

刪除自定義字段

要創建自定義字段，您發送Delete帶有自定義字段詳細信息的請求。

請求網址

hhttps://cms.api.brightcove.com/v1/accounts/{account_id}/video_fields/custom_fields/{custom_field_id}

方法

DELETE

請求正文：無

回應：204（無內容）