Listet Moderatoren für einen Livechat auf. Die Anfrage muss vom Inhaber des Livechat-Kanals genehmigt werden.
Gängige Anwendungsfälle
Anfragen
HTTP-Anfrage
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
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 den YouTube-Livechat an, für den die API Moderatoren zurückgeben soll. 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 liveChatModerator -Ressourcenteile an, die die API-Antwort enthalten soll. Unterstützte Werte sind id und snippet . |
|
Optionale Parameter | ||
maxResults |
unsigned integer Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen. Zulässige Werte sind 0 bis 50 (einschließlich). Der Standardwert ist 5 . |
|
pageToken |
string Der pageToken -Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute nextPageToken und prevPageToken andere Seiten, die abgerufen werden könnten. |
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#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator 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#liveChatModeratorListResponse . |
etag |
etag Das ETag dieser Ressource. |
prevPageToken |
string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite in der Ergebnismenge abzurufen. |
nextPageToken |
string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen. |
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 Moderatoren, die den Kriterien für den Antrag entsprechen. |
Fehler
Die API definiert keine Fehlermeldungen, die nur für diese API-Methode gelten. Bei dieser Methode können jedoch weiterhin allgemeine API-Fehler zurückgegeben werden, die in der Dokumentation zu Fehlermeldungen aufgeführt sind.
Jetzt testen
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.