LiveChatMessages: list

Listet die Livechat-Nachrichten für einen bestimmten Chat auf.

Wenn du deine erste Anfrage zum Abrufen von Chatnachrichten stellst, gibt die API je nach Länge des Verlaufs einen Teil oder den gesamten Chatverlauf zurück. Die Nachrichten in der Antwort sind von der ältesten bis zur neuesten Nachricht geordnet.
  • Das nextPageToken in der Antwort stellt ein Token bereit, das in Ihrer nächsten Anfrage die nächsten Ergebnisse identifiziert, die Ihr API-Client abrufen soll.
  • Das Attribut pollingIntervalMillis gibt an, wie lange Ihr API-Client warten soll, bevor er zusätzliche Ergebnisse anfordert.
Wenn Sie zusätzliche Ergebnisse anfordern, setzen Sie den Parameter pageToken auf den Wert nextPageToken. Der API-Server gibt dann zusätzliche Chatnachrichten zurück, falls verfügbar. Auch hier werden die Nachrichten in dieser Ergebnismenge von der ältesten bis zur neuesten Nachricht geordnet.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

GET https://www.googleapis.com/youtube/v3/liveChat/messages

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
liveChatId string
Der Parameter liveChatId gibt die ID des Chats an, dessen Nachrichten zurückgegeben werden. Die mit einer Übertragung verknüpfte Livechat-ID wird im Attribut snippet.liveChatId der Ressource liveBroadcast zurückgegeben.
part string
Der Parameter part gibt die liveChatMessage-Ressourcenteile an, die in der API-Antwort enthalten sein sollen. Unterstützte Werte sind id, snippet und authorDetails.
Optionale Parameter
hl string
Der hl-Parameter weist die API an, einen angezeigten String für eine lokalisierte Währung für eine bestimmte Anwendungssprache, die von der YouTube-Website unterstützt wird, abzurufen. In Englisch wird die Währung beispielsweise als $1.50 angezeigt, in Französisch als 1,50$.

Der Parameterwert muss in der Liste enthalten sein, die von der Methode i18nLanguages.list zurückgegeben wird.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Nachrichten an, die im Ergebnissatz zurückgegeben werden sollen. Zulässige Werte sind 200 bis 2000 (einschließlich). Der Standardwert ist 500.
pageToken string
Der pageToken-Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort gibt das Attribut nextPageToken andere Seiten an, die abgerufen werden könnten.
profileImageSize unsigned integer
Der Parameter profileImageSize gibt die Größe der Nutzerprofilbilder an, die im Ergebnissatz zurückgegeben werden sollen. Die Bilder sind quadratisch. Der Standardwert ist 88, d. h. Bilder sind 88 x 88 Pixel groß. Zulässige Werte liegen im Bereich von 16 bis einschließlich 720.

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#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage 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#liveChatMessageListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des pageToken-Parameters verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen.
pollingIntervalMillis unsigned integer
Die Zeit in Millisekunden, die der Client warten muss, bevor er neue Livechat-Nachrichten noch einmal abrufen kann.
offlineAt datetime
Datum und Uhrzeit der Offlinebereitstellung des zugrunde liegenden Livestreams. Diese Property ist nur vorhanden, wenn der Stream bereits offline ist. Der Wert wird im Format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) angegeben.
pageInfo object
Das Objekt pageInfo kapselt Seiteninformationen für die Ergebnismenge.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse in der Ergebnismenge.
pageInfo.resultsPerPage integer
Die Anzahl der in der API-Antwort enthaltenen Ergebnisse.
items[] list
Eine Liste von Nachrichten. Jedes Element in der Liste ist eine liveChatMessage-Ressource.
activePollItem object
Die Umfragedaten in der Nachricht. Jede Abfrage ist eine liveChatMessage-Ressource vom Typ pollEvent, die eine aktive Abfrage darstellt. Pro Chat kann nur eine Umfrage durchgeführt werden.

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
forbidden (403) forbidden Du hast nicht die erforderlichen Berechtigungen, um Nachrichten für den angegebenen Livechat abzurufen.
forbidden (403) liveChatDisabled Der Livechat ist für die angegebene Übertragung nicht aktiviert.
forbidden (403) liveChatEnded Der angegebene Livechat ist nicht mehr live.
notFound (404) liveChatNotFound Der Livechat, den du abrufen möchtest, kann nicht gefunden werden. Prüfen Sie, ob der Wert des Parameters liveChatId der Anfrage korrekt ist.
rateLimitExceeded rateLimitExceeded Die Anfrage wurde zu schnell nach der vorherigen Anfrage gesendet. Dieser Fehler tritt auf, wenn API-Anfragen zum Abrufen von Nachrichten häufiger gesendet werden als die Aktualisierungsraten von YouTube, wodurch unnötig Bandbreite verschwendet wird.

Testen!

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