Liste les modérateurs d'un chat en direct. La requête 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 présente les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.
| Paramètres | ||
|---|---|---|
| Paramètres obligatoires | ||
liveChatId |
stringLe paramètre liveChatId spécifie 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 |
stringLe paramètre part spécifie les parties de la ressource liveChatModerator que la réponse de l'API inclura. Les valeurs acceptées sont id et snippet. |
|
| Paramètres facultatifs | ||
maxResults |
unsigned integerLe paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs acceptables sont comprises entre 0 et 50 inclus. La valeur par défaut est 5. |
|
pageToken |
stringLe 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 |
stringIdentifie le type de ressource de l'API. La valeur sera youtube#liveChatModeratorListResponse. |
etag |
etagL'Etag de cette ressource. |
prevPageToken |
stringLe jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente dans l'ensemble de résultats. |
nextPageToken |
stringLe jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats. |
pageInfo |
objectL'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats. |
pageInfo.totalResults |
integerLe nombre total de résultats dans l'ensemble de résultats. |
pageInfo.resultsPerPage |
integerLe nombre de résultats inclus dans la réponse de l'API. |
items[] |
listListe des modérateurs correspondant aux critères de la requête. |
Erreurs
L'API ne définit aucun message d'erreur spécifique à cette méthode d'API. Toutefois, cette méthode peut toujours renvoyer des erreurs d'API générales listées dans la documentation sur les messages d'erreur.
Essayer
Utilisez l'APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.