Subscriptions: list

API 요청 기준과 일치하는 구독정보 리소스를 반환합니다.

할당량 영향: 이 메서드를 호출하면 할당량 비용이 1단위 발생합니다.

일반적인 사용 사례

요청

HTTP 요청

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

매개변수

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

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

매개변수가 하위 속성�� 포함하는 속성을 식별하는 경우 하위 속성이 응답에 포함됩니다. 예를 들어 subscription 리소스에서 snippet 속성은 구독의 표시 제목과 같은 다른 속성을 포함합니다. part=snippet을 설정하면 API 응답에 이러한 모든 중첩 속성도 포함됩니다.

다음 목록에는 파라미터 값에 포함할 수 있는 part 이름이 포함되어 있습니다.
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
필터 (다음 매개변수 중 하나를 정확히 지정)
channelId string
channelId 매개변수는 YouTube 채널 ID를 지정합니다. API는 해당 채널의 구독만 반환합니다.
id string
id 매개변수는 검색 중인 리소스의 YouTube 구독 ID의 쉼표로 구분된 목록을 지정합니다. subscription 리소스에서 id 속성은 YouTube 구독 ID를 지정합니다.
mine boolean
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다. 인증된 사용자의 구독 피드를 검색하려면 이 매개변수의 값을 true로 설정합니다.
myRecentSubscribers boolean
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다. 인증된 사용자의 구독자 피드를 역순으로 (최신순) 검색하려면 이 매개변수의 값을 true로 설정합니다. 이 API를 통해 반환되는 최대 구독자 수는 제한될 수 있습니다.
mySubscribers boolean
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다. 인증된 사용자의 구독자 피드를 순서 없이 검색하려면 이 매개변수의 값을 true로 설정합니다. 이 API를 통해 반환되는 최대 구독자 수는 제한될 수 있습니다.
선택적 매개변수
forChannelId string
forChannelId 매개변수는 채널 ID의 쉼표로 구분된 목록을 지정합니다. API 응답은 이러한 채널과 일치하는 구독만 포함하게 됩니다.
maxResults unsigned integer
maxResults 매개변수는 결과 집합에서 반환되어야 하는 최대 항목 수를 지정합니다. 허용되는 값은 0~50입니다(경계값 포함). 기본값은 5입니다.
onBehalfOfContentOwner string
참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다.

onBehalfOfContentOwner 매개변수는 요청의 승인 사용자 인증 정보가 매개변수 값에 지정된 콘텐츠 소유자를 대신하여 행동하는 YouTube CMS 사용자를 식별함을 나타냅니다. 이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위한 것입니다. 콘텐츠 소유자는 한 번 인증하고 각 개별 채널에 사용자 인증 정보를 제공하지 않고도 모든 동영상 및 채널 데이터에 액세스할 수 있습니다. 사용자가 인증할 CMS 계정은 지정된 YouTube 콘텐츠 소유자에게 연결되어야 합니다.
onBehalfOfContentOwnerChannel string
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다. 참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다.

onBehalfOfContentOwnerChannel 매개변수는 동영상이 추가되는 채널의 YouTube 채널 ID를 지정합니다. 이 매개변수는 요청에서 onBehalfOfContentOwner 매개변수의 값을 지정할 때 필요하며 해당 매개변수와 함께만 사용할 수 있습니다. 또한 onBehalfOfContentOwner 매개변수가 지정하는 콘텐츠 소유자에게 연결된 CMS 계정을 사용하여 요청을 승인해야 합니다. 마지막으로 onBehalfOfContentOwnerChannel 매개변수 값이 지정하는 채널은 onBehalfOfContentOwner 매개���수가 지정하는 콘텐츠 소유자에게 연결되어야 합니다.

이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위한 것입니다. 콘텐츠 소유자는 한 번 인증하고 각 개별 채널에 사용자 인증 정보를 제공하지 않고도 파라미터 값에 지정된 채널을 대신하여 작업을 실행할 수 있습니다.
order string
order 매개변수는 API 응답에서 리소스를 정렬하는 데 사용되는 메서드를 지정합니다. 기본값은 SUBSCRIPTION_ORDER_RELEVANCE입니다.

허용되는 값은 다음과 같습니다.
  • alphabetical: 알파벳순으로 정렬합니다.
  • relevance: 관련순으로 정렬합니다.
  • unread – 활동 순서대로 정렬합니다.
pageToken string
pageToken 매개변수는 반환되어야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 및 prevPageToken 속성은 검색할 수 있는 다른 페이지를 식별합니다.

요청 본문

이 메소드를 호출할 때 요청 본문을 제공하지 마세요.

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

속성

다음 표는 이 리소스에 표시되는 속성을 정의합니다.

속성
kind string
API 리소스의 유형을 식별합니다. 값은 youtube#subscriptionListResponse입니다.
etag etag
이 리소스의 ETag입니다.
nextPageToken string
결과 집합의 다음 페이지를 검색하기 위해 pageToken 매개변수의 값으로 사용할 수 있는 토큰입니다.
prevPageToken string
결과 집합의 이전 페이지를 검색하기 위해 pageToken 매개변수의 값으로 사용할 수 있는 토큰입니다.
pageInfo object
pageInfo 객체는 결과 집합의 페이징 정보를 캡슐화합니다.
pageInfo.totalResults integer
결과 집합의 총 결과 수입니다.
pageInfo.resultsPerPage integer
API 응답에 포함된 결과 수입니다.
items[] list
요청 기준과 일치하는 구독 목록입니다.

오류

다음 표에서는 이 메서드 호출에 대한 응답으로 API가 반환할 수 있는 오류 메시지를 식별합니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.

오류 유형 오류 세부정보 설명
forbidden (403) accountClosed 구독자의 계정이 삭제되어 구독정보를 검색할 수 없습니다.
forbidden (403) accountSuspended 구독자의 계정이 일시 중지되어 구독정보를 검색할 수 없습니다.
forbidden (403) subscriptionForbidden 요청한 구독정보에 요청자가 액세스할 수 없습니다.
notFound (404) subscriberNotFound 요청에서 확인된 구독자를 찾을 수 없습니다.

기능을 사용해 보세요.

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