서문
사용자 지정 필드를 사용하면 비디오에 사용자 지정 메타데이터를 추가하여 조직의 요구 사항을 충족할 수 있습니다. 비디오 구성, 재생 목록 그룹화 및 기타 여러 작업에 유용할 수 있습니다. CMS API를 사용하여 계정에 대한 사용자 정의 필드를 생성, 업데이트, 삭제 및 나열할 수 있습니다. 이는 Video Cloud를 CMS 또는 일부 다른 시스템과 통합하는 경우 특히 유용합니다.
사용자 지정 필드 만들기
사용자 지정 필드를 만들려면 사용자 지정 필드 세부 정보가 포함된POST요청을 보내야 합니다.
요청 URL
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
요구 사항:
|
display_name |
끈 |
UI의 표시 이름입니다. 업데이트할 수 있습니다.
요구 사항:
|
description |
끈 |
필드에 대한 설명입니다. 업데이트할 수 있습니다.
요구 사항:
|
type |
열거 형 (문자열) |
필드의 유형입니다. 업데이트할 수 없습니다 .
요구 사항:
|
required |
부울 |
동영상을 활성화하는 데 필드가 필요한지 여부입니다. 업데이트 가능..
기본: |
enum_values |
배열(문자열) |
enum필드에 허용되는 값입니다. 업데이트할 수 있습니다.
요구 사항:
|
사용자 정의 필드 가져오기
모든 사용자 정의 필드 목록 가져오기
모든 사용자 지정 필드의 배열을 가져오려면 사용자 지정 필드 세부 정보가 포함된GET요청을 보내야 합니다.
요청 URL
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요청을 보내야 합니다.
요청 URL
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요청을 보내야 합니다.
요청 URL
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
요구 사항:
|
display_name |
끈 |
UI의 표시 이름입니다. 업데이트할 수 있습니다.
요구 사항:
|
description |
끈 |
필드에 대한 설명입니다. 업데이트할 수 있습니다.
요구 사항:
|
required |
부울 |
동영상을 활성화하는 데 필드가 필요한지 여부입니다. 업데이트 가능..
기본: |
enum_values |
배열(문자열) |
enum필드에 허용되는 값입니다. 업데이트할 수 있습니다.
요구 사항:
|
사용자 정의 필드 삭제
사용자 지정 필드를 만들려면 사용자 지정 필드 세부 정보가 포함된Delete요청을 보내야 합니다.
요청 URL
hhttps://cms.api.brightcove.com/v1/accounts/{account_id}/video_fields/custom_fields/{custom_field_id}방법
DELETE