subscription
資源包含 YouTube 使用者訂閱的相關資訊。當頻道有新影片加入頻道,或是其他使用者在 YouTube 上採取下列其中一項動作 (例如上傳影片、為影片或評論影片) 時,訂閱會收到通知。
方法
這個 API 支援下列 subscriptions
資源方法:
資源表示法
下列 JSON 結構顯示 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 } } } }
屬性
下表定義了這項資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源的類型。值為 youtube#subscription 。 |
etag |
etag 這項資源的 Etag。 |
id |
string YouTube 用來識別訂閱項目的 ID。 |
snippet |
object snippet 物件包含訂閱項目的基本詳細資料,包括標題及使用者訂閱的頻道。 |
snippet.publishedAt |
datetime 訂閱項目的建立日期和時間。這個值是以 ISO 8601 格式指定。 |
snippet.channelTitle |
string 訂閱項目所屬的頻道標題。 |
snippet.title |
string 訂閱項目的名稱。 |
snippet.description |
string 訂閱項目的詳細資料。 |
snippet.resourceId |
object id 物件含有使用者所訂閱頻道的相關資訊。 |
snippet.resourceId.kind |
string API 資源的類型。 |
snippet.resourceId.channelId |
string YouTube 用來識別使用者訂閱頻道的專屬值。 |
snippet.channelId |
string YouTube 用來識別訂閱者頻道的專屬 ID。 resource_id 物件可識別使用者訂閱的頻道。 |
snippet.thumbnails |
object 訂閱相關縮圖的圖片地圖。地圖上每個物件的鍵都是縮圖名稱,值則是包含縮圖其他資訊的物件。 |
snippet.thumbnails.(key) |
object 有效的鍵/值包括:
|
snippet.thumbnails.(key).url |
string 圖片的網址。 |
snippet.thumbnails.(key).width |
unsigned integer 圖片的寬度。 |
snippet.thumbnails.(key).height |
unsigned integer 圖片的高度。 |
contentDetails |
object contentDetails 物件包含有關訂閱項目的基本統計資料。 |
contentDetails.totalItemCount |
unsigned integer 訂閱項目指向的約略項目數量。 |
contentDetails.newItemCount |
unsigned integer 自上次讀取訂閱項目以來,訂閱項目中的新項目數量。 |
contentDetails.activityType |
string 這個訂閱項目適用的活動類型 (僅限上傳和所有項目)。 這項資源的有效值如下:
|
subscriberSnippet |
object subscriberSnippet 物件包含訂閱者的基本詳細資料。 |
subscriberSnippet.title |
string 訂閱者頻道的名稱。 |
subscriberSnippet.description |
string 訂閱者頻道的說明。 |
subscriberSnippet.channelId |
string YouTube 指派給訂閱者頻道的專屬 ID。 |
subscriberSnippet.thumbnails |
object 訂閱者頻道的縮圖。 |
subscriberSnippet.thumbnails.(key) |
object 有效的鍵/值包括:
|
subscriberSnippet.thumbnails.(key).url |
string 圖片的網址。 |
subscriberSnippet.thumbnails.(key).width |
unsigned integer 圖片的寬度。 |
subscriberSnippet.thumbnails.(key).height |
unsigned integer 圖片的高度。 |