Activities: list

YouTube đã ngừng cung cấp tính năng bản tin kênh. Phương thức activities.list vẫn không trả về bản tin của kênh và phương thức activities.insert không còn được hỗ trợ nữa. Để biết thêm thông tin, vui lòng tham khảo Trung tâm trợ giúp của YouTube.

Trả về danh sách các sự kiện hoạt động trên kênh khớp với tiêu chí yêu cầu. Ví dụ: bạn có thể truy xuất các sự kiện liên kết với một kênh cụ thể hoặc với kênh của chính người dùng.

Tác động đến hạn mức: Một lệnh gọi đến phương thức này có chi phí hạn mức là 1 đơn vị.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

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

Thông số

Bảng sau đây liệt kê các tham số mà truy vấn này hỗ trợ. Tất cả các tham số được liệt kê đều là tham số truy vấn.

Thông số
Tham số bắt buộc
part string
Tham số part chỉ định một danh sách được phân tách bằng dấu phẩy gồm một hoặc nhiều thuộc tính tài nguyên activity mà phản hồi của API sẽ bao gồm.

Nếu tham số xác định một thuộc tính chứa các thuộc tính con, thì các thuộc tính con sẽ được đưa vào phản hồi. Ví dụ: trong tài nguyên activity, thuộc tính snippet chứa các thuộc tính khác xác định loại hoạt động, tiêu đề hiển thị cho hoạt động, v.v. Nếu bạn đặt part=snippet, phản hồi của API cũng sẽ chứa tất cả các thuộc tính được lồng đó.

Danh sách sau đây chứa các tên part mà bạn có thể đưa vào giá trị tham số:
  • contentDetails
  • id
  • snippet
Bộ lọc (chỉ định chính xác một trong các tham số sau)
channelId string
Tham số channelId chỉ định một mã nhận dạng kênh YouTube duy nhất. Sau đó, API sẽ trả về danh sách các hoạt động của kênh đó.
home boolean
Lưu ý: Tham số này không còn được dùng nữa.
Đối với những yêu cầu đặt tham số này, phản hồi của API sẽ chứa các mục tương tự như những mục mà người dùng đã đăng xuất sẽ thấy trên trang chủ YouTube. Xin lưu ý rằng bạn chỉ có thể sử dụng tham số này trong một yêu cầu được uỷ quyền đúng cách.
mine boolean
Bạn chỉ có thể dùng tham số này trong một yêu cầu được uỷ quyền đúng cách. Đặt giá trị của tham số này thành true để truy xuất nguồn cấp dữ liệu về các hoạt động của người dùng đã xác thực.
Thông số tuỳ chọn
maxResults unsigned integer
Tham số maxResults chỉ định số lượng tối đa các mục sẽ được trả về trong tập kết quả. Giá trị được chấp nhận là từ 0 đến 50. Giá trị mặc định là 5.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập kết quả cần được trả về. Trong một phản hồi của API, các thuộc tính nextPageToken và prevPageToken xác định những trang khác có thể được truy xuất.
publishedAfter datetime
Tham số publishedAfter chỉ định ngày và giờ sớm nhất mà một hoạt động có thể đã xảy ra để hoạt động đó được đưa vào phản hồi của API. Nếu giá trị tham số chỉ định một ngày nhưng không chỉ định thời gian, thì mọi hoạt động xảy ra vào ngày đó sẽ được đưa vào tập kết quả. Giá trị được chỉ định ở định dạng ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
publishedBefore datetime
Tham số publishedBefore chỉ định ngày và giờ mà một hoạt động phải xảy ra trước đó để hoạt động đó được đưa vào phản hồi của API. Nếu giá trị tham số chỉ định một ngày nhưng không chỉ định thời gian, thì mọi hoạt động xảy ra vào ngày đó sẽ bị loại trừ khỏi tập kết quả. Giá trị được chỉ định theo định dạng ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
regionCode string
Tham số regionCode hướng dẫn API trả về kết quả cho quốc gia được chỉ định. Giá trị tham số là mã quốc gia theo ISO 3166-1 alpha-2. YouTube sử dụng giá trị này khi hoạt động trước đó của người dùng được uỷ quyền trên YouTube không cung cấp đủ thông tin để tạo Bảng tin hoạt động.

Nội dung yêu cầu

Không cung cấp nội dung yêu cầu khi gọi phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về nội dung phản hồi có cấu trúc như sau:

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

Thuộc tính

Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:

Thuộc tính
kind string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#activityListResponse.
etag etag
Etag của tài nguyên này.
nextPageToken string
Mã thông báo có thể được dùng làm giá trị của tham số pageToken để truy xuất trang tiếp theo trong tập kết quả.
prevPageToken string
Mã thông báo có thể được dùng làm giá trị của tham số pageToken để truy xuất trang trước đó trong tập kết quả.
pageInfo object
Đối tượng pageInfo đóng gói thông tin phân trang cho tập hợp kết quả.
pageInfo.totalResults integer
Tổng số kết quả trong tập kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi của API.
items[] list
Danh sách các hoạt động hoặc sự kiện khớp với tiêu chí của yêu cầu.

Lỗi

Bảng sau đây xác định các thông báo lỗi mà API có thể trả về để phản hồi lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm chi tiết.

Loại lỗi Thông tin chi tiết về lỗi Mô tả
forbidden (403) forbidden Yêu cầu không được uỷ quyền đúng cách.
forbidden (403) homeParameterDeprecated API này không cung cấp dữ liệu về hoạt động trên trang chủ của người dùng. Lỗi này có thể xảy ra nếu bạn đặt tham số home thành true trong một yêu cầu trái phép.
notFound (404) channelNotFound Không tìm thấy mã nhận dạng kênh do tham số channelId của yêu cầu xác định.
notFound (404) homeChannelNotFound Không tìm thấy nguồn cấp dữ liệu trang chủ YouTube cho người dùng hiện đang được xác thực.
unauthorized (401) authorizationRequired Yêu cầu sử dụng tham số home nhưng không được uỷ quyền đúng cách.

Hãy dùng thử!

Sử dụng APIs Explorer để gọi API này và xem Yêu cầu API cũng như phản hồi của API.