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:
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 |
stringXác định loại tài nguyên API. Giá trị sẽ là youtube#subscription. |
etag |
etagEtag của tài nguyên này. |
id |
stringMã 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 |
datetimeNgày và giờ tạo gói thuê bao. Giá trị được chỉ định ở định dạng ISO 8601. |
snippet.title |
stringTiêu đề của gói thuê bao. |
snippet.description |
stringThô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 |
stringLoại tài nguyên API. |
snippet.resourceId.channelId |
stringGiá trị mà YouTube dùng để nhận dạng duy nhất kênh mà người dùng đã đăng ký. |
snippet.channelId |
stringMã 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 |
objectBả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) |
objectCác giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
stringURL của hình ảnh. |
snippet.thumbnails.(key).width |
unsigned integerChiều rộng của hình ảnh. |
snippet.thumbnails.(key).height |
unsigned integerChiề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 integerSố lượng mặt hàng ước tính mà gói thuê bao trỏ đến. |
contentDetails.newItemCount |
unsigned integerSố 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 |
stringLoạ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à:
|
subscriberSnippet |
objectĐối tượng subscriberSnippet chứa thông tin cơ bản về người đăng ký. |
subscriberSnippet.title |
stringTiêu đề kênh của người đăng ký. |
subscriberSnippet.description |
stringNội dung mô tả kênh của người đăng ký. |
subscriberSnippet.channelId |
stringMã 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 |
objectHình thu nhỏ của kênh mà người dùng đã đăng ký. |
subscriberSnippet.thumbnails.(key) |
objectCác giá trị khoá hợp lệ là:
|
subscriberSnippet.thumbnails.(key).url |
stringURL của hình ảnh. |
subscriberSnippet.thumbnails.(key).width |
unsigned integerChiều rộng của hình ảnh. |
subscriberSnippet.thumbnails.(key).height |
unsigned integerChiều cao của hình ảnh. |