Gestion des champs personnalisés à l'aide de l'API CMS

Cette rubrique explique comment utiliser l'API CMS pour gérer les champs personnalisés d'un compte.

Introduction

Les champs personnalisés vous permettent d'ajouter des métadonnées personnalisées à vos vidéos pour répondre aux besoins de votre organisation. Ils peuvent être utiles pour organiser les vidéos, les regrouper dans des listes de lecture et bien d'autres choses encore. Vous pouvez utiliser l'API CMS pour créer, mettre à jour, supprimer et répertorier les champs personnalisés d'un compte, ce qui est particulièrement utile si vous intégrez Video Cloud à un CMS ou à un autre système.

Créer des champs personnalisés

Pour créer un champ personnalisé, vous envoyez une POST demande avec les détails du champ personnalisé.

URL de demande

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

Méthode

POST

Exemple de corps de requête

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Exemple de réponse (code de statut de réussite : 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Champs du corps de la demande
Champ Type Description
id chaîne Nom interne du champ. Peut être mis à jour. Notez que sa mise à jour déclenchera un processus interne pour mettre à jour le id dans toutes les vidéos contenant le champ personnalisé.

Exigences :

  • tout en minuscules
  • pas d'espaces (utiliser le trait de soulignement [_] à la place)
  • lettres et chiffres uniquement - pas de caractères spéciaux
  • longueur max : 128 caractères d'un seul octet
  • doit être unique parmi tous les champs personnalisés du compte
  • ne doit pas être un des noms réservés
display_name chaîne Nom d'affichage pour les interfaces utilisateur. Peut être mis à jour.

Exigences :

  • longueur max : 128 caractères d'un seul octet
description chaîne Description du champ. Peut être mis à jour.

Exigences :

  • longueur max : 500 caractères d'un seul octet
type enum (chaîne) Le type de champ. Ne peut être mis à jour.

Exigences :

  • les valeurs autorisées sont : string ou enum(ne distingue pas les majuscules et minuscules)
required booléen Si le champ est obligatoire pour que la vidéo soit activée. Peut être mis à jour .

Par défaut : false
enum_values tableau (chaînes) Valeurs autorisées pour un enum champ. Peut être mis à jour.

Exigences :

  • jusqu'à 150 articles (note : cette valeur maximale peut être augmentée jusqu'à 1000 - créez une demande d'assistance si vous souhaitez l'augmenter)
  • chaque élément a une longueur maximale de 100 caractères d'un seul octet
  • obligatoire pour les champs enum de type
  • non autorisé pour les champs string de type

Obtenir des champs personnalisés

Obtenir une liste de tous les champs personnalisés

Pour obtenir un tableau de tous les champs personnalisés, vous envoyez une GET demande avec les détails des champs personnalisés.

URL de demande

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

Méthode

GET
Exemple de réponse (code de statut de réussite : 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"]
}]

Obtenir un champ personnalisé

Pour obtenir un tableau de tous les champs personnalisés, vous envoyez une GET demande avec les détails des champs personnalisés.

URL de demande

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

Méthode

GET
Exemple de réponse (code de statut de réussite : 200) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Champs de réponse
Champ Type Description
id chaîne Nom interne du champ. Peut être mis à jour.
display_name chaîne Nom d'affichage pour les interfaces utilisateur. Peut être mis à jour.
description chaîne Description du champ. Peut être mis à jour.
type enum (chaîne) Type de champ (string ou enum). Ne peut être mis à jour.
required booléen Si le champ est obligatoire pour que la vidéo soit activée. Peut être mis à jour .
enum_values tableau (chaînes) Valeurs autorisées pour un enum champ. Peut être mis à jour.

Mise à jour des champs personnalisés

Pour mettre à jour un champ personnalisé, vous envoyez une PATCH demande avec les détails du champ personnalisé.

URL de demande

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

Méthode

PATCH

Exemple de corps de requête

Type d'énumération

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Exemple de réponse (code de statut de réussite : 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}

Type de chaîne

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
}
Exemple de réponse (code de statut de réussite : 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "string",
  "required" : true
}
Champs du corps de la demande
Champ Type Description
id chaîne Nom interne du champ. Peut être mis à jour.Notez que sa mise à jour déclenchera un processus interne pour mettre à jour le id dans toutes les vidéos contenant le champ personnalisé.

Exigences :

  • tout en minuscules
  • pas d'espaces (utiliser le trait de soulignement [_] à la place)
  • lettres et chiffres uniquement - pas de caractères spéciaux
  • longueur max : 128 caractères d'un seul octet
  • doit être unique parmi tous les champs personnalisés du compte
display_name chaîne Nom d'affichage pour les interfaces utilisateur. Peut être mis à jour.

Exigences :

  • longueur max : 128 caractères d'un seul octet
description chaîne Description du champ. Peut être mis à jour.

Exigences :

  • longueur max : 500 caractères d'un seul octet
required booléen Si le champ est obligatoire pour que la vidéo soit activée. Peut être mis à jour .

Par défaut : false
enum_values tableau (chaînes) Valeurs autorisées pour un enum champ. Peut être mis à jour.

Exigences :

  • jusqu'à 150 articles
  • chaque élément a une longueur maximale de 100 caractères d'un seul octet
  • obligatoire pour les champs enum de type
  • non autorisé pour les champs string de type

Supprimer des champs personnalisés

Pour créer un champ personnalisé, vous envoyez une Delete demande avec les détails du champ personnalisé.

URL de demande

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

Méthode

DELETE

Corps de la requête : aucun

Réponse: 204 (sans contenu)