LiveChatModerators: list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
列出实时聊天的管理员。此请求必须获得实时聊天频道的所有者授权。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 |
| 必需参数 |
liveChatId |
string
liveChatId 参数用于指定 YouTube 实时聊天，该 API 应返回管理员。与广播相关联的实时聊天 ID 会在 liveBroadcast 资源的 snippet.liveChatId 属性中返回。 |
part |
string
part 参数指定 API 响应将包含的 liveChatModerator 资源部分。支持的值包括 id 和 snippet。 |
| 可选参数 |
maxResults |
unsigned integer
maxResults 参数指定结果集中应返回的商品数量上限。可接受的值包括0到50（含 0 和 10000）。默认值为 5。 |
pageToken |
string
pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中，nextPageToken 和 prevPageToken 属性用于标识可检索到的其他页面。 |
响应
如果成功，此方法将返回采用以下结构的响应正文：
{
"kind": "youtube#liveChatModeratorListResponse",
"etag": etag,
"prevPageToken": string,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
liveChatModerator Resource
]
}
属性
下表定义了此资源中显示的属性：
| 属性 |
kind |
string
标识 API 资源的类型。其值为 youtube#liveChatModeratorListResponse。 |
etag |
etag
此资源的 Etag。 |
prevPageToken |
string
可用作 pageToken 参数值的令牌，用于检索结果集中的上一页。 |
nextPageToken |
string
可用作 pageToken 参数值的令牌，用于检索结果集中的下一页。 |
pageInfo |
object
pageInfo 对象可封装结果集的分页信息。 |
pageInfo.totalResults |
integer
结果集中的结果总数。 |
pageInfo.resultsPerPage |
integer
API 响应中包含的结果数量。 |
items[] |
list
符合请求条件的管理员列表。 |
错误
API 未定义此 API 方法特有的任何错误消息。不过，此方法可能仍会返回错误消息文档中列出的常规 API 错误。
试试看！
使用 APIs Explorer 调用此 API 并查看 API 请求和响应。
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2024-04-26。
[null,null,["最后更新时间 (UTC)：2024-04-26。"],[],[],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."]]
