Diese Seite wurde von der Cloud Translation API übersetzt.

LiveBroadcasts: cuepoint

Ein Cue-Punkt wird in eine Liveübertragung eingefügt. Der Cue-Punkt kann eine Werbeunterbrechung auslösen.

Hinweis:Diese Methode ersetzt die Methode liveCuepoints.insert. Bei dieser Methode mussten Anfragen von einem Konto autorisiert werden, das mit einem YouTube-Rechteinhaber verknüpft ist. Für diese Methode gelten keine Autorisierungsanforderungen.

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint

Autorisierung

Diese Anfrage erfordert eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche. Weitere Informationen zu Authentifizierung und Autorisierung finden Sie unter OAuth 2.0-Authentifizierung implementieren.

Umfang
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`
`https://www.googleapis.com/auth/youtubepartner`

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
`id`	`string` Der Parameter `id` gibt die Übertragung an, in die der Cue-Punkt eingefügt wird. Die Übertragung muss aktiv sein, wenn du den Cue-Punkt einfügst.
Optionale Parameter
`onBehalfOfContentOwner`	`string` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis:Dieser Parameter ist ausschließlich für YouTube-Rechteinhaber gedacht, die viele verschiedene YouTube-Kanäle haben und verwalten. So können sich Rechteinhaber einmal authentifizieren und Aktionen im Namen des im Parameterwert angegebenen Kanals ausführen, ohne für jeden einzelnen Kanal unterschiedliche Anmeldedaten angeben zu müssen. Das Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein. Der Parameter `onBehalfOfContentOwner` gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen YouTube-Rechteinhabers handelt. Dieser Parameter richtet sich an YouTube-Contentpartner, die viele verschiedene YouTube-Kanäle haben und verwalten.
`onBehalfOfContentOwnerChannel`	`string` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis:Dieser Parameter ist ausschließlich für YouTube-Rechteinhaber gedacht, die viele verschiedene YouTube-Kanäle haben und verwalten. So können sich Rechteinhaber einmal authentifizieren und Aktionen im Namen des im Parameterwert angegebenen Kanals ausführen, ohne für jeden einzelnen Kanal Anmeldedaten angeben zu müssen. Der Parameter `onBehalfOfContentOwnerChannel` gibt die YouTube-Kanal-ID des Kanals an, der mit der Übertragung verknüpft ist, in die der Cue-Punkt eingefügt wird. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für den Parameter `onBehalfOfContentOwner` angegeben wird. Er kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem gelten die folgenden Anforderungen: Die Anfrage muss mit einem Nutzerkonto autorisiert sein, das mit dem Rechteinhaber verknüpft ist, der im Parameter `onBehalfOfContentOwner` angegeben ist. Der Kanal, der durch den Parameterwert `onBehalfOfContentOwnerChannel` angegeben wird, muss mit dem Rechteinhaber verknüpft sein, der durch den Parameter `onBehalfOfContentOwner` angegeben wird.

Anfragetext

Geben Sie im Anfragetext eine cuepoint-Ressource an. Die folgende JSON-Struktur zeigt das Format einer cuepoint-Ressource:

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }

Das Feld cueType ist im Anfragetext erforderlich und muss auf cueTypeAd gesetzt sein. Sie können auch Werte für die folgenden Properties festlegen:

durationSecs
insertionOffsetTimeMs (muss nicht festgelegt werden, wenn walltimeMs festgelegt ist)
walltimeMs (muss nicht festgelegt werden, wenn insertionOffsetTimeMs festgelegt ist)

Attribute

In der folgenden Tabelle werden die Eigenschaften definiert, die in dieser Ressource angezeigt werden:

Attribute
`id`	`string` Ein Wert, der von YouTube zugewiesen wird, um den Cue-Punkt eindeutig zu identifizieren. Dieser Wert unterscheidet sich vom erforderlichen Parameter `id`, mit dem die Übertragung identifiziert wird. Dieser Wert kann beim Senden einer Anfrage zum Einfügen eines Cue-Punkts weggelassen werden. Der Wert wird in der API-Antwort eingefügt.
`insertionOffsetTimeMs`	`long` Der Attributwert gibt eine Zeitverschiebung in Millisekunden an, zu der der Cuepoint eingefügt werden soll. Der Wert wird vom Beginn des Monitorstreams aus gemessen. Der Standardwert ist `0`, was bedeutet, dass der Cue-Punkt so bald wie möglich eingefügt werden sollte. Wenn deine Übertragung keinen Monitorstream hat, solltest du keinen Wert für diesen Parameter angeben. Der Wert wird in Millisekunden gemessen, ist aber nur eine Schätzung. YouTube fügt den Cue-Punkt so nah wie möglich an dieser Stelle ein. Werte ungleich 0 für dieses Feld werden nur unterstützt, wenn der Übertragungsstream verzögert ist. Wenn dein Übertragungsstream keine Verzögerung hat, ist `0` der einzige gültige Wert. Weitere Informationen finden Sie unter Einstieg. Hinweis:Wenn für deine Übertragung eine Testphase festgelegt wurde, wird der Versatz ab dem Beginn der Testphase gemessen. Die API gibt einen Fehler zurück, wenn in einer Anfrage versucht wird, einen Cue-Punkt einzufügen, der einen Wert für diese Property und für die Property `walltimeMs` angibt.
`walltimeMs`	`integer` Der Attributwert gibt die Echtzeit an, zu der der Cue-Punkt eingefügt werden soll. Der Wert ist eine Ganzzahl, die einen Epoch-Zeitstempel (in Millisekunden) darstellt. Die API gibt einen Fehler zurück, wenn in einer Anfrage versucht wird, einen Cue-Punkt einzufügen, der einen Wert für dieses Attribut und für das Attribut `insertionOffsetTimeMs` angibt.
`durationSecs`	`unsigned integer` Dauer des Cue-Punkts in Sekunden. Der Wert muss eine positive Ganzzahl sein. Der Standardwert ist `30`.
`cueType`	`string` Der Typ des Cue-Punkts. Der Attributwert muss auf `cueTypeAd` festgelegt sein.

Antwort

Bei Erfolg gibt diese Methode die eingefügte cuepoint-Ressource im Antworttext zurück.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen findest du unter YouTube Live Streaming API – Fehler.

Fehlertyp	Fehlerdetails	Beschreibung
`insufficientPermissions (403)`	`insufficientLivePermissions`	Die Anfrage ist nicht berechtigt, einen Cue-Punkt in die Liveübertragung einzufügen.
`insufficientPermissions (403)`	`liveStreamingNotEnabled`	Der Nutzer, der die Anfrage autorisiert hat, ist nicht berechtigt, Livevideos auf YouTube zu streamen. Weitere Informationen finden Nutzer unter Einführung in Livestreaming und Voraussetzungen für die Nutzung der Funktion.
`rateLimitExceeded (403)`	`userRequestsExceedRateLimit`	Der Nutzer hat innerhalb eines bestimmten Zeitraums zu viele Anfragen gesendet.
`required (400)`	`idRequired`	Der erforderliche Parameter `id` muss die Übertragung angeben, in die du einen Cue-Punkt einfügen möchtest.
`required (400)`	`cueTypeRequired`	Das erforderliche Feld `cueType` muss im Anfragetext der API angegeben werden.
`notFound (404)`	`liveBroadcastNotFound`	Die mit dem Parameter `id` angegebene Übertragung ist nicht vorhanden.
`invalidValue (400)`	`conflictingTimeFields`	Es muss entweder `insertionOffsetTimeMs` oder `walltimeMs` angegeben werden. Wenn Sie beide Werte festlegen, führt dies zu einem Fehler. Wenn du keinen dieser Werte festlegst, verwendet YouTube die Standardzeit `insertionOffsetTimeMs` (`0`). Das bedeutet, dass der Cue-Punkt so bald wie möglich eingefügt wird.
`invalidValue (400)`	`invalidInsertionOffsetTimeMs`	Für die `cuepoint`-Ressource wurde ein ungültiger Wert für die Property `insertionOffsetTimeMs` angegeben. Der Wert muss `0` oder eine positive Ganzzahl sein.
`invalidValue (400)`	`invalidWalltimeMs`	Für die `cuepoint`-Ressource wurde ein ungültiger Wert für die Property `walltimeMs` angegeben. Der Wert muss eine Ganzzahl sein, die einen Epochenzeitstempel (in Millisekunden) darstellt.
`backendError (5xx)`	`serviceUnavailable`	Der Dienst ist nicht verfügbar. Bitte versuchen Sie es in ein paar Minuten noch einmal.

Testen!

Verwenden Sie die APIs Explorer, um diese API aufzurufen und die API-Anfrage und ‑Antwort zu sehen.