LiveChatMessages: list

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

Wenn du zum ersten Mal eine Anfrage zum Abrufen von Chatnachrichten stellst, gibt die API abhängig von ihrer Länge einen Teil oder den gesamten Chatverlauf zurück. Die Nachrichten in der Antwort werden von der ältesten zur neuesten Nachricht sortiert.
  • Das nextPageToken in der Antwort stellt ein Token bereit, das in Ihrer nächsten Anfrage den nächsten Satz von Ergebnissen identifiziert, den Ihr API-Client abrufen soll.
  • Das Attribut pollingIntervalMillis gibt an, wie lange der API-Client warten muss, bevor er weitere Ergebnisse anfordert.
Wenn Sie zusätzliche Ergebnisse anfordern, setzen Sie den Parameter pageToken auf den Wert nextPageToken. Der API-Server gibt dann weitere Chatnachrichten zurück, sofern verfügbar. Auch hier werden die Nachrichten in diesem Ergebnissatz von der ältesten zur neuesten geordnet.

Gängige Anwendungsfälle

Anfragen

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 die API-Antwort enthalten soll. Unterstützte Werte sind id, snippet und authorDetails.
Optionale Parameter
hl string
Mit dem Parameter hl wird die API angewiesen, einen Anzeigestring in der lokalisierten Währung für eine bestimmte Anwendungssprache, die von der YouTube-Website unterstützt wird, abzurufen. Auf Englisch würde die Währung beispielsweise als $1.50 angezeigt werden, auf Französisch als 1,50$.

Der Parameterwert muss ein Sprachcode sein, der in der Liste enthalten ist, die von der i18nLanguages.list-Methode zurückgegeben wird.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Nachrichten an, die in der Ergebnismenge 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 identifiziert das Attribut nextPageToken andere Seiten, 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, das heißt, die 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
  ]
}

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 Parameters pageToken verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen.
pollingIntervalMillis unsigned integer
Die Zeit in Millisekunden, die der Client warten muss, bevor er neue Nachrichten im Livechat abrufen kann.
offlineAt datetime
Datum und Uhrzeit, zu der der zugrunde liegende Livestream offline genommen wurde. 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 enthält Seiteninformationen für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
items[] list
Eine Liste der Nachrichten im Livechat. Jedes Element in der Liste ist eine liveChatMessage-Ressource.

Fehler

In der folgenden Tabelle finden Sie Fehlermeldungen, 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 bist nicht berechtigt, 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 beendet.
notFound (404) liveChatNotFound Der Livechat, den du abrufen möchtest, kann nicht gefunden werden. Prüfen Sie, ob der Wert des liveChatId-Parameters 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.

Jetzt testen

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