Liste les modérateurs pour un chat en direct. La demande doit être autorisée par le propriétaire de la chaîne du chat en direct.
Cas d'utilisation courants
Requête
Requête HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Paramètres
Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres répertoriés sont des paramètres de requête.
Paramètres | ||
---|---|---|
Paramètres obligatoires | ||
liveChatId |
string Le paramètre liveChatId définit le chat en direct YouTube pour lequel l'API doit renvoyer des modérateurs. L'ID de chat en direct associé à une diffusion est renvoyé dans la propriété snippet.liveChatId de la ressource liveBroadcast . |
|
part |
string Le paramètre part spécifie les parties de la ressource liveChatModerator qui seront incluses dans la réponse de l'API. Les valeurs acceptées sont id et snippet . |
|
Paramètres facultatifs | ||
maxResults |
unsigned integer Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs autorisées vont de 0 à 50 , inclus. La valeur par défaut est 5 . |
|
pageToken |
string Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse de l'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui peuvent être récupérées. |
Corps de la requête
Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
Propriétés
Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:
Propriétés | |
---|---|
kind |
string Identifie le type de ressource d'API. La valeur est youtube#liveChatModeratorListResponse . |
etag |
etag Etag de cette ressource. |
prevPageToken |
string Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente dans l'ensemble de résultats. |
nextPageToken |
string Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats. |
pageInfo |
object L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats. |
pageInfo.totalResults |
integer Nombre total de résultats dans l'ensemble de résultats. |
pageInfo.resultsPerPage |
integer Nombre de résultats inclus dans la réponse de l'API. |
items[] |
list Liste de modérateurs correspondant aux critères de la demande. |
Erreurs
L'API ne définit aucun message d'erreur propre à cette méthode API. Toutefois, cette méthode peut quand même renvoyer des erreurs d'API générales répertoriées dans la documentation sur les messages d'erreur.
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.