Agregar metadatos personalizados a clips, listas de reproducción o programas, que se pueden recuperar a través de las API de Omny y RSS
Lo guiaremos a través de la creación y edición de campos personalizados para sus clips, listas de reproducción o programas, configurándolos como obligatorios u opcionales y una explicación de cómo se comporta la API cuando se trata de campos personalizados también.
Configuración de campos personalizados
Vaya a Configuración de organización, red o programa, según el ámbito para el que esté creando campos personalizados. La estructura sigue la jerarquía de herencia de configuración de Omny, como se explica aquí.
Desde el menú Campos personalizados, puede ver sus campos personalizados existentes y hacer clic en "Crear campo" para crear uno nuevo a nivel de clip, lista de reproducción o programa.
Asigne al campo un nombre para mostrar, que se agregará a la interfaz de usuario de la página de detalles del clip, programa o lista de reproducción, y un nombre de API, que es la forma en que se etiquetará este campo en la administración y (opcionalmente) en la API de consumidor o en la fuente RSS.
NOTA: Tenga en cuenta que si un campo personalizado se puede ver en la API de consumidor o en la fuente RSS, trate el nombre y el contenido del campo como públicos.
Elija el tipo de respuesta de contenido que aceptará este campo, Texto o Menú desplegable.
Las opciones desplegables se pueden enumerar en el cuadro que se muestra a continuación, cada opción en una nueva línea.
Elija si este campo es obligatorio para guardar un clip, una lista de reproducción o un programa.
NOTA: Si es necesario, el valor del campo personalizado deberá agregarse a cualquier clip, lista de reproducción o programa (según el alcance de su campo personalizado) dentro de la organización, red o programa antes de publicarlo (es decir, no listado o público) y guardarlo. Los clips privados y las listas de reproducción no requieren la introducción de los campos obligatorios antes de guardarlos. Será necesario ingresar un valor antes de guardar un nuevo programa, ya que esas opciones de visibilidad no se aplican a nivel de programa.
Opcionalmente, agregue una descripción para este campo personalizado para ayudar a los usuarios de su cuenta a utilizar este campo personalizado.
Guarde los cambios.
Uso de campos personalizados
Cuando los campos personalizados estén activos, habrá una nueva adición a la página de detalles del clip, la lista de reproducción o el programa.
Los campos obligatorios están marcados con (obligatorio) y si no se introduce ninguna selección o datos en un campo obligatorio, esto evitará que un usuario publique o guarde.
Recuperación de campos personalizados
Los clips con campos personalizados se incluirán en el servicio de webhooks de Omny o en las API de Omny, tanto en Administración como (opcionalmente) en la API de consumidor .
También puede agregar opcionalmente sus campos personalizados a sus fuentes RSS. Si opta por esta opción, los campos personalizados se mostrarán en este formato:
<omny:clipCustomField key="my-test-clip-field" value="test"/>
<omny:playlistCustomField key="my-test-playlist-custom-field" value="test"/>
<omny:programCustomField key="my-test-program-custom-field" value="test"/>API de gestión
Los campos personalizados también se pueden configurar y actualizar en clips a través de la API de administración, pero las reglas de validación difieren ligeramente. Estos se documentan a continuación. Tenga en cuenta que los valores desplegables no se validan cuando se establecen a través de la API.
Para establecer campos personalizados en un clip, inclúyalos en la propiedad CustomFieldData de la siguiente manera:
POST /v0/clips/{clipId}
{
"Id" : "Guid",
...
"CustomFieldData" :
{
"my-custom-field" : "value1",
"another-custom-field" : "value2"
}
}Si se omite algún campo personalizado de una actualización o se establece en nulo, se conserva su valor existente. Del mismo modo, pasar "CustomFieldData": null conservará todos los datos de campo personalizados.
Para borrar un campo personalizado, debe pasar una cadena vacía en la solicitud de API para ese campo, de la siguiente manera:
POST /v0/clips/{clipId}
{
"Id" : "Guid",
...
"CustomFieldData" :
{
"my-custom-field" : ""
}
}Se debe adoptar el mismo enfoque para los campos personalizados a nivel de lista de reproducción y a nivel de programa.
Crear validación de extremo
Al crear un nuevo clip, lista de reproducción o programa, todos los campos marcados como obligatorios son obligatorios si la creación también publica el clip o la lista de reproducción. Un programa se validará cuando se guarde.
Actualizar la validación del extremo
Al actualizar un clip o una lista de reproducción que ya está publicado, no es necesario agregar valores para los nuevos campos personalizados necesarios para la publicación. Los campos obligatorios que tienen valores existentes no se pueden borrar, solo se pueden cambiar.
Publicar validación de extremos
Todos los campos personalizados obligatorios se validan al publicar un clip o una lista de reproducción a través del extremo de publicación.
Si tiene alguna pregunta, póngase en contacto con el servicio de asistencia técnica de Omny.