傳回符合 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 清單,該 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 要求和回應。