Channels: list

참고: 구독자 수 표시 방식에 영향을 미치는 YouTube 정책 변경사항을 반영하도록 channel 리소스의 statistics.subscriberCount 속성 값이 업데이트되었습니다. 자세한 내용은 수정 내역 또는 YouTube 고객센터를 참고하세요.

요청 기준과 일치하는 channel 리소스 0개 이상으로 구성된 컬렉션을 반환합니다.

할당량 영향: 이 메서드를 호출하면 할당량 비용이 1단위 부과됩니다.

일반적인 사용 사례

요청

HTTP 요청

GET https://www.googleapis.com/youtube/v3/channels

승인

channel 리소스의 auditDetails 부분을 검색하는 요청은 https://www.googleapis.com/auth/youtubepartner-channel-audit 범위가 포함된 승인 토큰을 제공해야 합니다. 또한 해당 범위를 사용하는 모든 토큰은 MCN에서 채널을 수락하거나 거부하기로 결정했을 때 또는 토큰이 발급된 날로부터 2주 이내에 취소되어야 합니다.

매개변수

다음 표에는 이 쿼리가 지원하는 매개변수가 나와 있습니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.

매개변수
필수 매개변수
part string
part 매개변수는 API 응답에 포함할 하나 이상의 channel 리소스 속성의 쉼표로 구분된 목록을 지정합니다.

매개변수가 하위 속성이 포함된 속성을 식별하면 하위 속성이 응답에 포함됩니다. 예를 들어 channel 리소스에서 contentDetails 속성에는 uploads 속성과 같은 다른 속성이 포함됩니다. 따라서 part=contentDetails를 설정하면 API 응답에 이러한 중첩된 속성도 모두 포함됩니다.

다음 목록에는 매개변수 값에 포함할 수 있는 part 이름이 포함되어 있습니다.
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
필터(다음 매개변수 중 정확히 하나만 지정)
categoryId string
이 매개변수는 지원 중단되었습니다. categoryId 매개변수는 YouTube 가이드 카테고리를 지정했으며 이 카테고리와 연결된 YouTube 채널을 요청하는 데 사용할 수 있습니다.
forHandle string
forHandle 매개변수는 YouTube 핸들을 지정하여 해당 핸들과 연결된 채널을 요청합니다. 매개변수 값 앞에 @ 기호를 추가할 수 있습니다. 예를 들어 'Google for Developers' 채널의 리소스를 검색하려면 forHandle 매개변수 값을 GoogleDevelopers 또는 @GoogleDevelopers로 설정합니다.
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에 인증된 사용자가 소유한 채널만 반환하도록 지시합니다.
선택적 매개변수
hl string
hl 매개변수는 API에 YouTube 웹사이트에서 지원하는 특정 애플리케이션 언어의 현지화된 리소스 메타데이터를 검색하도록 지시합니다. 매개변수 값은 i18nLanguages.list 메서드에서 반환된 목록에 포함된 언어 코드여야 합니다.

해당 언어로 현지화된 리소스 세부정보를 사용할 수 있는 경우 리소스의 snippet.localized 객체에 현지화된 값이 포함됩니다. 하지만 현지화된 세부정보를 사용할 수 없는 경우 snippet.localized 객체에는 리소스의 기본 언어로 된 리소스 세부정보가 포함됩니다.
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 매개변수의 값으로 사용할 수 있는 토큰입니다. 상응하는 API 요청에서 managedByMe 매개변수를 true로 설정하면 이 속성이 API 응답에 포함되지 않습니다.
pageInfo object
pageInfo 객체는 결과 집합의 페이징 정보를 캡슐화합니다.
pageInfo.totalResults integer
결과 집합의 총 결과 수입니다.
pageInfo.resultsPerPage integer
API 응답에 포함된 결과 수입니다.
items[] list
요청 기준과 일치하는 채널 목록입니다.

오류

다음 표에는 이 메서드 호출에 대한 응답으로 API에서 반환할 수 있는 오류 메시지가 나와 있습니다. 자세한 내용은 YouTube Data API - 오류를 참고하세요.

오류 유형 오류 세부정보 설명
badRequest (400) invalidCriteria id, categoryId, mine, managedByMe, forHandle, forUsername 필터 중 최대 하나를 지정할 수 있습니다. onBehalfOfContentOwner 매개변수를 통한 콘텐츠 소유자 인증의 경우 id 또는 managedByMe만 지정할 수 있습니다.
forbidden (403) channelForbidden id 매개변수로 지정된 채널이 요청을 지원하지 않거나 요청이 올바르게 승인되지 않았습니다.
notFound (404) categoryNotFound categoryId 매개변수로 식별된 카테고리를 찾을 수 없습니다. guideCategories.list 메서드를 사용하여 유효한 값 목록을 가져옵니다.
notFound (404) channelNotFound id 매개변수에 지정된 채널을 찾을 수 없습니다.

사용해 보기

APIs Explorer를 사용하여 이 API를 호출하고 API 요청 및 응답을 확인합니다.