LiveStreams: list

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

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

Autorisierung

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

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 liveStream angegeben, die in der API-Antwort enthalten sein sollen. Die part-Namen, die Sie in den Parameterwert aufnehmen können, sind id, snippet, cdn und status.
Filter (genau einen der folgenden Parameter angeben)
id string
Mit dem Parameter id wird eine durch Kommas getrennte Liste von YouTube-Stream-IDs angegeben, die die abzurufenden Streams identifizieren. In einer liveStream-Ressource gibt die Eigenschaft id die ID des Streams an.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Mit dem mine Parameter kann die API angewiesen werden, nur Streams zurückzugeben, die dem authentifizierten Nutzer gehören. Legen Sie den Parameterwert auf true fest, um nur Ihre eigenen Streams abzurufen.
Optionale Parameter
maxResults unsigned integer
Mit dem Parameter maxResults wird die maximale Anzahl der Elemente angegeben, die im Ergebnissatz 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 YouTube-CMS-Nutzer 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. 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 im Ergebnissatz angegeben, die zurückgegeben werden soll. In einer API-Antwort geben die Eigenschaften 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#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream 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#liveStreamListResponse.
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 Paging-Informationen für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse in der API-Antwort.
items[] list
Eine Liste von Livestreams, die den Kriterien der Anfrage entsprechen.

Fehler

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

Fehlertyp Fehlerdetails Beschreibung
insufficientPermissions insufficientLivePermissions Die Anfrage ist nicht autorisiert, den angegebenen Livestream abzurufen.
insufficientPermissions liveStreamingNotEnabled Der Nutzer, der die Anfrage autorisiert hat, kann keine Livestreams auf YouTube streamen. Weitere Informationen finden Sie unter https://www.youtube.com/features.

Testen!

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