Listet Moderatoren für einen Live-Chat auf. Die Anfrage muss vom Inhaber des Kanals des Live-Chats autorisiert werden.
Gängige Anwendungsfälle
Anfrage
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 |
stringMit dem Parameter liveChatId wird der YouTube-Live-Chat angegeben, für den die API Moderatoren zurückgeben soll. Die Live-Chat-ID, die mit einer Übertragung verknüpft ist, wird in der Eigenschaft snippet.liveChatId der Ressource liveBroadcast zurückgegeben. |
|
part |
stringMit dem Parameter part werden die Teile der Ressource liveChatModerator angegeben, die in der API-Antwort enthalten sein sollen. Unterstützte Werte sind id und snippet. |
|
| Optionale Parameter | ||
maxResults |
unsigned integerMit 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. |
|
pageToken |
stringMit 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#liveChatModeratorListResponse",
"etag": etag,
"prevPageToken": string,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
liveChatModerator Resource
]
}Attribute
In der folgenden Tabelle sind die Attribute definiert, die in dieser Ressource angezeigt werden:
| Attribute | |
|---|---|
kind |
stringGibt den Typ der API-Ressource an. Der Wert ist youtube#liveChatModeratorListResponse. |
etag |
etagDas ETag dieser Ressource. |
prevPageToken |
stringDas Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen. |
nextPageToken |
stringDas Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen. |
pageInfo |
objectDas Objekt pageInfo enthält Paging-Informationen für den Ergebnissatz. |
pageInfo.totalResults |
integerDie Gesamtzahl der Ergebnisse im Ergebnissatz. |
pageInfo.resultsPerPage |
integerDie Anzahl der Ergebnisse in der API-Antwort. |
items[] |
listEine Liste der Moderatoren, die den Suchkriterien entsprechen. |
Fehler
Die API definiert keine Fehlermeldungen, die für diese API-Methode spezifisch sind. Diese Methode kann jedoch allgemeine API-Fehler zurückgeben, die in der Fehlermeldungs-Dokumentation aufgeführt sind.
Testen!
Mit dem APIs Explorer können Sie diese API aufrufen und die API-Anfrage und -Antwort ansehen.