LiveBroadcasts: list

Gibt eine Liste von YouTube-Broadcasts zurück, die mit den API-Anfrageparametern übereinstimmen.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

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

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
part string
Der Parameter part gibt eine durch Kommas getrennte Liste eines oder mehrerer liveBroadcast-Ressourcenattribute an, die in der API-Antwort enthalten sein sollen. Die part-Namen, die Sie in den Parameterwert aufnehmen können, sind id, snippet, contentDetails, monetizationDetails und status.
Filter (geben Sie genau einen der folgenden Parameter an)
broadcastStatus string
Der Parameter broadcastStatus filtert die API-Antwort so, dass nur Broadcasts mit dem angegebenen Status enthalten sind.

Zulässige Werte sind:
  • active: Aktuelle Liveübertragungen werden zurückgegeben.
  • all: Alle Übertragungen werden zurückgegeben.
  • completed: Gibt Übertragungen zurück, die bereits beendet sind.
  • upcoming: Gibt Übertragungen zurück, die noch nicht gestartet wurden.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste von YouTube-Übertragungs-IDs an, die die abgerufenen Übertragungen identifizieren. In einer liveBroadcast-Ressource gibt das Attribut id die ID der Übertragung an.
mine boolean
Mit dem Parameter mine kann die API angewiesen werden, nur Broadcasts zurückzugeben, die dem authentifizierten Nutzer gehören. Setze den Parameterwert auf true, um nur deine eigenen Broadcasts abzurufen.
Optionale Parameter
broadcastType string
Mit dem Parameter broadcastType wird die API-Antwort so gefiltert, dass nur Broadcasts des angegebenen Typs enthalten sind. Der Parameter sollte in Anfragen verwendet werden, in denen der Parameter mine auf true festgelegt wird oder in denen der Parameter broadcastStatus verwendet wird. Der Standardwert ist event.

Zulässige Werte sind:
  • all: Alle Übertragungen werden zurückgegeben.
  • event: Nur geplante Ereignisübertragungen werden zurückgegeben.
  • persistent: Nur persistente Broadcasts zurückgeben.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die im Ergebnissatz zurückgegeben werden sollen. Zulässige Werte sind 0 bis einschließlich 50. Der Standardwert ist 5.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer korrekt autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube CMS-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Contentpartner gedacht, die viele verschiedene YouTube-Kanäle haben und verwalten. Rechteinhaber können sich nur einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben zu müssen. Das CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
onBehalfOfContentOwnerChannel string
Dieser Parameter kann nur in einer korrekt autorisierten Anfrage verwendet werden. Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis:Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwnerChannel gibt die YouTube-Kanal-ID des Kanals an, zu dem ein Video hinzugefügt wird. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für den Parameter onBehalfOfContentOwner angegeben wird, und kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem Rechteinhaber verknüpft ist, der durch den Parameter onBehalfOfContentOwner angegeben wird. Schließlich muss der Kanal, den der Parameterwert onBehalfOfContentOwnerChannel angibt, mit dem Rechteinhaber verknüpft werden, der durch den Parameter onBehalfOfContentOwner angegeben wird.

Dieser Parameter ist für YouTube-Contentpartner gedacht, die viele verschiedene YouTube-Kanäle haben und verwalten. Rechteinhaber können sich einmalig authentifizieren und Aktionen im Namen des im Parameterwert angegebenen Kanals ausführen, ohne Authentifizierungsdaten für jeden einzelnen Kanal angeben zu müssen.
pageToken string
Der Parameter pageToken gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort geben die Attribute nextPageToken und prevPageToken andere Seiten an, die abgerufen werden können.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

Attribute

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

Attribute
kind string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#liveBroadcastListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen.
prevPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen.
pageInfo object
Das Objekt pageInfo enthält Seiteninformationen für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse in der Ergebnismenge.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
items[] list
Eine Liste der Broadcasts, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
insufficientPermissions insufficientLivePermissions Die Anfrage ist nicht autorisiert, die Liveübertragung abzurufen.
insufficientPermissions liveStreamingNotEnabled Der Nutzer, der die Anfrage autorisiert hat, kann kein Live-Video auf YouTube streamen. Weitere Informationen findet der Nutzer unter https://www.youtube.com/features.

Jetzt testen

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.