此页面由 Cloud Translation API 翻译。

SuperChatEvents: list

列出频道在过去 30 天内的超级留言事件。

常见使用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/superChatEvents

授权

此请求需要获得以下至少一个范围的授权（详细了解身份验证和授权）。

范围
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`
`https://www.googleapis.com/auth/youtube.readonly`

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
`part`	`string` `part` 参数用于指定 API 响应将包含的 `superChatEvent` 资源部分。支持的值为 `id` 和 `snippet`。
可选参数
`hl`	`string` `hl` 参数会指示 API 服务器根据特定语言的惯例设置 `snippet.displayString` 属性值的格式，以显示超级留言的购买金额和币种。参数值必须是 `i18nLanguages.list` 方法返回的列表中包含的语言代码。默认值为 `en`，表示默认行为是设置显示字符串格式，就像在英语中一样。例如，默认情况下，字符串的格式为 `$1.00`，而不是 `$1,00`。
`maxResults`	`unsigned integer` `maxResults` 参数用于指定结果集中应返回的最大项数。可接受的值包括`1`到`50`（含 0 和 5000）。默认值为 `5`。
`pageToken`	`string` `pageToken` 参数用于标识结果集中应返回的特定网页。在 API 响应中，`nextPageToken` 和 `prevPageToken` 属性用于标识可检索的其他页面。

请求正文

调用此方法时请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

属性

下表定义了此资源中显示的属性：

属性
`kind`	`string` 标识 API 资源类型。值为 `youtube#superChatEventListResponse`。
`etag`	`etag` 此资源的 Etag。
`nextPageToken`	`string` 可用作 `pageToken` 参数值以检索结果集中的下一页的令牌。
`pageInfo`	`object` `pageInfo` 对象用于封装结果集的分页信息。
`pageInfo.totalResults`	`integer` 结果集中的结果总数。
`pageInfo.resultsPerPage`	`integer` API 响应中包含的结果数。
`items[]`	`list` 符合请求条件的超级留言购买交易列表。

错误

下表列出了该 API 为响应对此方法的调用可能返回的错误消息。如需了解详情，请参阅错误消息文档。

错误类型	错误详情	说明
`forbidden (403)`	`insufficientPermissions`	该请求未获得适当授权，无法检索超级留言活动。

试试看！

使用 APIs Explorer 调用此 API，并查看 API 请求和响应。