Activities: list

YouTube 已废弃频道公告功能。activities.list 方法不再返回频道公告，且不再支持 activities.insert 方法。如需了解详情，请参阅 YouTube 帮助中心。

返回与请求条件匹配的频道活动事件列表。例如，您可以检索与特定频道或用户自己的频道关联的事件。

配额影响： 调用此方法的配额费用为 1 个单位。

常见应用场景

请求

HTTP 请求

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

参数

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

参数
必需参数
part string
part 参数用于指定一个或多个 activity 资源属性的英文逗号分隔列表，API 响应将包含这些属性。

如果该参数标识的属性包含子属性，则子属性将包含在响应中。例如，在 activity 资源中，snippet 属性包含其他属性，这些属性用于标识活动类型、活动的显示标题等。如果您设置 part=snippet，API 响应还将包含所有这些嵌套属性。

以下列表包含您可以包含在参数值中的 part 名称：
  • contentDetails
  • id
  • snippet
过滤条件 （准确指定以下参数之一）
channelId string
channelId 参数用于指定唯一的 YouTube 频道 ID。然后，API 将返回该频道的活动列表。
home boolean
注意： 此参数已废弃。
对于设置此参数的请求，API 响应包含的项与已退出登录的用户在 YouTube 首页上看到的项类似。请注意，此参数只能在经过适当授权的请求中使用。
mine boolean
此参数只能在经过适当授权的请求中使用。将此参数的值设置为 true，以检索经过身份验证的用户的活动 Feed。
可选参数
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的项数上限。可接受的值为 0 到 50（含端点值）。默认值为 5。
pageToken string
pageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中，nextPageToken 和 prevPageToken 属性用于标识可以检索的其他页面。
publishedAfter datetime
publishedAfter 参数用于指定活动可能发生的最早日期和时间，以便将该活动包含在 API 响应中。如果参数值指定了日期但未指定时间，则当天发生的任何活动都将包含在结果集中。该值采用 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
publishedBefore datetime
publishedBefore 参数用于指定活动必须发生的时间，以便将该活动包含在 API 响应中。如果参数值指定了日期但未指定时间，则当天发生的任何活动都将从结果集中排除。该值采用 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
regionCode string
regionCode 参数用于指示 API 返回指定国家/地区的结果。参数值是 ISO 3166-1 alpha-2 国家/地区代码。当经过授权的用户之前在 YouTube 上的活动无法提供足够的信息来生成活动动态时，YouTube 会使用此值。

请求正文

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

响应

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

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

属性

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

属性
kind string
标识 API 资源的类型。该值将为 youtube#activityListResponse。
etag etag
此资源的 ETag。
nextPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的下一页。
prevPageToken string
可用作 pageToken 参数值的令牌，用于检索结果集中的上一页。
pageInfo object
The pageInfo 对象封装了结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
与请求条件匹配的活动或事件列表。

错误

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

错误类型 错误详情 说明
forbidden (403) forbidden 该请求未获得适当授权。
forbidden (403) homeParameterDeprecated 用户的首页活动数据无法通过此 API 获取。如果您在未经授权的请求中将 home 参数设置为 true，则可能会发生此错误。
notFound (404) channelNotFound 找不到请求的 channelId 参数标识的频道 ID。
notFound (404) homeChannelNotFound 找不到当前经过身份验证的用户的 YouTube 首页 Feed。
unauthorized (401) authorizationRequired 该请求使用了 home 参数，但未获得适当授权。

试试看！

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