참고: 이 엔드포인트는 개인 크리에이터가 자신의 채널 멤버십이 사용 설정된 YouTube 채널을 요청하는 데만 사용할 수 있습니다. Google 또는 YouTube 담당자에게 문의하여 액세스 권한을 요청하세요.
채널의 회원 (이전 명칭: '스폰서')을 나열합니다. API 요청은 채널 소유자의 승인을 받아야 합니다.
할당량 영향: 이 메서드를 호출하면 2단위의 할당량 비용이 적용됩니다.
요청
HTTP 요청
GET https://www.googleapis.com/youtube/v3/members
승인
다음 범위를 사용하여 이 요청을 인증받아야 합니다.
범위 |
---|
https://www.googleapis.com/auth/youtube.channel-memberships.creator |
매개변수
다음 표에는 이 쿼리가 지원하는 매개변수가 나와 있습니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.
매개변수 | ||
---|---|---|
필수 매개변수 | ||
part |
string part 매개변수는 API 응답이 포함하는 member 리소스 속성을 지정합니다. 매개변수 값을 snippet 로 설정합니다. |
|
선택적 매개변수 | ||
mode |
string mode 매개변수는 API 응답에 포함될 구성원을 나타냅니다. 매개변수 값을 다음 값 중 하나로 설정합니다.
|
|
maxResults |
unsigned integer maxResults 매개변수는 결과 집합에 반환해야 하는 최대 항목 수를 지정합니다. 사용 가능한 값: 0 ~1000 기본값은 5 입니다. |
|
pageToken |
string pageToken 매개변수는 반환해야 하는 결과 집합의 특정 페이지를 식별합니다. 토큰은 원래 API 요청과 함께 사용되는 mode 에만 적용되므로 한 모드에서 가져온 페이지 토큰을 사용하여 이후에 다른 모드로 전환할 수 없습니다.
|
|
hasAccessToLevel |
string hasAccessToLevel 매개변수 값은 결과 집합의 멤버가 가져야 하는 최소 수준을 지정하는 수준 ID입니다. |
|
filterByMemberChannelId |
string filterByMemberChannelId 매개변수는 특정 사용자의 멤버십 상태를 확인하는 데 사용할 수 있는 채널 ID의 쉼표로 구분된 목록을 지정합니다. 예를 들면 UC_1,UC_2,UC_3 입니다. 호출당 최대 100개의 채널을 지정할 수 있습니다. |
요청 본문
이 메소드를 호출할 때 요청 본문을 제공하지 마세요.
응답
요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.
{ "kind": "youtube#memberListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ member Resource ] }
속성
다음 표는 이 리소스에 표시되는 속성을 정의합니다.
속성 | |
---|---|
kind |
string API 리소스 유형을 식별합니다. 값은 youtube#memberListResponse 입니다. |
etag |
etag 이 리소스의 Etag입니다. |
nextPageToken |
string pageToken 매개변수의 값으로 사용하여 결과 집합의 다음 페이지를 검색할 수 있는 토큰입니다. 페이지 토큰은 만료될 수 있으며 애플리케이션에서 토큰을 삭제하고 pageToken 없이 API를 호출하여 새 요청을 시작해야 합니다. |
pageInfo |
object pageInfo 객체는 결과 집합의 페이지 정보를 요약합니다. |
pageInfo.totalResults |
integer 결과 집합의 총 결과 수입니다. |
pageInfo.resultsPerPage |
integer API 응답에 포함된 결과 수입니다. |
items[] |
list 요청 기준과 일치하는 구성원의 목록입니다. |
오류
다음 표에서는 이 메서드에 대한 호출에 대한 응답으로 API가 반환할 수 있는 오류 메시지를 확인합니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.
오류 유형 | 오류 세부정보 | 설명 |
---|---|---|
badRequest (400) |
channelMembershipsNotEnabled |
요청을 승인하는 크리에이터 채널에 채널 멤버십이 사용 설정되지 않았습니다. |
badRequest (400) |
invalidMode |
mode 매개변수 값이 잘못되었습니다.
이 오류는 pageToken 매개변수가 지정된 모드가 아닌 다른 모드를 사용하여 가져온 토큰을 지정하는 경우에 발생할 수 있습니다. |
badRequest (400) |
invalidPageToken |
pageToken 매개변수 값이 잘못되었습니다. 이 오류는 요청에 사용된 페이지 토큰이 만료되거나 인식되지 않는 경우에 발생할 수 있습니다. |
badRequest (400) |
invalidHasAccessToLevel |
hasAccessToLevel 매개변수 값이 잘못되었습니다. 지정된 id 가 있는 레벨이 없습니다. |
badRequest (400) |
invalidFilterByMemberChannelId |
filterByMemberChannelId 매개변수 값이 잘못되었습니다. 이 오류는 filterByMemberChannelId 매개변수 값이 100개를 초과하는 채널을 지정하는 경우에 발생합니다. |