Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Überblick: Player Management API

    Player Management bezieht sich auf die Erstellung, Bearbeitung und Verwaltung von players als Ressource für Verlage. Player Die Verwaltung erfolgt über eine serverseitige REST-API, mit der die Kunden erstellen, konfigurieren, in der Vorschau anzeigen und veröffentlichen können player Instanzen.
     

    Einführung

    Erstellen und Aktualisieren players erfolgt zweiphasig. Anstatt alle Änderungen automatisch auf die Produktion anzuwenden players werden die Änderungen in eine Vorschau unterteilt und veröffentlicht. Sie können jetzt alle gewünschten Aktualisierungen für Ihre Vorschau vornehmen player ohne zu beeinflussen, was Ihre Endbenutzer sehen. Sie können die Änderungen jederzeit veröffentlichen.

    Der Player Management API ermöglicht einem Benutzer:

    1. Erstelle einen Spieler
    2. Zeigen Sie die Einstellungen eines Players an
    3. Ändern Sie die Einstellungen eines Players
    4. Listen Sie alle auf players mit dem Verlag verbunden
    5. Veröffentlichen Sie einen Player, um ihn dem Konsumenten zur Verfügung zu stellen

    Siehe auch die API-Referenz.

    Basis-URL

    Die Basis-URL für die API lautet:

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

    Einführung

    Der player Das Managementsystem besteht aus drei Schlüsselobjekten. Sie sind die Standardvorlage. players und Kind players.

    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 dienen players erstellt. Diese Dateien werden schließlich mit benutzerdefinierten kompiliert player Einstellungen und führen zu dem tatsächlichen Code, der in den Browser geladen wird (die player). Derzeit gibt es nur eine einzige Vorlage, die systemweit verwendet wird. Daher gibt es keine Sichtbarkeit der Vorlage über die API.

    Spieler - Players sind kundenspezifische Einstellungen, die allgemeine Informationen und Anpassungen erfassen, die auf die Vorlage angewendet werden sollen. Diese Einstellungen werden an die API gesendet und a player Objektergebnisse. Anpassungen können Einstellungen, Stile und Plugins enthalten. Eine vollständige Liste der Anpassungsmöglichkeiten finden Sie in der Handbuch zur Playerkonfiguration.

    Kind Players - Untergeordnete Player, die mit den Einbettungs-APIs erstellt wurden, sind das Ergebnis der Erstellung mehrerer Instanzen eines Players. Der Player verfügt über den Großteil der Eigenschaften, die Ihr Player haben soll. Anschließend können Sie einen untergeordneten Player verwenden, um Teilmengen von Eigenschaften für verschiedene Player-Instanzen anzupassen. Ein untergeordneter Spieler kann nur Medien definieren, die einem bestimmten Spieler hinzugefügt werden sollen, oder er kann alle Einstellungen oder Stilüberschreibungen definieren, die den gemeinsamen Spieler, dem er angehört, ändern. Änderungen an den Einstellungen des übergeordneten Players gelten für alle vom übergeordneten Player erstellten Kinderplayer. Besuche die Einbetten API-Handbuch Für weitere Details.

    Dieses Diagramm zeigt die Beziehungen zwischen der Standardvorlage. players und Kind players.

    Player Entitätshierarchie
    Player Entitätshierarchie

    Wenn Sie die Player Management API Zum ersten Mal ein Brightcove-Standard Player wird in Ihrem Konto generiert. Das player Objekt ist für Sie zu tun, wie Sie wählen. 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-Standard verwenden Player mit Ihren Anpassungen, oder Sie können wählen, andere zu erstellen players, um verschiedene Looks und Einstellungen für verschiedene Orte auf Ihrer Website zu erfassen.

    Veröffentlichungsübersicht

    Eine der Funktionen der Player Das Managementsystem ist die Möglichkeit, Änderungen, die Sie testen möchten, von der Version Ihres zu trennen player die öffentlich veröffentlicht wird. Sowohl in der Benutzeroberfläche als auch in der API, wenn Sie Änderungen an a vornehmen playerIn der Konfiguration werden die Änderungen sofort über die Vorschauversionen des zur Verfügung gestellt player. Diese Vorschau-Versionen sind vollständig verwendbar und testbar. Sie können die Vorschau-URL zur Genehmigung freigeben oder an der arbeiten player Vorschau, bis Sie mit den Änderungen zufrieden sind, bevor Sie die veröffentlichen player um es öffentlich zugänglich zu machen.

    Aktualisieren Sie Wasserfälle

    Veröffentlichen eines player hat Folgen, die das Kind betreffen können players. Hier sind Details zur Veröffentlichung:

    • A player Veröffentlichen löst eine erneute Veröffentlichung aller untergeordneten Elemente aus player daraus erstellte Instanzen player.
    • Ein Kind player Veröffentlichen betrifft nur dieses Kind player.
    • Ein Brightcove-Standardvorlagen-Update (Brightcove-gesteuert) löst eine erneute Veröffentlichung aller aus players und die player Eine erneute Veröffentlichung löst wiederum eine erneute Veröffentlichung aller untergeordneten Elemente aus players erstellt von jedem player.

    Einstellungen werden in einer Child-Wins-Methode angewendet. Dies bedeutet, dass Einstellungen auf der untergeordneten Ebene Vorrang vor Änderungen auf der übergeordneten Ebene haben. Folgendes berücksichtigen:

    • Die Standardvorlage definiert einen CSS-Wert als rot.
    • A player definiert den gleichen CSS-Wert als weiß.
    • Ein Kind player definiert den gleichen CSS-Wert als blau.

    Da das Kind gewinnt, wären die Ergebnisse:

    • Der playerDer CSS-Wert ist weiß.
    • Das Kind playerDer CSS-Wert ist blau.

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

    Konfigurationsoptionen

    Um eine zu erstellen player fortgeschrittener als nur die Standardeinstellung player, Müssen Sie eine Spieler Konfiguration. Die Konfiguration wird mit JSON definiert.

    Ratenbegrenzung

    Der Player Management API hat eine Ratenbegrenzung für jede eindeutige IP-Adresse. Im Folgenden sind die Ratengrenzen:

    Anfragetyp Begrenzen
    Veröffentlichen und erstellen (players und bettet ein) 60-Anfragen / Minute
    Lesen (GET) 600-Anfragen / Minute
    Schreiben (POST, PUT, PATCH und DELETE) 300-Anfragen / Minute
    Spielervorschau 100-Anfragen / Minute

    Antwortstatuscodes

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

    • 200 Erfolg anfordern
    • 201 Erschuf ein player, eine Konfiguration)
    • 400 Ungültige Anforderung - Die Syntax des API-Aufrufs ist wahrscheinlich falsch
    • 401 Ungültige Authentifizierung - Überprüfen Sie, ob das Passwort richtig eingegeben wurde oder ob Sie dem Passwort gefolgt sind 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. Oktober 2020