LiveBroadcasts: list

Gibt eine Liste von YouTube-Übertragungen zurück, die den Parametern der API-Anfrage entsprechen.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

Autorisierung

Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Bereiche erforderlich. Weitere Informationen zur Authentifizierung und Autorisierung finden Sie unter Authentifizierung mit OAuth 2.0 implementieren.

Bereich
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
Mit dem Parameter part wird eine durch Kommas getrennte Liste mit einer oder mehreren Eigenschaften der Ressource liveBroadcast angegeben, 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 (genau einen der folgenden Parameter angeben)
broadcastStatus string
Mit dem Parameter broadcastStatus wird die API-Antwort so gefiltert, dass nur Übertragungen mit dem angegebenen Status enthalten sind.

Zulässige Werte:
  • active : Gibt aktuelle Liveübertragungen zurück.
  • all : Gibt alle Übertragungen zurück.
  • completed : Gibt Übertragungen zurück, die bereits beendet wurden.
  • upcoming : Gibt Übertragungen zurück, die noch nicht gestartet wurden.
id string
Mit dem Parameter id wird eine durch Kommas getrennte Liste von YouTube-Übertragungs-IDs angegeben, die die abzurufenden Übertragungen identifizieren. In einer liveBroadcast-Ressource gibt die Eigenschaft id die ID der Übertragung an.
mine boolean
Mit dem Parameter mine kann die API angewiesen werden, nur Übertragungen zurückzugeben, die dem authentifizierten Nutzer gehören. Setzen Sie den Parameterwert auf true, um nur Ihre eigenen Übertragungen abzurufen.
Optionale Parameter
broadcastType string
Mit dem Parameter broadcastType wird die API-Antwort so gefiltert, dass nur Übertragungen mit dem angegebenen Typ enthalten sind. Der Parameter sollte in Anfragen verwendet werden, bei denen der mine Parameter auf true gesetzt ist oder der broadcastStatus Parameter verwendet wird. Der Standardwert ist event.

Zulässige Werte:
  • all : Gibt alle Übertragungen zurück.
  • event : Gibt nur geplante Event-Übertragungen zurück.
  • persistent : Gibt nur dauerhafte Übertragungen zurück.
maxResults unsigned integer
Mit dem Parameter maxResults wird die maximale Anzahl der Elemente angegeben, die in der Ergebnismenge zurückgegeben werden sollen. Zulässige Werte sind 0 bis 50 (einschließlich). Der Standardwert ist 5.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden.
Hinweis: Dieser Parameter ist ausschließlich für YouTube-Content-Partner vorgesehen.

Der onBehalfOfContentOwner Parameter gibt an, dass die Autorisierungsdaten der Anfrage einen Nutzer des YouTube-Content-Management-Systems (CMS) identifizieren, der im Namen des im Parameterwert angegebenen Content-Inhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können Rechteinhaber sich einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten 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 ordnungsgemäß autorisierten Anfrage verwendet werden.
Hinweis: Dieser Parameter ist ausschließlich für YouTube-Content-Partner vorgesehen.

Mit dem Parameter onBehalfOfContentOwnerChannel wird die YouTube-Kanal-ID des Kanals angegeben, dem ein Video hinzugefü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 muss die Anfrage mit einem CMS-Konto autorisiert werden, das mit dem Content-Inhaber verknüpft ist, der im Parameter onBehalfOfContentOwner angegeben ist. Schließlich muss der Kanal, der im Parameterwert onBehalfOfContentOwnerChannel angegeben ist, mit dem Content-Inhaber verknüpft sein, der im Parameter onBehalfOfContentOwner angegeben ist.

Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können Rechteinhaber sich einmal authentifizieren und Aktionen im Namen des im Parameterwert angegebenen Kanals ausführen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen.
pageToken string
Mit dem Parameter pageToken wird eine bestimmte Seite in der Ergebnismenge angegeben, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Eigenschaften nextPageToken und prevPageToken andere Seiten, 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 sind die Attribute definiert, die in dieser Ressource enthalten sind:

Attribute
kind string
Gibt den Typ der API-Ressource an. 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 in der Ergebnismenge abzurufen.
prevPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite in der Ergebnismenge abzurufen.
pageInfo object
Das Objekt pageInfo enthält Paging-Informationen für die Ergebnismenge.
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 von Übertragungen, die den Suchkriterien entsprechen.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf von dieser Methode zurückgeben kann. Weitere Informationen finden Sie in der Fehlermeldung.

Fehlertyp Fehlerdetail Beschreibung
insufficientPermissions insufficientLivePermissions Die Anfrage ist nicht autorisiert, die Liveübertragung abzurufen.
insufficientPermissions liveStreamingNotEnabled Der Nutzer, der die Anfrage autorisiert hat, kann keine Livevideos auf YouTube streamen. Weitere Informationen finden Sie unter Verfügbarkeit der Funktionen.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und die API-Anfrage und -Antwort ansehen.