Subscriptions

Tài nguyên subscription chứa thông tin về một lượt đăng ký của người dùng YouTube. Khi có video mới trên một kênh hoặc khi một người dùng khác thực hiện một trong số các hành động trên YouTube (chẳng hạn như tải video lên, đánh giá video hoặc bình luận về video), người dùng đã đăng ký sẽ nhận được thông báo.

Phương thức

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

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

Cách trình bày 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 duy nhất mà YouTube dùng để xác định 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ị được chỉ định ở định dạng ISO 8601.
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 dùng để nhận dạng duy nhất kênh mà người dùng đã đăng ký.
snippet.channelId string
Mã nhận dạng mà YouTube 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à 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 cho một video (hoặc một tài nguyên đề cập đến 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 120 pixel và chiều cao 90 pixel. Hình thu nhỏ mặc định của kênh có kích thước rộng 88 pixel và cao 88 pixel.
  • medium – Phiên bản có độ phân giải cao hơn của hình thu nhỏ. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 320 px và chiều cao 180 px. Đối với kênh, hình ảnh này có chiều rộng 240 px và chiều cao 240 px.
  • high – Phiên bản có độ phân giải cao của hình thu nhỏ. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 480 pixel và chiều cao 360 pixel. Đối với 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 tính 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 nhất người dùng đọc nội dung của gói đó.
contentDetails.activityType string
Loại hoạt động mà gói thuê bao này dành cho (chỉ tải lên, mọi thứ).

Các giá trị hợp lệ cho thuộc tính 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 mà YouTube chỉ định để nhận dạng duy nhất kênh của người đăng ký.
subscriberSnippet.thumbnails object
Hình thu nhỏ của kênh mà người dùng đã đă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 cho một video (hoặc một tài nguyên đề cập đến 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 120 pixel và chiều cao 90 pixel. Hình thu nhỏ mặc định của kênh có kích thước rộng 88 pixel và cao 88 pixel.
  • medium – Phiên bản có độ phân giải cao hơn của hình thu nhỏ. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 320 px và chiều cao 180 px. Đối với kênh, hình ảnh này có chiều rộng 240 px và chiều cao 240 px.
  • high – Phiên bản có độ phân giải cao của hình thu nhỏ. Đối với video (hoặc tài nguyên đề cập đến video), hình ảnh này có chiều rộng 480 pixel và chiều cao 360 pixel. Đối với 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.