Einführung
Beschriftungen ähneln Tags. Sie können sie zu Videos hinzufügen und dann zur Suche nach einer Gruppe von Videos verwenden. Sie haben jedoch einige eindeutige Vorteile:
-
Beschriftungen 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 erstellen
birds
,fish
, undinsects
. Dann ist es einfach, alle Ihre Vogelvideos zu suchen und zu finden und eine intelligente Wiedergabeliste für sie zu erstellen. Wenn ein Benutzer jedoch versehentlich ein neues Video hinzufügt, tippt erbird
stattbirds
Sie haben jetzt ein neues Tag und das Video gehört nicht zu Ihrembirds
Sammlung.Wenn Sie ein Label namens erstellen
birds
Stattdessen kann einem Video nur dieses Label hinzugefügt werden. Sie können das nicht vorhandene Etikett nicht versehentlich hinzufügenbirds
stattdessen. -
Beschriftungen werden als hierarchischer Pfad erstellt, z
/nature/birds/shore_birds
.Dies bedeutet, dass Sie einen Teil- oder vollständigen Pfad suchen (oder eine Wiedergabeliste basierend darauf erstellen) können:
q=labels:/nature
- Gibt alle Videos mit dem Label zurücknature
q=labels:/nature/birds
- gibt die zurückbirds
Untergruppe dernature
Videosq=labels:/nature/birds/shore_birds
- gibt die zurückshore_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
Etikett erstellen
Neue Beschriftungen können erstellt werden, indem der vollständige Pfad in a gesendet wird POST
Anfrage:
Beispielanforderungsendpunkt
/v1/accounts/1234567890/labels
Beispiel für einen Anfragetext
{
"path": "/nature/birds/shore_birds/"
}
Beachten Sie, dass aller Beschriftungen im Pfad, die noch nicht vorhanden sind, werden erstellt. Wenn Sie eine weitere Gruppe von hinzufügen möchten forest_birds
würden Sie senden:
{
"path": "/nature/birds/forest_birds/"
}
Diesmal nur die forest_birds
Unterlabel wird erstellt, da nature
bzw. unter birds
existieren bereits.
Ebenso, wenn Sie eine neue Untergruppe hinzufügen möchten sandpipers
zu shore_birds
würden Sie senden:
{
"path": "/nature/birds/shore_birds/sandpipers"
}
Beispielantwort
{
"path": "/nature/birds/shore_birds/sandpipers/"
}
Etiketten bekommen
Sie können alle Labels für ein Konto erhalten, indem Sie eine senden 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
}
Etikett aktualisieren
Um ein Etikett zu aktualisieren, senden Sie ein PATCH
Anfrage zu:
/v1/accounts/{account_id}/labels/by_path/{path}
Beispielanforderungsendpunkt
/v1/accounts/1234567890/labels/by_path//nature/birds/shore_birds
Beispiel für einen Anfragetext
{
"new_label": "coastal_birds"
}
Beachten Sie, dass die new_label
Wert ersetzt das letzte Element in der {path}
in der Anfrage enthalten. Also, wenn Sie stattdessen ersetzen wollten /birds
mit /avian
, die Anfrage und der Text würden so aussehen:
Endpunkt
/v1/accounts/1234567890/labels/by_path//nature/birds/
Anfrage Körper
{
"new_label": "avian"
}
Nach dieser Anfrage wird die coastal_birds
Weg würde werden /nature/wildlife/avian/coastal_birds
. Der Pfad würde sich also für alle zusätzlichen Unterbezeichnungen in der Hierarchie ändern /nature/birds/forest_birds
würde werden /nature/wildlife/avian/forest_birds
Die Antwort enthält die Anzahl der Etiketten, die aktualisiert wurden.
Beispielantwort
{
"path": "/nature/avian",
"labels_updated": "2"
}
Löschen Sie ein Etikett
Beim Löschen eines Etiketts wird a verwendet DELETE
Anforderung an denselben Endpunkt gesendet wie die Aktualisierungsanforderung. Nur der Pfad, der mit dieser Unterbezeichnung endet (und Pfade mit zusätzlichen Unterbezeichnungen), wird gelöscht, während übergeordnete Bezeichnungen beibehalten werden.
Angenommen, Sie haben diese drei Beschriftungspfade:
/nature/wildlife/avian/coastal_birds
/nature/wildlife/avian/coastal_birds/sandpipers
/nature/wildlife/avian/forest_birds
Senden eines DELETE
Anfrage zu /v1/accounts/1234567890/labels/by_path//nature/wildlife/avian/coastal_birds
würde die ersten Pfade oben löschen, aber den dritten nicht beeinflussen.
Hinzufügen und Aktualisieren von Labels zu Videos
Hinzufügen von Beschriftungen zu Videos als Array vollständiger Beschriftungspfade:
[
"/nature/wildlife/avian/coastal_birds",
"/nature/wildlife/avian/coastal_birds/sandpipers"
]
Das Label-Array kann in a enthalten sein Videoanforderung (POST) erstellen oder Video (PATCH) -Anforderung aktualisieren.
Senden Sie zum Aktualisieren der Video-Labels das vollständige, aktualisierte Video-Array in a Video (PATCH) -Anforderung aktualisieren. So zum Beispiel, um die hinzuzufügen /nature/wildlife/avian/forest_birds
würden Sie das 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 Einführung erwähnt, werden die Suchergebnisse durch Hinzufügen von Unterbezeichnungen zum Suchpfad gefiltert:
Beispielsuche | Was es zurückgibt |
---|---|
q=labels:/nature |
Alle Videos mit Beschriftungspfaden beginnend mit /nature |
q=labels:/nature/wildlife |
Alle Videos mit Beschriftungspfaden beginnend mit /nature/wildlife |
q=labels:/nature/wildlife/avian |
Alle Videos mit Beschriftungspfaden beginnend mit /nature/wildlife/avian |
Einschränkungen
- Einem Konto können maximal 10,000 Etiketten hinzugefügt werden
- Die Suche nach Labels wird derzeit von der unterstützt Nur v1-Suchsyntax
- Etiketten sind in den Video-Metadaten enthalten, die mit einem Partner geteilt werden Media Sharing.