요청 기준과 일치하는 0개 이상의 channel
리소스 집합을 반환합니다.
지금 사용해 보세요.
요청
HTTP 요청
GET https://www.googleapis.com/youtube/v3/channels
매개변수
아래 표는 이 쿼리가 지원하는 매개변수 목록입니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.
매개변수 이름 | ||
---|---|---|
필수 매개변수 | ||
part |
string part 매개변수는 API 응답이 포함하는 channel 리소스 속성 하나 이상의 쉼표로 구분된 목록을 지정합니다. 매개변수 값에 포함할 수 있는 part 이름은 id , snippet , brandingSettings , contentDetails , invideoPromotion , statistics , topicDetails 입니다.매개변수가 하위 속성을 포함하는 속성을 식별하는 경우 하위 속성이 응답에 포함됩니다. 예를 들어 channel 리소스에서 contentDetails 속성은 uploads 속성 등 기타 속성을 포함합니다. 따라서 part=contentDetails 를 설정하는 경우 API 응답은 중첩된 속성도 모두 포함합니다. |
|
필터(다음 매개변수 중 하나만 지정합니다.) | ||
categoryId |
string categoryId 매개변수는 YouTube 가이드 카테고리를 지정하여 카테고리와 관련된 YouTube 채널을 요청합니다. |
|
forUsername |
string forUsername 매개변수는 YouTube 사용자 이름을 지정하여 사용자 이름과 관련된 채널을 요청합니다. |
|
id |
string id 매개변수는 검색되는 리소스에 대한 YouTube 채널 ID의 쉼표로 구분된 목록을 지정합니다. channel 리소스에서 id 속성은 채널의 YouTube 채널 ID를 지정합니다. |
|
managedByMe |
boolean 이 매개변수는 제대로 인증된 요청에서만 사용할 수 있습니다. 참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다. 이 매개변수의 값을 true 로 설정하여 API에서 onBehalfOfContentOwner 매개변수가 지정하는 콘텐츠 소유자가 관리하는 채널만 반환하게 합니다. 사용자는 지정된 콘텐츠 소유자와 연결된 CMS 계정으로 인증을 받아야 하고 onBehalfOfContentOwner 를 제공해야 합니다. |
|
mine |
boolean 이 매개변수는 제대로 인증된 요청에서만 사용할 수 있습니다. 이 매개변수의 값을 true 로 설정하여 API에서 인증된 사용자가 소유한 채널만 반환하게 합니다. |
|
mySubscribers |
boolean 이 매개변수는 사용되지 않습니다. 이 매개변수는 제대로 인증된 요청에서만 사용할 수 있습니다. 인증된 사용자의 채널에 대한 구독자 목록을 검색하려면 subscriptions.list 메소드와 mySubscribers 매개변수를 사용합니다. |
|
선택적 매개변수 | ||
maxResults |
unsigned integer maxResults 매개변수는 결과 집합에 반환해야 하는 최대 항목 수를 지정합니다. 허용값은 0 이상 50 이하입니다. 기본값은 5 입니다. |
|
onBehalfOfContentOwner |
string 이 매개변수는 제대로 인증된 요청에서만 사용할 수 있습니다. 참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다. onBehalfOfContentOwner 매개변수는 요청의 승인 사용자 인증 정보가 매개변수 값에 지정된 콘텐츠 소유자를 대신하는 YouTube CMS 사용자를 확인함을 나타냅니다. 이 매개변수는 다양한 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너 전용입니다. 이 매개변수로 콘텐츠 소유자는 각 개별 채널에 승인 사용자 인증 정보를 제공할 필요 없이 한 번 인증하여 모든 동영상 및 채널 데이터에 액세스할 수 있습니다. 사용자가 인증할 CMS 계정은 지정된 YouTube 콘텐츠 소유자에게 연결되어야 합니다. |
|
pageToken |
string pageToken 매개변수는 반환해야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 및 prevPageToken 속성은 검색할 기타 페이지를 식별합니다. |
요청 본문
이 메소드를 호출할 때 요청 본문을 제공하지 마세요.
응답
성공하는 경우 이 메소드는 다음 구조로 응답 본문을 반환합니다.
{ "kind": "youtube#channelListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ channel Resource ] }
속성
다음 표는 이 리소스에 표시되는 속성을 정의합니다.
속성 이름 | |
---|---|
kind |
string API 리소스의 유형입니다. 값은 youtube#channelListResponse 가 됩니다. |
etag |
etag 이 리소스의 Etag입니다. |
nextPageToken |
string pageToken 매개변수의 값으로 사용하여 결과 집합의 다음 페이지를 검색할 수 있는 토큰입니다. |
prevPageToken |
string pageToken 매개변수의 값으로 사용하여 결과 집합의 이전 페이지를 검색할 수 있는 토큰입니다. |
pageInfo |
object pageInfo 개체는 결과 집합의 페이지 정보를 요약합니다. |
pageInfo.totalResults |
integer 결과 집합의 총 결과 수입니다. |
pageInfo.resultsPerPage |
integer API 응답에 포함된 결과 수입니다. |
items[] |
list 요청 기준과 일치하는 채널의 목록입니다. |
오류
아래 표에서는 이 메소드에 대한 호출에 응답하기 위해 API가 반환할 수 있는 오류 메시지를 식별합니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.
오류 유형 | 오류 세부정보 | 설명 |
---|---|---|
forbidden |
channelForbidden |
id 매개변수로 지정된 채널이 요청을 지원하지 않거나 요청이 제대로 인증되지 않았습니다. |
notFound |
categoryNotFound |
categoryId 매개변수로 식별된 카테고리를 찾을 수 없습니다. guideCategories.list 메서드를 사용해 유효한 값의 목록을 검색하세요. |
notFound |
channelNotFound |
id 매개변수에 지정된 채널을 찾을 수 없습니다. |
직접 사용해 보세요!
API Explorer를 사용하여 실시간 데이터에서 이 메소드를 호출하고 API 요청 및 응답을 확인해 보세요.