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 和 10000)。默认值为 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 请求和响应。