Subscriptions

subscription 資源包含 YouTube 使用者訂閱項目的相關資訊。訂閱會在頻道新增影片,或其他使用者在 YouTube 上採取多種行動時 (例如上傳影片、為影片評分,或對影片發表留言) 通知使用者。

方法

這個 API 支援下列 subscriptions 資源的方法:

list
傳回符合 API 要求條件的訂閱資源。 立即試用
插入
為已通過驗證的使用者頻道新增訂閱項目。立即試用
刪除
刪除訂閱項目。立即試用

資源表示法

以下 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
有效的鍵值如下:
  • default:這項資源的預設縮圖。影片的預設縮圖或是資源的影片資源 (例如播放清單項目或搜尋結果) 寬度為 120 像素,高度為 90 像素。頻道的預設縮圖寬度為 88 像素,高度為 88 像素。
  • medium:縮圖圖片的高解析度版本。如果是影片 (或影片專用的資源),這張圖片寬度為 320px,高度為 180px。對頻道而言,這張圖片的圖片寬度為 240px,高度為 240px。
  • high:縮圖的高解析度版本。如果是影片 (或影片專用的資源),這張圖片寬度為 480px,高度為 360px。頻道圖片的寬度為 800 像素,高度為 800 像素。
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
這個訂閱項目適用的活動類型 (僅限上傳、所有項目)。

這項屬性的有效值如下:
  • all
  • uploads
subscriberSnippet object
subscriberSnippet 物件包含訂閱者的基本詳細資料。
subscriberSnippet.title string
訂閱者頻道的標題。
subscriberSnippet.description string
訂閱者頻道的說明。
subscriberSnippet.channelId string
YouTube 指派的 ID 是用來識別訂閱者頻道的專屬 ID。
subscriberSnippet.thumbnails object
訂閱者頻道縮圖。
subscriberSnippet.thumbnails.(key) object
有效的鍵值如下:
  • default:這項資源的預設縮圖。影片的預設縮圖或是資源的影片資源 (例如播放清單項目或搜尋結果) 寬度為 120 像素,高度為 90 像素。頻道的預設縮圖寬度為 88 像素,高度為 88 像素。
  • medium:縮圖圖片的高解析度版本。如果是影片 (或影片專用的資源),這張圖片寬度為 320px,高度為 180px。對頻道而言,這張圖片的圖片寬度為 240px,高度為 240px。
  • high:縮圖的高解析度版本。如果是影片 (或影片專用的資源),這張圖片寬度為 480px,高度為 360px。頻道圖片的寬度為 800 像素,高度為 800 像素。
subscriberSnippet.thumbnails.(key).url string
圖片網址。
subscriberSnippet.thumbnails.(key).width unsigned integer
圖片的寬度。
subscriberSnippet.thumbnails.(key).height unsigned integer
圖片的高度。