LiveChatModerators: list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Elenca i moderatori di una chat live. La richiesta deve essere autorizzata dal proprietario del canale della chat live.
Casi d'uso comuni
Richiesta
Richiesta HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Parametri
La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.
Parametri |
Parametri obbligatori |
liveChatId |
string
Il parametro liveChatId specifica la chat dal vivo di YouTube per la quale l'API deve restituire i moderatori. L'ID della chat dal vivo associato a una trasmissione viene restituito nella proprietà snippet.liveChatId della risorsa liveBroadcast . |
part |
string
Il parametro part specifica le parti della risorsa liveChatModerator che saranno incluse nella risposta dell'API. I valori supportati sono id e snippet . |
Parametri facoltativi |
maxResults |
unsigned integer
Il parametro maxResults specifica il numero massimo di articoli che devono essere restituiti nel set di risultati. I valori accettati sono compresi tra 0 e 50 . Il valore predefinito è 5 . |
pageToken |
string
Il parametro pageToken identifica una pagina specifica da restituire del set di risultati. In una risposta dell'API, le proprietà nextPageToken e prevPageToken identificano altre pagine che è possibile recuperare. |
Corpo della richiesta
Non fornire il corpo della richiesta quando chiami questo metodo.
Risposta
Se l'esito è positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:
{
"kind": "youtube#liveChatModeratorListResponse",
"etag": etag,
"prevPageToken": string,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
liveChatModerator Resource
]
}
Proprietà
La tabella seguente definisce le proprietà visualizzate in questa risorsa:
Proprietà |
kind |
string
Identifica il tipo di risorsa API. Il valore sarà youtube#liveChatModeratorListResponse . |
etag |
etag
L'Etag di questa risorsa. |
prevPageToken |
string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina precedente nel set di risultati. |
nextPageToken |
string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati. |
pageInfo |
object
L'oggetto pageInfo incapsula le informazioni sul paging per il set di risultati. |
pageInfo.totalResults |
integer
Il numero totale di risultati nel set di risultati. |
pageInfo.resultsPerPage |
integer
Il numero di risultati inclusi nella risposta dell'API. |
items[] |
list
Un elenco di moderatori che corrispondono ai criteri della richiesta. |
Errori
L'API non definisce i messaggi di errore univoci per questo metodo API. Tuttavia, questo metodo potrebbe comunque restituire errori generali dell'API elencati nella documentazione relativa ai messaggi di errore.
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-04-26 UTC.
[null,null,["Ultimo aggiornamento 2024-04-26 UTC."],[],[],null,["# LiveChatModerators: list\n\nLists moderators for a live chat. The request must be authorized by the owner of the live chat's channel.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/liveChat/moderators\n```\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `liveChatId` | `string` The **liveChatId** parameter specifies the YouTube live chat for which the API should return moderators. The live chat ID associated with a broadcast is returned in the `liveBroadcast` resource's `snippet.liveChatId` property. |\n| `part` | `string` The **part** parameter specifies the `liveChatModerator` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are `0` to `50`, inclusive. The default value is `5`. |\n| `pageToken` | `string` The **pageToken** parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` and `prevPageToken` properties identify other pages that could be retrieved. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#liveChatModeratorListResponse\",\n \"etag\": etag,\n \"prevPageToken\": string,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n liveChatModerator Resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#liveChatModeratorListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `prevPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the previous page in the result set. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of moderators that match the request criteria. |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/v3/live/docs/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]