LiveChatMessages: list

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

Wenn Sie Ihre erste Anfrage zum Abrufen von Chatnachrichten stellen, gibt die API je nach Länge des Verlaufs einige oder alle Chatprotokolle zurück. Nachrichten in der Antwort werden von der ältesten zur neuesten Nachricht geordnet.
  • Die nextPageToken in der Antwort enthält ein Token, 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 weitere Ergebnisse angefordert werden.
Wenn Sie zusätzliche Ergebnisse anfordern, legen Sie den Parameter pageToken auf den Wert nextPageToken fest. Der API-Server gibt ggf. weitere Chatnachrichten zurück. Auch hier werden die Nachrichten nach dem ältesten sortiert.

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 sollen. Die mit einer Übertragung verknüpfte Live-Chat-ID wird in der Property 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
Der Parameter hl weist die API an, einen lokalisierten Anzeigestring für eine bestimmte Anwendungssprache abzurufen, die von der YouTube-Website unterstützt wird. Für Englisch würde die Währung beispielsweise als $1.50, für Französisch als 1,50$ angezeigt werden.

Der Parameterwert muss ein Sprachcode in der Liste sein, die von der Methode i18nLanguages.list 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. Der Standardwert ist 500.
pageToken string
Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort gibt die Property nextPageToken andere Seiten an, die abgerufen werden können.
profileImageSize unsigned integer
Der Parameter profileImageSize gibt die Größe der Nutzerprofilbilder an, die in den Ergebnissen zurückgegeben werden sollen. Die Bilder sind quadratisch. Der Standardwert ist 88. Bilder sind also 88 x 88 Pixel groß. Zulässige Werte liegen im Bereich von 16 bis 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 im Ergebnissatz abzurufen.
pollingIntervalMillis unsigned integer
Die Zeit in Millisekunden, die der Client warten soll, bevor neue Nachrichten im Livechat abgefragt werden.
offlineAt datetime
Datum und Uhrzeit, zu der der zugrunde liegende Livestream offline ging. Diese Property ist nur vorhanden, wenn der Stream bereits offline ist. Der Wert wird im ISO 8601-Format (YYYY-MM-DDThh:mm:ss.sZ) angegeben.
pageInfo object
Das pageInfo-Objekt enthält Seiteninformationen 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 der Nachrichten im Livechat. Jedes Element in der Liste ist eine liveChatMessage-Ressource.

Fehler

In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. 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 Für die angegebene Übertragung ist der Livechat nicht aktiviert.
forbidden (403) liveChatEnded Der angegebene Livechat ist nicht mehr aktiv.
notFound (404) liveChatNotFound Der Livechat, den du abrufen möchtest, wurde nicht gefunden. Prüfen Sie, ob der Wert des liveChatId-Parameters 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, die unnötig Bandbreite verbrauchen.

Testen!

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