참고: 이 메서드는 2020년 3월 31일부터 지원 중단되었습니다.
members.list
메서드로 대체되었습니다. 이 메서드에 대한 자세한 내용은 YouTube Data API 문서에서 확인할 수 있습니다.sponsors.list
메서드는 2020년 9월 30일부터 더 이상 지원되지 않습니다.
API 클라이언트는 members.list
메서드를 대신 사용하도록 sponsors.list
메서드 호출을 업데이트해야 합니다.
채널의 회원 (이전 명칭: '스폰서')을 나열합니다. API 요청은 채널 소유자의 승인을 받아야 합니다.
일반적인 사용 사례
요청
HTTP 요청
GET https://www.googleapis.com/youtube/v3/sponsors
승인
이 요청에는 다음 범위 중 최소 하나를 사용하여 인증이 필요합니다. (인증 및 승인에 대해 자세히 알아보기)
범위 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
매개변수
다음 표에는 이 쿼리가 지원하는 매개변수가 나와 있습니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.
매개변수 | ||
---|---|---|
필수 매개변수 | ||
part |
string part 매개변수는 API 응답에 포함될 sponsor 리소스 부분을 지정합니다. 지원되는 값은 id 및 snippet 입니다. |
|
선택적 매개변수 | ||
filter |
string filter 매개변수는 반환할 스폰서 채널을 지정합니다. 기본값은 newest 입니다.허용되는 값은 다음과 같습니다.
|
|
maxResults |
unsigned integer maxResults 매개변수는 결과 집합에 반환해야 하는 최대 항목 수를 지정합니다. 사용 가능한 값: 0 ~50 기본값은 5 입니다. |
|
pageToken |
string pageToken 매개변수는 반환해야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 속성과 prevPageToken 속성은 검색 가능한 다른 페이지를 식별합니다. |
요청 본문
이 메소드를 호출할 때 요청 본문을 제공하지 마세요.
응답
요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.
{ "kind": "youtube#sponsorListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ sponsor resource ] }
속성
다음 표는 이 리소스에 표시되는 속성을 정의합니다.
속성 | |
---|---|
kind |
string API 리소스 유형을 식별합니다. 값은 youtube#sponsorListResponse 입니다. |
etag |
etag 이 리소스의 Etag입니다. |
nextPageToken |
string pageToken 매개변수의 값으로 사용하여 결과 집합의 다음 페이지를 검색할 수 있는 토큰입니다. |
pageInfo |
object pageInfo 객체는 결과 집합의 페이지 정보를 요약합니다. |
pageInfo.totalResults |
integer 결과 집합의 총 결과 수입니다. |
pageInfo.resultsPerPage |
integer API 응답에 포함된 결과 수입니다. |
items[] |
list 요청 기준과 일치하는 스폰서 목록입니다. |
오류
다음 표에서는 이 메서드에 대한 호출에 대한 응답으로 API가 반환할 수 있는 오류 메시지를 확인합니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.
오류 유형 | 오류 세부정보 | 설명 |
---|---|---|
forbidden (403) |
insufficientPermissions |
채널의 스폰서를 보는 데 필요한 권한이 없습니다. |
invalidValue (400) |
invalidValueInRequest |
요청에 잘못된 값이 포함되어 있습니다. |
invalidValue (400) |
sponsorshipNotEnabledForChannelId |
채널에서 VIP 멤버십을 사용 설정하지 않았습니다. |
사용해 보기
APIs Explorer를 사용하여 이 API를 호출하고 API 요청 및 응답을 확인하세요.