Activities

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

activity 资源包含特定频道或用户在 YouTube 上执行的操作的相关信息。活动供稿中报告的操作包括对视频评分、共享视频、将视频标记为收藏、上传视频等。每个 activity 资源都标识了操作类型、与操作相关联的频道以及与操作相关联的资源,例如已评分或上传的视频。

方法

对于 activities 资源,该 API 支持以下方法:

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

不再支持 activities.insert 方法。

资源表示法

以下 JSON 结构显示了 activities 资源的格式:

{
  "kind": "youtube#activity",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "type": string,
    "groupId": string
  },
  "contentDetails": {
    "upload": {
      "videoId": string
    },
    "like": {
      "resourceId": {
        "kind": string,
        "videoId": string,
      }
    },
    "favorite": {
      "resourceId": {
        "kind": string,
        "videoId": string,
      }
    },
    "comment": {
      "resourceId": {
        "kind": string,
        "videoId": string,
        "channelId": string,
      }
    },
    "subscription": {
      "resourceId": {
        "kind": string,
        "channelId": string,
      }
    },
    "playlistItem": {
      "resourceId": {
        "kind": string,
        "videoId": string,
      },
      "playlistId": string,
      "playlistItemId": string
    },
    "recommendation": {
      "resourceId": {
        "kind": string,
        "videoId": string,
        "channelId": string,
      },
      "reason": string,
      "seedResourceId": {
        "kind": string,
        "videoId": string,
        "channelId": string,
        "playlistId": string
      }
    },
    "social": {
      "type": string,
      "resourceId": {
        "kind": string,
        "videoId": string,
        "channelId": string,
        "playlistId": string
      },
      "author": string,
      "referenceUrl": string,
      "imageUrl": string
    },
    "channelItem": {
      "resourceId": {
      }
    },
  }
}

属性

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

属性
kind string
标识 API 资源的类型。其值为 youtube#activity
etag etag
此资源的 Etag。
id string
YouTube 用来对活动进行唯一标识的 ID。
snippet object
snippet 对象包含有关活动的基本详情,包括活动的类型和组 ID。
snippet.publishedAt datetime
活动发生的日期和时间。该值以 ISO 8601 格式指定。
snippet.channelId string
YouTube 用来唯一标识与活动相关联的频道的 ID。
snippet.title string
主要与 activity 关联的资源的标题。
snippet.description string
主要与 activity 关联的资源的说明。
snippet.thumbnails object
与主要与 activity 关联的资源相关联的缩略图图。对于地图中的每个对象,键是缩略图图片的名称,值是包含有关缩略图的其他信息的对象。
snippet.thumbnails.(key) object
有效的键值对包括:
  • default - 默认的缩略图图片。视频(或引用视频的资源,例如播放列表项或搜索结果)的默认缩略图宽 120 像素,高 90 像素。频道的默认缩略图宽 88 像素,高 88 像素。
  • medium – 更高分辨率版本的缩略图。对于视频(或引用视频的资源),该图片的宽度为 320 像素,高为 180 像素。对于频道,此图片宽 240 像素,高 240 像素。
  • high – 缩略图的高分辨率版本。对于视频(或引用视频的资源),该图片的宽度为 480 像素,高度为 360 像素。对于频道,此图片宽 800 像素,高 800 像素。
  • standard - 分辨率比 high 分辨率更高的缩略图版本。此图片适用于某些视频以及引用视频的其他资源,例如播放列表项或搜索结果。此图片宽 640 像素,高 480 像素。
  • maxres – 缩略图图像的最高分辨率版本。此图片大小适用于某些视频以及引用视频的其他资源,例如播放列表项目或搜索结果。此图片宽 1280 像素,高 720 像素。
snippet.thumbnails.(key).url string
图片的网址。
snippet.thumbnails.(key).width unsigned integer
图片的宽度。
snippet.thumbnails.(key).height unsigned integer
图片的高度。
snippet.channelTitle string
造成此活动的频道的频道标题
snippet.type string
资源所描述的活动的类型。

此属性的有效值包括:
  • channelItem
  • comment -(当前未返回)
  • favorite
  • like
  • playlistItem
  • promotedItem
  • recommendation
  • social
  • subscription
  • upload
  • bulletin (已弃用)
snippet.groupId string
与活动相关联的组 ID。群组 ID 用于标识与同一用户和资源相关联的用户事件。例如,如果用户对某个视频评分并将同一个视频加入收藏,那么这些事件的条目会在用户活动供稿中具有相同的组 ID。在界面中,您可以将具有相同 groupId 值的事件进行分组,以避免重复。
contentDetails object
contentDetails 对象包含与 activity 关联的内容的相关信息。例如,如果 snippet.type 值为 videoRated,则 contentDetails 对象的内容会标识已评分的视频。
contentDetails.upload object
upload 对象包含有关已上传视频的信息。仅当 snippet.typeupload 时,此属性才会显示。
contentDetails.upload.videoId string
YouTube 用来对上传的视频进行唯一标识的 ID。
contentDetails.like object
like 对象包含获得正面评分的资源的相关信息。仅当 snippet.typelike 时,此属性才会显示。
contentDetails.like.resourceId object
resourceId 对象包含标识已评分资源的信息。
contentDetails.like.resourceId.kind string
API 资源的类型。
contentDetails.like.resourceId.videoId string
如果被评分的资源是视频,则 YouTube 用来对视频进行唯一标识的 ID。仅当 resourceId.kindyoutube#video 时,此属性才会显示。
contentDetails.favorite object
favorite 对象包含与标记为收藏视频的视频相关的信息。仅当 snippet.typefavorite 时,此属性才会显示。
contentDetails.favorite.resourceId object
resourceId 对象包含的信息用于标识被标记为收藏的资源。
contentDetails.favorite.resourceId.kind string
API 资源的类型。
contentDetails.favorite.resourceId.videoId string
YouTube 用来唯一标识收藏视频的 ID。仅当 resourceId.kindyoutube#video 时,此属性才会显示。

注意activities.list 方法目前不会为新注释返回资源。
contentDetails.comment object
comment 对象包含收到评论的资源的相关信息。仅当 snippet.typecomment 时,此属性才会显示。
contentDetails.comment.resourceId object
resourceId 对象包含标识与评论关联的资源的信息。
contentDetails.comment.resourceId.kind string
API 资源的类型。
contentDetails.comment.resourceId.videoId string
YouTube 用来唯一标识与评论相关联的视频的 ID。仅当 resourceId.kindyoutube#video 时,此属性才会显示。
contentDetails.comment.resourceId.channelId string
YouTube 用来唯一标识与评论相关联的频道的 ID。仅当 resourceId.kindyoutube#channel 时,此属性才会显示。
contentDetails.subscription object
subscription 对象包含与用户订阅的频道相关的信息。仅当 snippet.typesubscription 时,此属性才会显示。
contentDetails.subscription.resourceId object
resourceId 对象包含标识用户所订阅资源的信息。
contentDetails.subscription.resourceId.kind string
API 资源的类型。
contentDetails.subscription.resourceId.channelId string
YouTube 用来唯一标识用户所订阅频道的 ID。仅当 resourceId.kindyoutube#channel 时,此属性才会显示。
contentDetails.playlistItem object
playlistItem 对象包含有关新播放列表项的信息。仅当 snippet.typeplaylistItem 时,此属性才会显示。
contentDetails.playlistItem.resourceId object
resourceId 对象包含的信息用于标识添加到播放列表的资源。
contentDetails.playlistItem.resourceId.kind string
API 资源的类型。
contentDetails.playlistItem.resourceId.videoId string
YouTube 用来唯一标识添加到播放列表的视频的 ID。仅当 resourceId.kindyoutube#video 时,此属性才会显示。
contentDetails.playlistItem.playlistId string
YouTube 用来唯一标识播放列表的值。
contentDetails.playlistItem.playlistItemId string
YouTube 用来对播放列表中的项进行唯一标识的值。
contentDetails.recommendation object
recommendation 对象包含有关推荐资源的信息。仅当 snippet.typerecommendation 时,此属性才会显示。
contentDetails.recommendation.resourceId object
resourceId 对象包含标识推荐资源的信息。
contentDetails.recommendation.resourceId.kind string
API 资源的类型。
contentDetails.recommendation.resourceId.videoId string
如果推荐的资源是视频,YouTube 用来对视频进行唯一标识的 ID。仅当 resourceId.kindyoutube#video 时,此属性才会显示。
contentDetails.recommendation.resourceId.channelId string
如果推荐资源为频道,则 YouTube 会使用此 ID 来唯一标识频道。仅当 resourceId.kindyoutube#channel 时,此属性才会显示。
contentDetails.recommendation.reason string
系统推荐相应资源的原因。

此属性的有效值包括:
  • videoFavorited
  • videoLiked
  • videoWatched
contentDetails.recommendation.seedResourceId object
seedResourceId 对象包含有关生成推荐的资源的信息。
contentDetails.recommendation.seedResourceId.kind string
API 资源的类型。
contentDetails.recommendation.seedResourceId.videoId string
如果推荐是由特定视频引发的,则 YouTube 会使用该 ID 对视频进行唯一标识。仅当 seedResourceId.kindyoutube#video 时,此属性才会显示。
contentDetails.recommendation.seedResourceId.channelId string
如果推荐是由特定频道引发的,那么 YouTube 会使用此 ID 来唯一标识该频道。仅当 seedResourceId.kindyoutube#channel 时,此属性才会显示。
contentDetails.recommendation.seedResourceId.playlistId string
如果推荐是由特定播放列表促成的,则 YouTube 会使用此 ID 对播放列表进行唯一标识。仅当 seedResourceId.kindyoutube#playlist 时,此属性才会显示。
contentDetails.social object
social 对象包含有关社交网络帖子的详细信息。仅当 snippet.typesocial 时,此属性才会显示。
contentDetails.social.type string
社交网络的名称。

此属性的有效值包括:
  • facebook
  • googlePlus
  • twitter
  • unspecified
contentDetails.social.resourceId object
resourceId 对象可封装用于标识与社交网络帖子相关联的资源的信息。
contentDetails.social.resourceId.kind string
API 资源的类型。
contentDetails.social.resourceId.videoId string
如果社交网络帖子引用了视频,YouTube 会使用此 ID 对相应视频进行唯一标识。仅当 social.resourceId.kind 属性的值为 youtube#video 时,此属性才会显示。
contentDetails.social.resourceId.channelId string
如果社交网络帖子引用了某个频道,YouTube 会使用此 ID 对社交网络帖子中推介的频道进行唯一标识。仅当 social.resourceId.kind 属性的值为 youtube#channel 时,此属性才会显示。
contentDetails.social.resourceId.playlistId string
如果社交网络帖子引用了播放列表,YouTube 会使用此 ID 对社交网络帖子中的播放列表进行唯一标识。仅当 social.resourceId.kind 属性的值为 youtube#playlist 时,此属性才会显示。
contentDetails.social.author string
社交网络帖子的作者。
contentDetails.social.referenceUrl string
社交网络帖子的网址。
contentDetails.social.imageUrl string
帖子作者的图片。
contentDetails.channelItem object
channelItem 对象包含有关添加到渠道的资源的详细信息。仅当 snippet.typechannelItem 时,此属性才会显示。
contentDetails.channelItem.resourceId object
resourceId 对象包含的信息用于标识已添加到渠道的资源。