Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    Übersicht: Player-Verwaltungs-API

    Spielermanagement bezieht sich auf die Erstellung, Bearbeitung und Verwaltung von Spielern als Ressource für Publisher. Die Spielerverwaltung wird durch eine serverseitige REST-API erreicht, die es ihren Kunden ermöglicht, Player-Instanzen zu erstellen, zu konfigurieren, in der Vorschau anzuzeigen und zu veröffentlichen
     

    Einführung

    Das Erstellen und Aktualisieren von Spielern erfolgt in zwei Phasen. Anstatt alle Änderungen automatisch auf Produktionsplayer anzuwenden, werden die Änderungen in eine Vorschau unterteilt und veröffentlicht. Sie können jetzt alle gewünschten Aktualisierungen an Ihrem Vorschau-Player vornehmen, ohne die Anzeige Ihrer Endbenutzer zu beeinträchtigen. Sie können die Änderungen jederzeit veröffentlichen.

    Mit der Player-Verwaltungs-API kann ein Benutzer:

    1. Erstellen eines Players
    2. Die Einstellungen eines Players anzeigen
    3. Ändern Sie die Einstellungen eines Players
    4. Listen Sie alle mit dem Publisher verbundenen Player auf
    5. Einen Player veröffentlichen, um diesen Verbrauchern bereitzustellen

    Siehe auch die API-Referenz.

    Basis-URL

    Die Basis-URL für die API lautet:

        https://players.api.brightcove.com/v2

    Einführung

    Das Player-Management-System besteht aus drei Schlüsselobjekten. Sie sind die Standardvorlage, Spieler und untergeordnete Spieler.

    Brightcove-Standardvorlage - Die Vorlage besteht aus einer Reihe von Dateien und Einstellungen, die als Grundlage für die Erstellung der den Benutzern präsentierten Anzeigeerlebnisse und als Grundlage für alle erstellten Player dienen. Diese Dateien werden schließlich mit benutzerdefinierten Player-Einstellungen kompiliert und führen zu dem tatsächlichen Code, der in den Browser (den Player) geladen wird. Derzeit gibt es nur eine einzige Vorlage, die systemweit verwendet wird. Daher gibt es keine Sichtbarkeit der Vorlage über die API.

    Spieler - Spieler sind kundenspezifische Einstellungen, die allgemeine Informationen und Anpassungen erfassen, die auf die Vorlage angewendet werden sollen. Diese Einstellungen werden an die API gesendet und ein Player-Objekt wird angezeigt. Anpassungen können Einstellungen, Stile und Plugins enthalten. Eine vollständige Liste der Anpassungsmöglichkeiten finden Sie in der Player-Konfigurationshandbuch.

    Kinderspieler - Untergeordnete Spieler, die mit den eingebetteten APIs erstellt wurden, sind das Ergebnis der Erstellung mehrerer Instanzen eines Spielers. Der Player verfügt über den Großteil der Eigenschaften, die Ihr Player haben soll. Anschließend können Sie mit einem untergeordneten Player Teilmengen von Eigenschaften für verschiedene Player-Instanzen anpassen. Ein untergeordneter Player kann nur Medien definieren, die einem bestimmten Player hinzugefügt werden sollen, oder er kann Einstellungen oder Stilüberschreibungen definieren, die den allgemeinen Player ändern, zu dem er gehört. Änderungen an den Einstellungen des übergeordneten Spielers gelten für alle untergeordneten Spieler, die vom übergeordneten Spieler erzeugt wurden. Probier das aus Handbuch zum Einbetten von APIs für mehr Details.

    Dieses Diagramm zeigt die Beziehungen zwischen der Standardvorlage, den Spielern und den untergeordneten Spielern.

    Spieler-Entity-Hierarch
    Spieler-Entity-Hierarch

    Wenn Sie die Player-Verwaltungs-API zum ersten Mal verwenden, wird in Ihrem Konto ein Brightcove-Standardplayer generiert. Dieses Spielerobjekt können Sie nach Belieben verwenden. Sie können es so verwenden, wie es ist, seine Einstellungen ändern, es neu formatieren oder Plugins hinzufügen. Sie können nur den Brightcove-Standardplayer für Ihre Anpassungen verwenden oder andere Player erstellen, um unterschiedliche Erscheinungsbilder und Einstellungen für unterschiedliche Standorte auf Ihrer Website zu erfassen.

    Veröffentlichungsübersicht

    Eine der Funktionen des Player-Verwaltungssystems ist die Möglichkeit, die zu testenden Änderungen von der öffentlich veröffentlichten Version Ihres Players zu trennen. Wenn Sie sowohl in der Benutzeroberfläche als auch in der API Änderungen an der Konfiguration eines Players vornehmen, werden die Änderungen sofort über die Vorschauversionen des Players verfügbar gemacht. Diese Vorschau-Versionen sind vollständig verwendbar und testbar. Sie können die Vorschau-URL zur Genehmigung freigeben oder an der Player-Vorschau arbeiten, bis Sie mit den Änderungen zufrieden sind, bevor Sie den Player veröffentlichen, um ihn öffentlich verfügbar zu machen.

    Wasserfälle aktualisieren

    Das Veröffentlichen eines Players hat Konsequenzen, die sich auf untergeordnete Spieler auswirken können. Hier sind Details zur Veröffentlichung:

    • Eine Player-Veröffentlichung löst eine erneute Veröffentlichung aller von diesem Player erstellten untergeordneten Player-Instanzen aus.
    • Eine Veröffentlichung eines untergeordneten Spielers betrifft nur diesen untergeordneten Spieler.
    • Ein Brightcove-Standardvorlagen-Update (Brightcove-gesteuert) löst eine erneute Veröffentlichung aller Spieler aus, und die erneute Veröffentlichung des Spielers löst wiederum eine erneute Veröffentlichung aller untergeordneten Spieler aus, die von jedem Spieler erstellt wurden.

    Einstellungen werden auf untergeordnete Weise angewendet. Dies bedeutet, dass Einstellungen auf untergeordneter Ebene Vorrang vor Änderungen auf übergeordneter Ebene haben. Einige interessante Fakten hierzu:

    • Die Standardvorlage definiert einen CSS-Wert als rot.
    • Ein Spieler definiert den gleichen CSS-Wert als weiß.
    • Ein untergeordneter Spieler definiert denselben CSS-Wert als blau.

    Da das Kind gewinnt, wären die Ergebnisse:

    • Der CSS-Wert des Spielers ist weiß.
    • Der CSS-Wert des untergeordneten Spielers ist blau.

    Dieses Vererbungsverhalten kann geändert werden, wenn der Datentyp der Eigenschaft ein Array ist. Das Array-Felder Im Abschnitt des Handbuchs zum Einbetten von APIs werden die Details beschrieben.

    Optionen für die Konfiguration

    Um einen Spieler zu erstellen, der fortgeschrittener als nur der Standardspieler ist, müssen Sie einen angeben Player-Konfiguration. Die Konfiguration wird mit JSON definiert.

    Zinsbegrenzung

    In der Player-Verwaltungs-API ist die Ratenbeschränkung für jede aktivierte eindeutige IP-Adresse festgelegt. Es folgen die Tarifgrenzen:

    Anfragetyp Limit
    Veröffentlichen und erstellen (Player und Einbettungen) 60 Anfragen / Minute
    Lesen (GET) 600 Anfragen / Minute
    Schreiben (POST, PUT, PATCH und DELETE) 300 Anfragen / Minute
    Spieler Vorschau 100 Anfragen / Minute

    Antwortstatuscodes

    Antwort- und Fehlercodes / Nachrichten basieren auf diesen definiert durch W3. Einige der am häufigsten verwendeten Codes sind:

    • 200 Erfolg anfordern
    • 201 Erstellt (ein Spieler, eine Konfiguration)
    • 400 Ungültige Anforderung - Die Syntax des API-Aufrufs ist wahrscheinlich falsch
    • 401 Ungültige Authentifizierung - Überprüfen Sie, ob das Kennwort korrekt eingegeben wurde oder ob Sie die Anweisungen befolgt haben OAuth Anweisungen korrekt
    • 404 Nicht gefunden - Überprüfen Sie, ob die Ressource vorhanden ist und die im API-Aufruf verwendete URL korrekt ist
    • 429Frequenzgrenze überschritten
    • 500 Interner Serverfehler - Beim Versuch, die Anforderung zu erfüllen, ist ein Fehler aufgetreten

    Seite zuletzt aktualisiert am 13 Okt. 2020