Einleitung
Das Erstellen und Aktualisieren von Playern erfolgt in einem zweistufigen Ansatz. Anstatt alle Änderungen automatisch auf Produktionsplayer anzuwenden, werden die Änderungen in die Vorschau unterteilt und veröffentlicht. Sie können jetzt alle gewünschten Aktualisierungen an Ihrem Vorschauplayer vornehmen, ohne die Anzeige für Ihre Endbenutzer zu beeinträchtigen. Sie können die Änderungen jederzeit veröffentlichen.
Die Player Management API ermöglicht einem Benutzer:
- Spieler erstellen
- Anzeigen der Einstellungen eines Spielers
- Ändern Sie die Einstellungen eines Spielers
- Listen Sie alle Spieler auf, die mit dem Publisher verbunden sind
- Veröffentlichen Sie einen Player, um ihn dem Verbraucher 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
Einleitung
Das Spielerverwaltungssystem 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 angepassten Player-Einstellungen kompiliert und ergeben den eigentlichen Code, der in den Browser (den Player) geladen wird. Derzeit gibt es nur eine einzige Vorlage, die systemweit verwendet wird. Daher gibt es keine Einsicht in die 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 es entsteht ein Spielerobjekt. Anpassungen können Einstellungen, Stile und Plugins umfassen. Eine vollständige Liste der Anpassungsmöglichkeiten finden Sie im Anleitung zur Player-Konfiguration.
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, und dann können Sie einen untergeordneten Player verwenden, um Teilmengen von Eigenschaften auf verschiedenen Player-Instanzen anzupassen. 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 aus dem übergeordneten Spieler hervorgegangen sind. Besuche die Leitfaden zum Einbetten von APIs für mehr Details.
Dieses Diagramm zeigt die Beziehungen zwischen der Standardvorlage, Spielern und untergeordneten Spielern.
Wenn Sie die Playerverwaltungs-API zum ersten Mal verwenden, wird in Ihrem Konto ein Brightcove-Standardplayer generiert. Dieses Spielerobjekt steht Ihnen zur freien Verfügung. Sie können es so verwenden, wie es ist, seine Einstellungen ändern, es neu gestalten oder Plugins hinzufügen. Sie können für Ihre Anpassungen nur den Brightcove-Standardplayer verwenden oder andere Player erstellen, um unterschiedliche Erscheinungsbilder und Einstellungen für verschiedene Orte auf Ihrer Website zu erfassen.
Veröffentlichungsübersicht
Eine der Funktionen des Player-Management-Systems ist die Möglichkeit, Änderungen, die Sie testen möchten, von der öffentlich veröffentlichten Version Ihres Players zu trennen. Sowohl in der Benutzeroberfläche als auch in der API werden Änderungen an der Konfiguration eines Players sofort über die Vorschauversionen des Players verfügbar gemacht. Diese Vorschauversionen sind voll nutzbar 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 untergeordnete Player betreffen können. Hier die Details zur Veröffentlichung:
- Eine Player-Veröffentlichung löst eine erneute Veröffentlichung aller untergeordneten Player-Instanzen aus, die von diesem Player erstellt wurden.
- Die Veröffentlichung eines untergeordneten Players betrifft nur diesen untergeordneten Player.
- Eine Aktualisierung der Brightcove-Standardvorlage (von Brightcove kontrolliert) löst eine erneute Veröffentlichung aller Player aus, und die erneute Veröffentlichung des Players löst wiederum eine erneute Veröffentlichung aller untergeordneten Player aus, die von jedem Player erstellt wurden.
Die Einstellungen werden kindgerecht angewendet. Dies bedeutet, dass Einstellungen auf untergeordneter Ebene Vorrang vor Änderungen auf übergeordneter Ebene haben. Folgendes berücksichtigen:
- Die Standardvorlage definiert einen roten CSS-Wert.
- Ein Spieler definiert denselben CSS-Wert als weiß.
- Ein untergeordneter Player definiert denselben CSS-Wert als blau.
Da das Kind gewinnt, wären die Ergebnisse:
- Der CSS-Wert des Players ist weiß.
- Der CSS-Wert des untergeordneten Players 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 fortgeschritteneren Spieler als nur den Standardspieler zu erstellen, müssen Sie ein Player-Konfiguration. Die Konfiguration wird mit JSON definiert.
Ratenbegrenzung
Die Player Management API hat eine Ratenbegrenzung für jede einzelne aktivierte IP. Im Folgenden sind die Ratenbegrenzungen aufgeführt:
| Anfragetyp | Beschränken |
|---|---|
| Veröffentlichen und erstellen (Player und Einbettungen) | 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/Meldungen basieren auf diesen definiert durch W3. Einige der am häufigsten gesehenen Codes sind:
- 200 Erfolg anfragen
- 201 Erstellt (ein Spieler, eine Konfiguration)
- 400 Ungültige Anfrage - die Syntax des API-Aufrufs ist wahrscheinlich falsch
- 401 Ungültige Authentifizierung - Überprüfen Sie, ob das Passwort richtig eingegeben wurde oder ob Sie die Anweisungen befolgt haben OAuth-Anleitung 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 Anfrage zu erfüllen, ist ein Fehler aufgetreten