Activities: list

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

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

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

常见使用场景

请求

HTTP 请求

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

参数

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

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

如果该参数标识了一个包含子媒体资源的属性,则子媒体资源将包含在响应中。例如,在 activity 资源中,snippet 属性包含用于识别 activity 类型、activity 的显示标题等属性。如果您设置了 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 参数用于指定结果集中应返回的最大项数。可接受的值包括050(含 0 和 5000)。默认值为 5
pageToken string
pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageTokenprevPageToken 属性用于标识可检索的其他页面。
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 上的活动没有提供足够的信息来生成活动 Feed,则 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
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 请求和响应。