LiveChatModerators: list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Wyświetla listę moderatorów czatu na żywo. Prośba musi być zatwierdzona przez właściciela kanału czatu na żywo.
Typowe przypadki użycia
Prośba
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Parametry
W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
| Parametry |
| Parametry wymagane |
liveChatId |
string
Parametr liveChatId określa czat na żywo w YouTube, w przypadku którego interfejs API powinien zwrócić moderatorów. Identyfikator czatu na żywo powiązany z transmisją jest zwracany we właściwości snippet.liveChatId zasobu liveBroadcast. |
part |
string
Parametr part określa części zasobów liveChatModerator, które będzie zawierać odpowiedź interfejsu API. Obsługiwane wartości to id i snippet. |
| Parametry opcjonalne |
maxResults |
unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 0 do 50 (włącznie). Wartością domyślną jest 5. |
pageToken |
string
Parametr pageToken wskazuje w zestawie wyników konkretną stronę, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken identyfikują inne strony, które można pobrać. |
Treść żądania
Nie podawaj treści żądania podczas wywoływania tej metody.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:
{
"kind": "youtube#liveChatModeratorListResponse",
"etag": etag,
"prevPageToken": string,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
liveChatModerator Resource
]
}
Właściwości
Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:
| Właściwości |
kind |
string
Określa typ zasobu interfejsu API. Wartością będzie youtube#liveChatModeratorListResponse. |
etag |
etag
ETag tego zasobu. |
prevPageToken |
string
Token, który może być używany jako wartość parametru pageToken do pobierania poprzedniej strony w zestawie wyników. |
nextPageToken |
string
Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zestawie wyników. |
pageInfo |
object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników. |
pageInfo.totalResults |
integer
Łączna liczba wyników w zestawie. |
pageInfo.resultsPerPage |
integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API. |
items[] |
list
Lista moderatorów spełniających kryteria żądania. |
Błędy
Interfejs API nie definiuje żadnych komunikatów o błędach, które są unikalne dla tej metody interfejsu API. Ta metoda może jednak nadal zwracać ogólne błędy interfejsu API wymienione w dokumentacji komunikatów o błędach.
Wypróbuj
Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-04-26 UTC.
[null,null,["Ostatnia aktualizacja: 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."]]
