Benutzerdefinierte Felder mit der CMS-API verwalten

In diesem Thema wird erklärt, wie Sie die CMS-API verwenden, um die benutzerdefinierten Felder für ein Konto zu verwalten.

Einleitung

Mit benutzerdefinierten Feldern können Sie Ihren Videos benutzerdefinierte Metadaten hinzufügen, um die Anforderungen Ihrer Organisation zu erfüllen. Sie können nützlich sein, um Videos zu organisieren, sie für Wiedergabelisten zu gruppieren und vieles mehr. Sie können die CMS-API verwenden, um die benutzerdefinierten Felder für ein Konto zu erstellen, zu aktualisieren, zu löschen und aufzulisten, was besonders hilfreich ist, wenn Sie Video Cloud in ein CMS oder ein anderes System integrieren.

Benutzerdefinierte Felder erstellen

Um ein benutzerdefiniertes Feld zu erstellen, senden Sie eine POST Anfrage mit den benutzerdefinierten Felddetails.

Anfrage-URL

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

Methode

POST

Beispielanfragetext

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Beispielantwort (Erfolgsstatuscode: 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Anfragetextfelder
Feld Typ Beschreibung
id Schnur Interner Name für das Feld. Kann aktualisiert werden. Beachten Sie, dass bei der Aktualisierung ein interner Prozess zur Aktualisierung id in allen Videos ausgelöst wird, die das benutzerdefinierte Feld enthalten.

Anforderungen:

  • alle Kleinbuchstaben
  • keine Leerzeichen (stattdessen Unterstrich [_] verwenden)
  • nur Buchstaben und Zahlen - keine Sonderzeichen
  • maximale Länge: 128 Einzelbyte-Zeichen
  • muss unter allen benutzerdefinierten Feldern des Kontos eindeutig sein
  • darf nicht einer der reservierten Namen sein
display_name Schnur Anzeigename für UIs. Kann aktualisiert werden.

Anforderungen:

  • maximale Länge: 128 Einzelbyte-Zeichen
description Schnur Beschreibung des Feldes. Kann aktualisiert werden.

Anforderungen:

  • maximale Länge: 500 Einzelbyte-Zeichen
type enum (Zeichenfolge) Der Typ des Feldes. Kann nicht aktualisiert werden.

Anforderungen:

  • erlaubte Werte sind: string oder enum(Groß- und Kleinschreibung wird nicht beachtet)
required boolescher Wert Angabe, ob das Feld erforderlich ist, damit das Video aktiviert werden kann. Kann aktualisiert werden.

Standard: false
enum_values array (Zeichenketten) Zulässige Werte für ein enum Feld. Kann aktualisiert werden.

Anforderungen:

  • bis zu 150 Artikel (Hinweis: Dieser Höchstwert kann auf bis zu 1000 erhöht werden — erstellen Sie eine Support-Anfrage, wenn Sie ihn erhöhen möchten)
  • jedes Element hat eine maximale Länge von 100 Ein-Byte-Zeichen
  • erforderlich für enum Typfelder
  • für string Typfelder nicht zulässig

Benutzerdefinierte Felder abrufen

Abrufen einer Liste aller benutzerdefinierten Felder

Um ein Array aller benutzerdefinierten Felder zu erhalten, senden Sie eine GET Anfrage mit den benutzerdefinierten Felddetails.

Anfrage-URL

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

Methode

GET
Beispielantwort (Erfolgsstatuscode: 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"]
}]

Ein benutzerdefiniertes Feld erhalten

Um ein Array aller benutzerdefinierten Felder zu erhalten, senden Sie eine GET Anfrage mit den benutzerdefinierten Felddetails.

Anfrage-URL

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

Methode

GET
Beispielantwort (Erfolgsstatuscode: 200) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Antwortfelder
Feld Typ Beschreibung
id Schnur Interner Name für das Feld. Kann aktualisiert werden.
display_name Schnur Anzeigename für UIs. Kann aktualisiert werden.
description Schnur Beschreibung des Feldes. Kann aktualisiert werden.
type enum (Zeichenfolge) Der Feldtyp (string oder enum). Kann nicht aktualisiert werden.
required boolescher Wert Angabe, ob das Feld erforderlich ist, damit das Video aktiviert werden kann. Kann aktualisiert werden.
enum_values array (Zeichenketten) Zulässige Werte für ein enum Feld. Kann aktualisiert werden.

Benutzerdefinierte Felder aktualisieren

Um ein benutzerdefiniertes Feld zu aktualisieren, senden Sie eine PATCH Anfrage mit den benutzerdefinierten Felddetails.

Anfrage-URL

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

Methode

PATCH

Beispielanfragetext

Enum-Typ

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}
Beispielantwort (Erfolgsstatuscode: 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "enum",
  "required" : true,
  "enum_values" : ["EnumValue1", "EnumValue2"]
}

String-Typ

{      
  "id": “internal_name”,
  "display_name" : "Display name",
  "description" : "Custom field description",
  "required" : true,
}
Beispielantwort (Erfolgsstatuscode: 201) 
{
  "id" : "internal_name",
  "display_name" : "Display name",
  "description" : "Custom field description",
  "type" : "string",
  "required" : true
}
Anfragetextfelder
Feld Typ Beschreibung
id Schnur Interner Name für das Feld. Kann aktualisiert werden.Beachten Sie, dass bei der Aktualisierung ein interner Prozess zur Aktualisierung id in allen Videos ausgelöst wird, die das benutzerdefinierte Feld enthalten.

Anforderungen:

  • alle Kleinbuchstaben
  • keine Leerzeichen (stattdessen Unterstrich [_] verwenden)
  • nur Buchstaben und Zahlen - keine Sonderzeichen
  • maximale Länge: 128 Einzelbyte-Zeichen
  • muss unter allen benutzerdefinierten Feldern des Kontos eindeutig sein
display_name Schnur Anzeigename für UIs. Kann aktualisiert werden.

Anforderungen:

  • maximale Länge: 128 Einzelbyte-Zeichen
description Schnur Beschreibung des Feldes. Kann aktualisiert werden.

Anforderungen:

  • maximale Länge: 500 Einzelbyte-Zeichen
required boolescher Wert Angabe, ob das Feld erforderlich ist, damit das Video aktiviert werden kann. Kann aktualisiert werden.

Standard: false
enum_values array (Zeichenketten) Zulässige Werte für ein enum Feld. Kann aktualisiert werden.

Anforderungen:

  • bis zu 150 Artikel
  • jedes Element hat eine maximale Länge von 100 Ein-Byte-Zeichen
  • erforderlich für enum Typfelder
  • für string Typfelder nicht zulässig

Benutzerdefinierte Felder löschen

Um ein benutzerdefiniertes Feld zu erstellen, senden Sie eine Delete Anfrage mit den benutzerdefinierten Felddetails.

Anfrage-URL

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

Methode

DELETE

Anfragetext: keiner

Antwort: 204 (ohne Inhalt)