Gestión de campos personalizados mediante la API de CMS

Este tema explica cómo usar la API de CMS para administrar los campos personalizados de una cuenta.

Introducción

Los campos personalizados le permiten agregar metadatos personalizados a sus videos para satisfacer las necesidades de su organización. Pueden ser útiles para organizar videos, agruparlos para listas de reproducción y muchas otras cosas. Puede utilizar la API de CMS para crear, actualizar, eliminar y enumerar los campos personalizados de una cuenta, lo que resulta especialmente útil si está integrando Video Cloud con un CMS o algún otro sistema.

Crea campos personalizados

Para crear un campo personalizado, envíe un POST solicitud con los detalles del campo personalizado.

Solicitar URL

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

Método

POST

Cuerpo de solicitud de muestra

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Ejemplo de respuesta (código de estado de éxito: 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Solicitar campos de cuerpo
Campo Tipo Descripción
id cuerda Nombre interno del campo. Se puede actualizar. Tenga en cuenta que actualizarlo activará un proceso interno para actualizar el id en cualquier video que tenga el campo personalizado.

Requisitos:

  • todo en minúsculas
  • sin espacios (use guión bajo [_] en su lugar)
  • solo letras y números - sin caracteres especiales
  • longitud máxima: 128 caracteres de un solo byte
  • debe ser único entre todos los campos personalizados de la cuenta
  • no debe ser uno de los nombres reservados
display_name cuerda Nombre para mostrar de las IU. Se puede actualizar.

Requisitos:

  • longitud máxima: 128 caracteres de un solo byte
description cuerda Descripción del campo. Se puede actualizar.

Requisitos:

  • longitud máxima: 500 caracteres de un solo byte
type enum (cadena) El tipo de campo. no se puede actualizar.

Requisitos:

  • los valores permitidos son: string o enum (no entre mayúsculas y minúsculas)
required booleano Si el campo es obligatorio para que se active el video. Se puede actualizar..

Por defecto: false
enum_values matriz (cadenas) Valores permitidos para un enum campo. Se puede actualizar.

Requisitos:

  • hasta 150 elementos (nota: este valor máximo se puede aumentar hasta 1000; cree una solicitud de soporte si desea aumentarlo)
  • cada elemento tiene una longitud máxima de 100 caracteres de un solo byte
  • requerido para enum escribir campos
  • no permitido para string escribir campos

Obtener campos personalizados

Obtener una lista de todos los campos personalizados

Para obtener una matriz de todos los campos personalizados, envía un GET solicitud con los detalles del campo personalizado.

Solicitar URL

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

Método

GET
Ejemplo de respuesta (código de estado de éxito: 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"]
}]

Obtener un campo personalizado

Para obtener una matriz de todos los campos personalizados, envía un GET solicitud con los detalles del campo personalizado.

Solicitar URL

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

Método

GET
Ejemplo de respuesta (código de estado de éxito: 200) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Campos de respuesta
Campo Tipo Descripción
id cuerda Nombre interno del campo. Se puede actualizar.
display_name cuerda Nombre para mostrar de las IU. Se puede actualizar.
description cuerda Descripción del campo. Se puede actualizar.
type enum (cadena) El tipo de campo (string o enum). no se puede actualizar.
required booleano Si el campo es obligatorio para que se active el video. Se puede actualizar..
enum_values matriz (cadenas) Valores permitidos para un enum campo. Se puede actualizar.

Actualizar campos personalizados

Para actualizar un campo personalizado, envíe un PATCH solicitud con los detalles del campo personalizado.

Solicitar URL

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

Método

PATCH

Cuerpo de solicitud de muestra

tipo de enumeración

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Ejemplo de respuesta (código de estado de éxito: 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}

tipo de cadena

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
}
Ejemplo de respuesta (código de estado de éxito: 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "string",
  "required" : true
}
Solicitar campos de cuerpo
Campo Tipo Descripción
id cuerda Nombre interno del campo. Se puede actualizar.Nota que actualizarlo activará un proceso interno para actualizar el id en cualquier video que tenga el campo personalizado.

Requisitos:

  • todo en minúsculas
  • sin espacios (use guión bajo [_] en su lugar)
  • solo letras y números - sin caracteres especiales
  • longitud máxima: 128 caracteres de un solo byte
  • debe ser único entre todos los campos personalizados de la cuenta
display_name cuerda Nombre para mostrar de las IU. Se puede actualizar.

Requisitos:

  • longitud máxima: 128 caracteres de un solo byte
description cuerda Descripción del campo. Se puede actualizar.

Requisitos:

  • longitud máxima: 500 caracteres de un solo byte
required booleano Si el campo es obligatorio para que se active el video. Se puede actualizar..

Por defecto: false
enum_values matriz (cadenas) Valores permitidos para un enum campo. Se puede actualizar.

Requisitos:

  • hasta 150 artículos
  • cada elemento tiene una longitud máxima de 100 caracteres de un solo byte
  • requerido para enum escribir campos
  • no permitido para string escribir campos

Eliminar campos personalizados

Para crear un campo personalizado, envíe un Delete solicitud con los detalles del campo personalizado.

Solicitar URL

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

Método

DELETE

Cuerpo de la solicitud: ninguno

Respuesta: 204 (sin contenido)