Arbeiten mit Etiketten

Einleitung

Labels ähneln Tags. Sie können sie zu Videos hinzufügen und sie dann verwenden, um nach einer Gruppe von Videos zu suchen, oder sie haben einige entscheidende Vorteile:

• Labels werden auf Kontoebene erstellt und auf Videos angewendet.

  Dies ist besonders wichtig, wenn Sie Ihre Videobibliothek organisieren möchten. Wenn Sie beispielsweise versuchen, Ihre Videos mithilfe von Tags zu organisieren, können Sie Tags wie birds fish, und erstellen insects. Dann ist es ganz einfach, alle Ihre Vogelvideos zu suchen und zu finden und eine intelligente Wiedergabeliste für sie zu erstellen. Aber wenn ein Benutzer versehentlich ein neues Video hinzufügt bird anstatt birds , du hast jetzt ein neues Tag und das Video gehört nicht dir birds Sammlung.

  Wenn Sie birds stattdessen ein Label namens Called erstellen, kann nur dieses Label zu einem Video hinzugefügt werden. Sie können nicht versehentlich das nicht vorhandene Label hinzufügen birds stattdessen.

• Labels werden als hierarchischer Pfad erstellt, wie z /nature/birds/shore_birds.

  Das bedeutet, dass Sie einen teilweisen oder vollständigen Pfad suchen (oder eine Playlist basierend darauf erstellen) können:

  • q=labels:/nature- gibt alle Videos zurück, die das Label haben nature
  • q=labels:/nature/birds- gibt die zurück birds Untergruppe der nature Videos
  • q=labels:/nature/birds/shore_birds- gibt die zurück shore_birds Untergruppe der /nature/birds Videos

Etiketten erstellen und verwalten

Labels für Ihr Konto können mit dem erstellt und verwaltet werden CMS API /v1/accounts/{account_id}/labels Endpunkte.

Beachten Sie, dass alle unten gezeigten API-Endpunkte an die CMS-Basis-URL angehängt werden:

https://cms.api.brightcove.com

Label erstellen

Neue Labels können erstellt werden, indem der vollständige Pfad in einer POST Anfrage gesendet wird:

Beispielanforderungsendpunkt

/v1/accounts/1234567890/labels

Beispielanfragetext

{
  "path": "/nature/birds/shore_birds/"
}

Beachten Sie, dass alle Beschriftungen im Pfad, die noch nicht vorhanden sind, werden erstellt. Wenn Sie eine weitere Gruppe von hinzufügen möchten forest_birds, senden Sie:

{
  "path": "/nature/birds/forest_birds/"
}

Diesmal nur die forest_birds Unterlabel, wird erstellt, da nature und birds existieren bereits.

Wenn Sie eine neue Untergruppe hinzufügen sandpipers möchten shore_birds, senden Sie auf ähnliche Weise:

{
  "path": "/nature/birds/shore_birds/sandpipers"
}

Beispielantwort

{
  "path": "/nature/birds/shore_birds/sandpipers/"
}

Etiketten erhalten

Sie können alle Labels für ein Konto erhalten, indem Sie eine GET Anfrage:

Beispielanforderungsendpunkt

/v1/accounts/1234567890/labels

Beispielantwort

{
  "account_id": "57838016001",
  "labels": [
    "/nature/birds/",
    "/nature/birds/shore_birds/",
    "/nature/birds/forest_birds/",
    "/nature/mammals/seamammals/"
  ],
  "version": 4
}

Aktualisieren eines Etiketts

Um ein Label zu aktualisieren, senden Sie eine PATCH Anfrage zu:

/v1/accounts/{account_id}/labels/by_path/{path}

Beispielanforderungsendpunkt

/v1/accounts/1234567890/labels/by_path//nature/birds/shore_birds

Beispielanfragetext

{
  "new_label": "coastal_birds"
}

Notiere dass der new_label Wert ersetzt das letzte Element im {path} in der Anfrage enthalten. Wenn Sie also stattdessen durch /birds ersetzen möchten /avian, würden die Anfrage und der Text so aussehen:

Endpunkt

/v1/accounts/1234567890/labels/by_path//nature/birds/

Anfragetext

{
  "new_label": "avian"
}

Nach dieser Anfrage wird die coastal_birds Weg würde werden /nature/avian/coastal_birds. Der Pfad würde sich für alle zusätzlichen Unterlabels in der Hierarchie ändern, also /nature/birds/forest_birds würde werden /nature/avian/forest_birds

Die Antwort enthält die Anzahl der aktualisierten Labels.

Beispielantwort

{
  "path": "/nature/avian",
  "labels_updated": "2"
}

Label löschen

Das Löschen eines Labels verwendet a DELETE Anfrage an denselben Endpunkt wie die Aktualisierungsanfrage gesendet. Nur der Pfad, der mit diesem Sublabel endet (und Pfade mit zusätzlichen Sublabels) werden gelöscht, während höherstufige Labels beibehalten werden.

Angenommen, Sie haben diese drei Labelpfade:

      /nature/wildlife/avian/coastal_birds
      /nature/wildlife/avian/coastal_birds/sandpipers
      /nature/wildlife/avian/forest_birds
    

Senden DELETE Anfrage zu /v1/accounts/1234567890/labels/by_path//nature/wildlife/avian/coastal_birds würde die ersten obigen Pfade löschen, aber es würde den dritten nicht beeinflussen.

Labels zu Videos hinzufügen und aktualisieren

Fügen Sie Labels zu Videos als ein Array vollständiger Labelpfade hinzu:

[
      "/nature/wildlife/avian/coastal_birds",
      "/nature/wildlife/avian/coastal_birds/sandpipers"
]

Das Label-Array kann in einer Anfrage zum Erstellen eines Videos (POST) oder einer Videoaktualisierungsanfrage (PATCH) enthalten sein.

Um die Videolabels zu aktualisieren, senden Sie das vollständige, aktualisierte Videosarray in a Anfrage zum Update des Videos (PATCH). Um zum Beispiel das hinzuzufügen, würden Sie das /nature/wildlife/avian/forest_birds Array senden:

[
      "/nature/wildlife/avian/coastal_birds",
      "/nature/wildlife/avian/coastal_birds/sandpipers",
      "/nature/wildlife/avian/forest_birds"
]

Suche nach Videos nach Labels

Sie können nach Videos suchen nach labels ebenso wie andere Felder, die für die Suche unterstützt werden. Wie in der Einleitung erwähnt, filtert das Hinzufügen von Unterlabels zum Suchpfad die Suchergebnisse:

Einschränkungen

• Einem Konto können maximal 10.000 Labels hinzugefügt werden
• Etiketten können nur über die API verwaltet werden. Derzeit gibt es keine Option in der Benutzeroberfläche
• Die Suche nach Labels wird derzeit von der Nur v1-Suchsyntax
• Etiketten sind nicht in den Video-Metadaten enthalten, die mit einem Partner geteilt werden Teilen von Medien.