Subscriptions

Tài nguyên subscription chứa thông tin về gói thuê bao của người dùng YouTube. Lượt đăng ký thông báo cho người dùng khi video mới được thêm vào kênh hoặc khi người dùng khác thực hiện một trong các hành động trên YouTube, chẳng hạn như tải video lên, xếp hạng video hoặc bình luận về video.

Phương pháp

API hỗ trợ các phương thức sau cho tài nguyên subscriptions:

list
Trả về tài nguyên gói thuê bao khớp với tiêu chí của yêu cầu API. Thử ngay.
chèn
Thêm gói thuê bao cho kênh của người dùng đã xác thực. Thử ngay.
xóa
Xoá gói thuê bao. Thử ngay.

Biểu diễn tài nguyên

Cấu trúc JSON sau đây cho thấy định dạng của tài nguyên subscriptions:

{
  "kind": "youtube#subscription",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelTitle": string,
    "title": string,
    "description": string,
    "resourceId": {
      "kind": string,
      "channelId": string,
    },
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "totalItemCount": unsigned integer,
    "newItemCount": unsigned integer,
    "activityType": string
  },
  "subscriberSnippet": {
    "title": string,
    "description": string,
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  }
}

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#subscription.
etag etag
Etag của tài nguyên này.
id string
Mã nhận dạng mà YouTube sử dụng để nhận dạng duy nhất gói thuê bao.
snippet object
Đối tượng snippet chứa thông tin cơ bản về gói thuê bao, bao gồm cả tiêu đề và kênh mà người dùng đã đăng ký.
snippet.publishedAt datetime
Ngày và giờ tạo gói thuê bao. Giá trị này được chỉ định ở định dạng ISO 8601.
snippet.channelTitle string
Tiêu đề của kênh có gói thuê bao đó.
snippet.title string
Tên của gói thuê bao.
snippet.description string
Thông tin chi tiết về gói thuê bao.
snippet.resourceId object
Đối tượng id chứa thông tin về kênh mà người dùng đăng ký.
snippet.resourceId.kind string
Loại tài nguyên API.
snippet.resourceId.channelId string
Giá trị mà YouTube sử dụng để xác định duy nhất kênh mà người dùng đăng ký.
snippet.channelId string
Mã nhận dạng mà YouTube sử dụng để xác định duy nhất kênh của người đăng ký. Đối tượng resource_id xác định kênh mà người dùng đã đăng ký.
snippet.thumbnails object
Bản đồ hình thu nhỏ liên kết với gói thuê bao. Đối với mỗi đối tượng trong bản đồ, khoá là tên của hình thu nhỏ và giá trị là đối tượng chứa thông tin khác về hình thu nhỏ.
snippet.thumbnails.(key) object
Các giá trị khoá hợp lệ là:
  • default – Hình thu nhỏ mặc định của tài nguyên này. Hình thu nhỏ mặc định của video hoặc tài nguyên đề cập đến một video (chẳng hạn như một mục trong danh sách phát hoặc kết quả tìm kiếm) có chiều rộng là 120px và chiều cao là 90px. Hình thu nhỏ mặc định của một kênh có chiều rộng 88px và chiều cao 88px.
  • medium – Phiên bản hình thu nhỏ có độ phân giải cao hơn. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 320px và chiều cao 180px. Đối với một kênh, hình ảnh này rộng 240px và cao 240px.
  • high – Phiên bản hình thu nhỏ có độ phân giải cao. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 480px và chiều cao 360px. Đối với một kênh, hình ảnh này có chiều rộng 800px và chiều cao 800px.
snippet.thumbnails.(key).url string
URL của hình ảnh.
snippet.thumbnails.(key).width unsigned integer
Chiều rộng của hình ảnh.
snippet.thumbnails.(key).height unsigned integer
Chiều cao của hình ảnh.
contentDetails object
Đối tượng contentDetails chứa số liệu thống kê cơ bản về gói thuê bao.
contentDetails.totalItemCount unsigned integer
Số lượng mặt hàng ước chừng mà gói thuê bao trỏ đến.
contentDetails.newItemCount unsigned integer
Số lượng mặt hàng mới trong gói thuê bao kể từ lần gần nhất nội dung của gói được đọc.
contentDetails.activityType string
Loại hoạt động mà gói thuê bao này hoạt động (chỉ nội dung tải lên, mọi nội dung).

Giá trị hợp lệ cho tài sản này là:
  • all
  • uploads
subscriberSnippet object
Đối tượng subscriberSnippet chứa thông tin cơ bản về người đăng ký.
subscriberSnippet.title string
Tiêu đề kênh của người đăng ký.
subscriberSnippet.description string
Thông tin mô tả kênh của người đăng ký.
subscriberSnippet.channelId string
Mã nhận dạng mà YouTube gán để nhận dạng duy nhất kênh của người đăng ký.
subscriberSnippet.thumbnails object
Hình thu nhỏ cho kênh của người đăng ký.
subscriberSnippet.thumbnails.(key) object
Các giá trị khoá hợp lệ là:
  • default – Hình thu nhỏ mặc định của tài nguyên này. Hình thu nhỏ mặc định của video hoặc tài nguyên đề cập đến một video (chẳng hạn như một mục trong danh sách phát hoặc kết quả tìm kiếm) có chiều rộng là 120px và chiều cao là 90px. Hình thu nhỏ mặc định của một kênh có chiều rộng 88px và chiều cao 88px.
  • medium – Phiên bản hình thu nhỏ có độ phân giải cao hơn. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 320px và chiều cao 180px. Đối với một kênh, hình ảnh này rộng 240px và cao 240px.
  • high – Phiên bản hình thu nhỏ có độ phân giải cao. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 480px và chiều cao 360px. Đối với một kênh, hình ảnh này có chiều rộng 800px và chiều cao 800px.
subscriberSnippet.thumbnails.(key).url string
URL của hình ảnh.
subscriberSnippet.thumbnails.(key).width unsigned integer
Chiều rộng của hình ảnh.
subscriberSnippet.thumbnails.(key).height unsigned integer
Chiều cao của hình ảnh.