傳回符合 API 要求條件的 channelSection
資源清單。
配額影響:呼叫這個方法的配額為 1 個單位。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/channelSections
參數
下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
part |
string part 參數會指定一份以半形逗號分隔的清單,列出一或多個 API 回應會包含的 channelSection 資源屬性。如果參數識別含有子屬性的屬性,則回應中會加入這些子項屬性。舉例來說,在 channelSection 資源中,snippet 屬性包含其他屬性,例如該部分的顯示標題。如果設定 part=snippet ,API 回應也會包含所有巢狀屬性。以下清單包含您可以加入參數值中的 part 名稱:
|
|
篩選器 (請僅指定下列其中一個參數) | ||
channelId |
string channelId 參數會指定 YouTube 頻道 ID。如果要求指定這個參數的值,API 只會傳回指定頻道的區段。 |
|
id |
string id 參數會指定以半形逗號分隔的 ID 清單,專門識別要擷取的 channelSection 資源。在 channelSection 資源中,id 屬性會指定版面的 ID。 |
|
mine |
boolean 這個參數只能在正確的授權要求中使用。將這個參數的值設為 true ,即可擷取與已驗證使用者 YouTube 頻道相關聯的頻道版面動態消息。 |
|
選用參數 | ||
hl |
string 這個參數已淘汰。 透過 hl 參數擷取頻道版面的本地化中繼資料的支援。不過,YouTube 工作室和 YouTube 應用程式已淘汰這項功能。 |
|
onBehalfOfContentOwner |
string 這個參數只能在正確的授權要求中使用。注意:這個參數僅適用於 YouTube 內容合作夥伴。 onBehalfOfContentOwner 參數代表透過要求的授權憑證,代表 YouTube CMS 使用者,代表在參數值中指定的內容擁有者擔任代理人。這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要通過一次驗證,即可存取所有影片和頻道資料,不必分別提供各個頻道的驗證憑證。用於驗證的 CMS 帳戶,必須連結至指定的 YouTube 內容擁有者。 |
要求主體
呼叫此方法時,不要提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#channelSectionListResponse", "etag": etag, "items": [ channelSection Resource ] }
屬性
下表定義了這項資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源的類型。值為 youtube#channelSectionListResponse 。 |
etag |
etag 這項資源的 Etag。 |
items[] |
list 符合要求條件的 ChannelSection 清單。 |
錯誤
下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
channelSectionForbidden |
要求者無法存取所要求的頻道版面。 |
invalidValue (400) |
idInvalid |
要求指定的頻道版面 ID 無效。 |
invalidValue (400) |
invalidCriteria |
篩選條件無效,因此無法完成要求。 |
notFound (404) |
channelNotFound |
找不到與要求相關聯的頻道。 |
notFound (404) |
channelSectionNotFound |
找不到與要求相關聯的頻道版面。 |
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。