傳回符合 API 要求條件的 channelSection 資源清單。
配額影響:呼叫這個方法會產生 1 個單位的配額費用。
常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/channelSections
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
| 參數 | ||
|---|---|---|
| 必要參數 | ||
part |
stringpart 參數會指定一或多個 channelSection 資源屬性,並以逗號分隔的清單呈現,這些屬性會包含在 API 回應中。如果參數識別的屬性包含子屬性,則子屬性會包含在回應中。舉例來說,在 channelSection 資源中,snippet 屬性包含其他屬性,例如該部分的顯示標題。如果設定 part=snippet,API 回應也會包含所有巢狀屬性。下列清單包含可納入參數值的 part 名稱:
|
|
| 篩選器 (請指定下列其中一個參數) | ||
channelId |
stringchannelId 參數會指定 YouTube 頻道 ID。如果要求指定了這個參數的值,API 只會傳回指定頻道的版面。 |
|
id |
stringid 參數會指定以半形逗號分隔的 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 要求和回應。