Sponsors: list
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
참고: 이 메서드는 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입니다.
허용되는 값은 다음과 같습니다.
all – 최근 회원부터 오래된 회원까지 모든 스폰서를 반환합니다.newest – 가장 최근 스폰서의 한 페이지를 반환합니다. 이후 nextPageToken를 사용하여 요청하면 새로운 구독자가 가입할 때 새 구독자를 가져옵니다.
|
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가 반환할 수 있는 오류 메시지를 확인합니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.
사용해 보기
APIs Explorer를 사용하여 이 API를 호출하고 API 요청 및 응답을 확인하세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-04-26(UTC)
[null,null,["최종 업데이트: 2024-04-26(UTC)"],[],[],null,["# Sponsors: list\n\nNote: This method is deprecated as of March 31, 2020. It has been replaced by the [members.list](/youtube/v3/docs/members/list) method. You can find information about that method in the YouTube Data API documentation. \n\nThe `sponsors.list` method will no longer be supported on or after September 30, 2020. API clients should update calls to the `sponsors.list` method to use the [members.list](/youtube/v3/docs/members/list) method instead.\n\nLists members (formerly known as \"sponsors\") for a channel. The API request must be authorized\nby the channel owner.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/sponsors\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/live/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtube.readonly` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `sponsor` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `filter` | `string` The **filter** parameter specifies which channel sponsors to return. The default value is `newest`. Acceptable values are: - **all** -- Return all sponsors, from newest to oldest. - **newest** -- Return one page of the most recent sponsors. Subsequent requests using the [nextPageToken](#nextPageToken) retrieve newer subscribers as they sign up. |\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are `0` to `50`, inclusive. The default value is `5`. |\n| `pageToken` | `string` The **pageToken** parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` and `prevPageToken` properties identify other pages that could be retrieved. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#sponsorListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n sponsor resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#sponsorListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of sponsors that match the request criteria. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/live/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|----------------------|-------------------------------------|---------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to view the channel's sponsors. |\n| `invalidValue (400)` | `invalidValueInRequest` | The request contains an invalid value. |\n| `invalidValue (400)` | `sponsorshipNotEnabledForChannelId` | The channel does not have sponsorships enabled. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
