Videos: list

API 요청 매개변수와 일치하는 동영상의 목록을 반환합니다.

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

일반적인 사용 사례

요청

HTTP 요청

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

매개변수

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

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

매개변수가 하위 속성을 포함하는 속성을 식별하는 경우 하위 속성이 응답에 포함됩니다. 예를 들어 video 리소스에서 snippet 속성은 channelId, title, description, tags, categoryId 속성을 포함합니다. 따라서 part=snippet을 설정하면 API 응답에 이러한 모든 속성이 포함됩니다.

다음 목록에는 매개변수 값에 포함할 수 있는 part 이름이 포함되어 있습니다.
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
필터 (다음 매개변수 중 하나를 정확히 지정)
chart string
chart 매개변수는 가져오려는 차트를 식별합니다.

사용 가능한 값은 다음과 같습니다.
id string
id 매개변수는 가져오려는 리소스의 YouTube 동영상 ID 목록(쉼표로 구분)을 지정합니다. video 리소스에서 id 속성은 동영상의 ID를 지정합니다.
myRating string

이 매개변수는 적절히 승인된 요청에서만 사용할 수 있습니다. 이 매개변수의 값을 like 또는 dislike로 설정하여 인증된 사용자가 좋아요 또는 싫어요 표시한 동영상만 반환하도록 API에 지시합니다.



API는 반환된 결과 집합을 최대 1,000개의 동영상으로 제한합니다. 응답의 pageInfo.totalResults 속성이 더 높은 총계를 나타내더라도 pageToken 매개변수를 사용한 페이지로 나누기를 사용하면 가장 최근의 1, 000개 항목만 가져올 수 있습니다.



매개변수는 다음 값을 허용합니다.

  • dislike – 인증된 사용자가 싫어요 표시한 동영상만 반환합니다.
  • like – 인증된 사용자가 좋아요 표시한 동영상만 반환합니다.
선택적 매개변수
hl string
hl 매개변수는 YouTube 웹사이트에서 지원하는 특정 애플리케이션 언어의 현지화된 리소스 메타데이터를 가져오도록 API에 지시합니다. 매개변수 값은 i18nLanguages.list 메서드에서 반환된 목록에 포함된 언어 코드여야 합니다.

해당 언어로 현지화된 리소스 세부정보를 사용할 수 있는 경우 리소스의 snippet.localized 객체에 현지화된 값이 포함됩니다. 하지만 현지화된 세부정보를 사용할 수 없는 경우 snippet.localized 객체에 리소스의 기본 언어로 된 리소스 세부정보가 포함됩니다.
maxHeight unsigned integer
maxHeight 매개변수는 player.embedHtml 속성에서 반환되는 삽입된 플레이어의 최대 높이를 지정합니다. 이 매개변수를 사용하여 기본 크기 대신 삽입 코드가 애플리케이션 레이아웃에 적합한 높이를 사용하도록 지정할 수 있습니다. maxWidth 매개변수도 제공되는 경우 최대 너비를 위반하지 않도록 플레이어가 maxHeight보다 짧을 수 있습니다. 사용 가능한 값은 72~8192(포함)입니다.
maxResults unsigned integer
maxResults 매개변수는 결과 집합에서 반환되어야 하는 최대 항목 수를 지정합니다.

참고: 이 매개변수는 myRating 매개변수와 함께 사용하도록 지원되지만 id 매개변수와 함께 사용하도록 지원되지는 않습니다. 사용 가능한 값은 1~50(포함)입니다. 기본값은 5입니다.
maxWidth unsigned integer
maxWidth 매개변수는 player.embedHtml 속성에서 반환되는 삽입된 플레이어의 최대 너비를 지정합니다. 이 매개변수를 사용하여 기본 크기 대신 삽입 코드가 애플리케이션 레이아웃에 적합한 너비를 사용하도록 지정할 수 있습니다.

maxHeight 매개변수도 제공되는 경우 최대 높이를 위반하지 않도록 플레이어가 maxWidth보다 좁을 수 있습니다. 사용 가능한 값은 72~8192(포함)입니다.
onBehalfOfContentOwner string
이 매개변수는 적절히 승인된 요청에서만 사용할 수 있습니다. 참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다.

onBehalfOfContentOwner 매개변수는 요청의 승인 사용자 인증 정보가 매개변수 값에 지정된 콘텐츠 소유자를 대신하여 행동하는 YouTube CMS 사용자를 식별함을 나타냅니다. 이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위한 것입니다. 콘텐츠 소유자는 각 채널에 대한 사용자 인증 정보를 제공하지 않고도 한 번 인증하여 모든 동영상 및 채널 데이터에 액세스할 수 있습니다. 사용자가 인증할 CMS 계정은 지정된 YouTube 콘텐츠 소유자에게 연결되어야 합니다.
pageToken string
pageToken 매개변수는 반환되어야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 및 prevPageToken 속성은 가져올 수 있는 다른 페이지를 식별합니다.

참고: 이 매개변수는 myRating 매개변수와 함께 사용하도록 지원되지만 id 매개변수와 함께 사용하도록 지원되지는 않습니다.
regionCode string
regionCode 매개변수는 지정된 지역에서 사용할 수 있는 동영상 차트를 선택하도록 API에 지시합니다. 이 매개변수는 chart 매개변수와 함께만 사용할 수 있습니다. 파라미터 값은 ISO 3166-1 alpha-2 국가 코드입니다.
videoCategoryId string
videoCategoryId 매개변수는 차트를 가져와야 하는 동영상 카테고리를 식별합니다. 이 매개변수는 chart 매개변수와 함께만 사용할 수 있습니다. 기본적으로 차트는 특정 카테고리로 제한되지 않습니다. 기본값은 0입니다.

요청 본문

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

응답

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

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

속성

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

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

오류

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

오류 유형 오류 세부정보 설명
badRequest (400) videoChartNotFound 요청한 동영상 차트가 지원되지 않거나 동영상 차트를 사용할 수 없습니다.
forbidden (403) forbidden 동영상 파일 또는 처리 정보에 액세스할 수 있도록 요청이 적절히 승인되지 않았습니다. fileDetails, processingDetails, suggestions 부분은 해당 동영상의 소유자만 사용할 수 있습니다.
forbidden (403) forbidden 요청이 사용자 평가 정보에 액세스할 수 없습니다. 이 오류는 myRating 매개변수를 사용할 수 있도록 요청이 적절히 승인되지 않았기 때문에 발생할 수 있습니다.
notFound (404) videoNotFound 가져오려는 동영상을 찾을 수 없습니다. 요청의 id 매개변수 값이 올바른지 확인하세요.

기능을 사용해 보세요.

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