Subscriptions

Tài nguyên subscription chứa thông tin về một gói thuê bao của người dùng trên YouTube. Gói đăng ký sẽ thông báo cho người dùng khi có 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 nhiều thao tác trên YouTube, chẳng hạn như tải video lên, xếp hạng video hoặc nhận xét về một video.

Phương thức

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

list
Trả về những tài nguyên gói thuê bao khớp với tiêu chí yêu cầu của 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.

Trình bày tài nguyên

Cấu trúc JSON dưới đây thể hiện đị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
Thẻ Etag của tài nguyên này.
id string
Mã nhận dạng mà YouTube dùng để xác định riêng biệ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ả tên gói 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ị được chỉ định theo định dạng ISO 8601.
snippet.channelTitle string
Tiêu đề của kênh chứa gói thuê bao.
snippet.title string
Tiêu đề 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 riêng biệt kênh mà người dùng đăng ký theo dõi.
snippet.channelId string
Mã nhận dạng mà YouTube dùng để nhận dạng riêng 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 quan đến 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à một đố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 cho 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 video), chẳng hạn như mục trong danh sách phát hoặc kết quả tìm kiếm, có chiều rộng 120px và chiều cao 90px. Hình thu nhỏ mặc định cho kênh có chiều rộng 88 px và chiều cao 88 px.
  • 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 rộng 320px và cao 180px. Đối với 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 một video), hình ảnh này rộng 480px và cao 360px. Đối với kênh, hình ảnh này rộng 800px và 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ục gần đúng mà gói thuê bao trỏ đến.
contentDetails.newItemCount unsigned integer
Số lượng mục mới trong gói thuê bao kể từ lần gần đây nhất nội dung của gói thuê bao được đọc.
contentDetails.activityType string
Loại hoạt động dành cho gói thuê bao này (chỉ tải lên, mọi nội dung).

Các 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
Nội dung mô tả kênh của người đăng ký.
subscriberSnippet.channelId string
Mã nhận dạng do 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 cho 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 video), chẳng hạn như mục trong danh sách phát hoặc kết quả tìm kiếm, có chiều rộng 120px và chiều cao 90px. Hình thu nhỏ mặc định cho kênh có chiều rộng 88 px và chiều cao 88 px.
  • 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 rộng 320px và cao 180px. Đối với 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 một video), hình ảnh này rộng 480px và cao 360px. Đối với kênh, hình ảnh này rộng 800px và 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.