Search: list

API 요청에 지정된 쿼리 매개변수와 일치하는 검색결과 컬렉션을 반환합니다. 기본적으로 검색결과 집합은 일치하는 video, channel, playlist 리소스를 식별하지만, 쿼리를 구성하여 특정 유형의 리소스만 검색할 수도 있습니다.

할당량 영향: 이 메서드를 호출하면 할당량 비용이 100단위가 됩니다.

일반적인 사용 사례

요청

HTTP 요청

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

매개변수

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

매개변수
필수 매개변수
part string
part 매개변수는 API 응답이 포함하는 search 리소스 속성 하나 이상의 쉼표로 구분된 목록을 지정합니다. 매개변수 값을 snippet로 설정합니다.
필터(다음 매개변수 중 0개 또는 1개 지정)
forContentOwner boolean
이 매개변수는 제대로 승인된 요청에서만 사용할 수 있으며 YouTube 콘텐츠 파트너 전용입니다.

forContentOwner 매개변수는 onBehalfOfContentOwner 매개변수로 식별된 콘텐츠 소유자가 소유한 동영상만 검색하도록 검색을 제한합니다. forContentOwner가 true로 설정된 경우 요청이 다음 요구사항을 충족해야 합니다.
  • onBehalfOfContentOwner 매개변수는 필수 항목입니다.
  • 요청을 승인하는 사용자는 지정된 콘텐츠 소유자와 연결된 계정을 사용해야 합니다.
  • type 매개변수 값을 video로 설정해야 합니다.
  • 다른 매개변수(videoDefinition, videoDimension, videoDuration, videoEmbeddable, videoLicense, videoPaidProductPlacement, videoSyndicated, videoType)는 설정할 수 없습니다.
forDeveloper boolean
이 매개변수는 제대로 승인된 요청에서만 사용할 수 있습니다. forDeveloper 매개변수는 검색을 개발자의 애플리케이션 또는 웹사이트를 통해 업로드된 동영상만 검색하도록 제한합니다. API 서버는 요청의 승인 사용자 인증 정보를 사용하여 개발자를 식별합니다. forDeveloper 매개변수는 q 매개변수와 같은 선택적 검색 매개변수와 함께 사용할 수 있습니다.

이 기능을 사용하기 위해 업로드된 각 동영상에는 Google Developers Console에서 개발자의 애플리케이션과 연결된 프로젝트 번호가 자동으로 태그됩니다.

이후 검색 요청에서 forDeveloper 매개변수를 true로 설정하면 API 서버가 요청의 승인 사용자 인증 정보를 사용하여 개발자를 식별합니다. 따라서 개발자는 자신의 앱 또는 웹사이트를 통해 업로드된 동영상으로 결과를 제한할 수 있지만 다른 앱이나 사이트를 통해 업로드된 동영상으로는 제한할 수 없습니다.
forMine boolean
이 매개변수는 제대로 승인된 요청에서만 사용할 수 있습니다. forMine 매개변수는 인증된 사용자가 소유한 동영상만 검색하도록 검색을 제한합니다. 이 매개변수를 true로 설정하면 type 매개변수의 값도 video로 설정해야 합니다. 같은 요청에는 videoDefinition, videoDimension, videoDuration, videoEmbeddable, videoLicense, videoPaidProductPlacement, videoSyndicated, videoType 등 다른 매개변수를 설정할 수 없습니다.
선택적 매개변수
channelId string
channelId 매개변수는 API 응답에 채널에서 만든 리소스만 포함해야 함을 나타냅니다.

참고: 요청이 channelId 매개변수의 값을 지정하고 type 매개변수 값을 video로 설정하지만 forContentOwner, forDeveloper 또는 forMine 필터 중 하나를 설정하지 않는 경우 검색결과는 최대 500개의 동영상으로 제한됩니다.
channelType string
channelType 매개변수를 사용하면 검색을 특정 유형의 채널로 제한할 수 있습니다.

허용되는 값은 다음과 같습니다.
  • any – 모든 채널을 반환합니다.
  • show - 프로그램만 검색
eventType string
eventType 매개변수는 방송 이벤트로 검색을 제한합니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • completed - 완료된 브로드캐스트만 포함합니다.
  • live – 활성 브로드캐스트만 포함합니다.
  • upcoming - 예정된 방송만 포함합니다.
location string
location 매개변수는 locationRadius 매개변수와 함께 사용되어 순환 지역을 정의하며, 메타데이터에서 이 지역 내에 속하는 지리적 위치를 지정하는 검색으로도 제한됩니다. 매개변수 값은 위도/경도 좌표를 지정하는 문자열입니다(예: 37.42307,-122.08427).

  • location 매개변수 값은 영역의 중심에 있는 점을 식별합니다.
  • locationRadius 매개변수는 동영상이 검색결과에 계속 포함되도록 하기 위해 동영상에 연결된 위치가 해당 지점으로부터의 최대 거리를 지정합니다.
요청에서 location 매개변수의 값을 지정하지만 locationRadius 매개변수의 값도 지정하지 않은 경우 API는 오류를 반환합니다.

참고: 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.
locationRadius string
locationRadius 매개변수는 location 매개변수와 함께 원형의 지리적 영역을 정의합니다.

매개변수 값은 부동 소수점 수 뒤에 측정 단위가 와야 합니다. 유효한 측정 단위는 m, km, ft, mi입니다. 예를 들어 유효한 매개변수 값에는 1500m, 5km, 10000ft, 0.75mi이 포함됩니다. API는 1,000km보다 큰 locationRadius 매개변수 값을 지원하지 않습니다.

참고: 자세한 내용은 location 매개변수의 정의를 참조하세요.
maxResults unsigned integer
maxResults 매개변수는 결과 집합에 반환해야 하는 최대 항목 수를 지정합니다. 사용 가능한 값: 0~50 기본값은 5입니다.
onBehalfOfContentOwner string
이 매개변수는 제대로 승인된 요청에서만 사용할 수 있습니다. 참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다.

onBehalfOfContentOwner 매개변수는 요청의 승인 사용자 인증 정보가 매개변수 값에 지정된 콘텐츠 소유자를 대신하는 YouTube CMS 사용자를 식별함을 나타냅니다. 이 매개변수는 다양한 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위한 것입니다. 이를 통해 콘텐츠 소유자는 각 채널에 사용자 인증 정보를 제공하지 않고도 한 번만 인증하면 모든 동영상 및 채널 데이터에 액세스할 수 있습니다. 사용자가 인증할 CMS 계정은 지정된 YouTube 콘텐츠 소유자에게 연결되어야 합니다.
order string
order 매개변수는 API 응답에서 리소스를 정렬하는 데 사용할 메서드를 지정합니다. 기본값은 relevance입니다.

허용되는 값은 다음과 같습니다.
  • date – 리소스를 만든 날짜를 기준으로 최근 항목부터 시간 순서대로 리소스를 정렬합니다.
  • rating – 높은 평가부터 낮은 평가순으로 리소스를 정렬합니다.
  • relevance – 검색어와의 관련성을 기준으로 리소스를 정렬합니다. 이 매개변수의 기본값입니다.
  • title – 리소스가 제목순으로 알파벳순으로 정렬됩니다.
  • videoCount – 채널은 업로드한 동영상 수를 기준으로 내림차순으로 정렬됩니다.
  • viewCount – 리소스가 조회수가 높은 순으로 정렬됩니다. 실시간 방송의 경우 방송이 진행되는 동안 동시 시청자 수를 기준으로 동영상을 정렬합니다.
pageToken string
pageToken 매개변수는 결과 집합에서 반환해야 하는 특정 페이지를 식별합니다. API 응답에서 nextPageTokenprevPageToken 속성은 검색할 수 있는 다른 페이지를 식별합니다.
publishedAfter datetime
publishedAfter 매개변수는 API 응답이 지정된 시간 또는 그 이후에 생성된 리소스만 포함해야 함을 나타냅니다. 값은 RFC 3339 형식이 지정된 날짜-시간 값(1970-01-01T00:00:00Z)입니다.
publishedBefore datetime
publishedBefore 매개변수는 API 응답이 지정된 시간 또는 그 이전에 생성된 리소스만 포함해야 함을 나타냅니다. 값은 RFC 3339 형식이 지정된 날짜-시간 값(1970-01-01T00:00:00Z)입니다.
q string
q 매개변수는 검색할 검색어를 지정합니다.

또한 부울 부울 (-) 및 OR (|) 연산자를 사용하여 동영상을 제외하거나 여러 검색어 중 하나와 연결된 동영상을 찾을 수 있습니다. 예를 들어 '보트' 또는 '세일링'과 일치하는 동영상을 검색하려면 q 매개변수 값을 boating|sailing로 설정합니다. 마찬가지로 '보트' 또는 '세일링'과 일치하지만 '낚시'와는 일치하지 않는 동영상을 검색하려면 q 매개변수 값을 boating|sailing -fishing로 설정합니다. 파이프 문자는 API 요청에서 전송될 때 URL 이스케이프 처리되어야 합니다. 파이프 문자의 URL 이스케이프 값은 %7C입니다.
regionCode string
regionCode 매개변수는 지정된 국가에서 볼 수 있는 동영상의 검색결과를 반환하도록 API에 지시합니다. 매개변수 값은 ISO 3166-1 alpha-2 국가 코드입니다.
relevanceLanguage string
relevanceLanguage 매개변수는 지정된 언어와 가장 관련성이 높은 검색결과를 반환하도록 API에 지시합니다. 매개변수 값은 일반적으로 두 자리 ISO 639-1 언어 코드입니다. 하지만 중국어 간체에는 zh-Hans 값을, 중국어 번체에는 zh-Hant 값을 사용해야 합니다. 다른 언어로 된 검색결과는 검색어와 관련성이 높은 경우에도 계속 표시됩니다.
safeSearch string
safeSearch 매개변수는 검색결과에 제한된 콘텐츠와 표준 콘텐츠가 포함되어야 하는지 여부를 나타냅니다.

허용되는 값은 다음과 같습니다.
  • moderate – YouTube는 검색결과에서 일부 콘텐츠를 필터링하며 최소한 지정된 로케일에서 제한된 콘텐츠는 필터링합니다. 콘텐츠를 기준으로 검색결과에서 검색결과를 제거할 수도 있고 순위를 내릴 수도 있습니다. 기본 매개변수 값입니다.
  • none – YouTube는 검색결과 집합을 필터링하지 않습니다.
  • strict – YouTube는 검색결과 집합에서 제한된 콘텐츠를 모두 제외합니다. 콘텐츠를 기준으로 검색결과에서 검색결과를 제거할 수도 있고 순위를 내릴 수도 있습니다.
topicId string
topicId 매개변수는 API 응답에 지정된 주제와 관련된 리소스만 포함되어야 함을 나타냅니다. 이 값은 Freebase 주제 ID를 식별합니다.

중요: Freebase 및 Freebase API에 대한 지원 중단으로 인해 2017년 2월 27일부터 topicId 매개변수가 다르게 작동하기 시작했습니다. 그 당시 YouTube는 선별된 주제 ID 모음을 지원하기 시작했으며 개발자는 이 ID 값을 이 매개변수의 값으로만 사용할 수 있습니다.

type string
type 매개변수는 특정 유형의 리소스만 검색하도록 검색어를 제한합니다. 값은 쉼표로 구분된 리소스 유형 목록입니다. 기본값은 video,channel,playlist입니다.

허용되는 값은 다음과 같습니다.
  • channel
  • playlist
  • video
videoCaption string
videoCaption 매개변수는 자막이 있는지에 따라 API가 동영상 검색결과를 필터링해야 하는지 여부를 나타냅니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any - 자막 제공 여부에 따라 결과를 필터링하지 않습니다.
  • closedCaption - 자막이 있는 동영상만 포함합니다.
  • none - 자막이 없는 동영상만 포함합니다.
videoCategoryId string
videoCategoryId 매개변수는 카테고리를 기준으로 동영상 검색결과를 필터링합니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.
videoDefinition string
videoDefinition 매개변수를 사용하면 고화질 (HD) 또는 표준 화질 (SD) 동영상만 포함하도록 검색을 제한할 수 있습니다. HD 동영상은 최소 720p로 재생할 수 있고 1080p 같은 고해상도도 사용할 수 있습니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 해상도에 관계없이 모든 동영상을 반환합니다.
  • high - HD 동영상만 검색합니다.
  • standard – 표준 화질 동영상만 검색합니다.
videoDimension string
videoDimension 매개변수를 사용하면 2D 또는 3D 동영상만 검색하도록 검색을 제한할 수 있습니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • 2d – 3D 동영상을 제외하도록 검색결과를 제한합니다.
  • 3d – 3D 동영상만 포함하도록 검색결과를 제한합니다.
  • any – 3D와 3D가 아닌 동영상을 모두 검색결과에 포함합니다. 기본값입니다.
videoDuration string
videoDuration 매개변수는 동영상 길이를 기준으로 동영상 검색결과를 필터링합니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 동영상 길이를 기준으로 동영상 검색결과를 필터링하지 않습니다. 기본값입니다.
  • long – 20분보다 긴 동영상만 포함합니다.
  • medium – 4분에서 20분 사이의 동영상만 포함합니다.
  • short – 4분 미만의 동영상만 포함합니다.
videoEmbeddable string
videoEmbeddable 매개변수를 사용하면 웹페이지에 삽입할 수 있는 동영상으로만 검색을 제한할 수 있습니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 삽입 여부와 관계없이 모든 동영상을 반환합니다.
  • true – 퍼갈 수 있는 동영상만 검색합니다.
videoLicense string
videoLicense 매개변수는 특정 라이선스가 있는 동영상만 포함하도록 검색결과를 필터링합니다. YouTube에서는 동영상 업로더가 각 동영상에 Creative Commons 라이선스 또는 표준 YouTube 라이선스를 첨부하도록 선택할 수 있습니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 라이선스에 관계없이 쿼리 매개변수와 일치하는 모든 동영상을 반환합니다.
  • creativeCommon – 크리에이티브 커먼즈 라이선스가 있는 동영상만 반환합니다. 사용자는 자신이 만든 다른 동영상에서 이 라이선스가 있는 동영상을 재사용할 수 있습니다. 자세히 알아보기
  • youtube – 표준 YouTube 라이선스가 있는 동영상만 반환합니다.
videoPaidProductPlacement string
videoPaidProductPlacement 매개변수는 크리에이터가 유료 프로모션이 있다고 표시한 동영상만 포함하도록 검색결과를 필터링합니다. 이 매개변수의 값을 지정하는 경우 type 매개변수 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 동영상에 유료 프로모션이 포함되어 있는지 여부와 관계없이 모든 동영상이 반환됩니다.
  • true – 유료 프로모션이 있는 동영상만 검색합니다.
videoSyndicated string
videoSyndicated 매개변수를 사용하면 youtube.com 외부에서 재생할 수 있는 동영상으로만 검색을 제한할 수 있습니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 배급 여부에 관계 없이 모든 동영상을 반환합니다.
  • true – 배급된 동영상만 검색합니다.
videoType string
videoType 매개변수를 사용하면 검색을 특정 유형의 동영상으로 제한할 수 있습니다. 이 매개변수의 값을 지정하는 경우 type 매개변수의 값도 video로 설정해야 합니다.

허용되는 값은 다음과 같습니다.
  • any – 모든 동영상을 반환합니다.
  • episode - 프로그램의 에피소드만 검색합니다.
  • movie - 영화만 검색합니다.

요청 본문

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

응답

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

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

속성

다음 표는 검색결과에 표시되는 속성을 정의합니다.

속성
kind string
API 리소스의 유형을 식별합니다. 값은 youtube#searchListResponse입니다.
etag etag
이 리소스의 Etag입니다.
nextPageToken string
결과 집합의 다음 페이지를 검색하는 pageToken 매개변수의 값으로 사용할 수 있는 토큰입니다.
prevPageToken string
결과 집합에서 이전 페이지를 검색하는 pageToken 매개변수의 값으로 사용할 수 있는 토큰입니다.
regionCode string
검색어에 사용된 지역 코드입니다. 속성 값은 지역을 식별하는 2자리 ISO 국가 코드입니다. i18nRegions.list 메서드는 지원되는 리전 목록을 반환합니다. 기본값은 US입니다. 지원되지 않는 지역이 지정된 경우에도 YouTube에서 쿼리를 처리하기 위해 기본값이 아닌 다른 지역을 선택할 수 있습니다.
pageInfo object
pageInfo 객체는 결과 집합의 페이징 정보를 캡슐화합니다.
pageInfo.totalResults integer
결과 집합의 총 결과 수입니다.이 값은 근사치이며 정확한 값을 나타내지는 않을 수 있습니다. 또한 최댓값은 1,000,000입니다.

이 값을 페이지로 나누기 링크를 만들면 안 됩니다. 대신 nextPageTokenprevPageToken 속성 값을 사용하여 페이지로 나누기 링크를 표시할지 결정합니다.
pageInfo.resultsPerPage integer
API 응답에 포함된 결과 수입니다.
items[] list
검색 기준과 일치하는 결과 목록입니다.

예시

참고: 다음 코드 샘플은 지원되는 모든 프로그래밍 언어를 나타내지는 않습니다. 지원되는 언어 목록은 클라이언트 라이브러리 문서를 참고하세요.

Apps Script

이 함수는 '개'라는 키워드와 관련된 동영상을 검색합니다. 검색결과의 동영상 ID와 제목이 Apps Script 로그에 기록됩니다.

이 샘플에서는 결과를 25개로 제한합니다. 더 많은 결과를 반환하려면 다음 페이지에 설명된 대로 추가 매개변수를 전달하세요. https://developers.google.com/youtube/v3/docs/search/list
function searchByKeyword() {
  var results = YouTube.Search.list('id,snippet', {q: 'dogs', maxResults: 25});

  for(var i in results.items) {
    var item = results.items[i];
    Logger.log('[%s] Title: %s', item.id.videoId, item.snippet.title);
  }
}

Go

이 코드 샘플은 API의 search.list 메서드를 호출하여 특정 키워드와 연결된 검색결과를 검색합니다.

이 예시에서는 Go 클라이언트 라이브러리를 사용합니다.

package main

import (
	"flag"
	"fmt"
	"log"
	"net/http"

	"google.golang.org/api/googleapi/transport"
	"google.golang.org/api/youtube/v3"
)

var (
	query      = flag.String("query", "Google", "Search term")
	maxResults = flag.Int64("max-results", 25, "Max YouTube results")
)

const developerKey = "YOUR DEVELOPER KEY"

func main() {
	flag.Parse()

	client := &http.Client{
		Transport: &transport.APIKey{Key: developerKey},
	}

	service, err := youtube.New(client)
	if err != nil {
		log.Fatalf("Error creating new YouTube client: %v", err)
	}

	// Make the API call to YouTube.
	call := service.Search.List("id,snippet").
		Q(*query).
		MaxResults(*maxResults)
	response, err := call.Do()
	handleError(err, "")

	// Group video, channel, and playlist results in separate lists.
	videos := make(map[string]string)
	channels := make(map[string]string)
	playlists := make(map[string]string)

	// Iterate through each item and add it to the correct list.
	for _, item := range response.Items {
		switch item.Id.Kind {
		case "youtube#video":
			videos[item.Id.VideoId] = item.Snippet.Title
		case "youtube#channel":
			channels[item.Id.ChannelId] = item.Snippet.Title
		case "youtube#playlist":
			playlists[item.Id.PlaylistId] = item.Snippet.Title
		}
	}

	printIDs("Videos", videos)
	printIDs("Channels", channels)
	printIDs("Playlists", playlists)
}

// Print the ID and title of each result in a list as well as a name that
// identifies the list. For example, print the word section name "Videos"
// above a list of video search results, followed by the video ID and title
// of each matching video.
func printIDs(sectionName string, matches map[string]string) {
	fmt.Printf("%v:\n", sectionName)
	for id, title := range matches {
		fmt.Printf("[%v] %v\n", id, title)
	}
	fmt.Printf("\n\n")
}

.NET

다음 코드 샘플은 API의 search.list 메서드를 호출하여 특정 키워드와 연결된 검색결과를 검색합니다.

.NET 클라이언트 라이브러리를 사용하는 예입니다.

using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;

using Google.Apis.Auth.OAuth2;
using Google.Apis.Services;
using Google.Apis.Upload;
using Google.Apis.Util.Store;
using Google.Apis.YouTube.v3;
using Google.Apis.YouTube.v3.Data;

namespace Google.Apis.YouTube.Samples
{
  /// <summary>
  /// YouTube Data API v3 sample: search by keyword.
  /// Relies on the Google APIs Client Library for .NET, v1.7.0 or higher.
  /// See https://developers.google.com/api-client-library/dotnet/get_started
  ///
  /// Set ApiKey to the API key value from the APIs & auth > Registered apps tab of
  ///   https://cloud.google.com/console
  /// Please ensure that you have enabled the YouTube Data API for your project.
  /// </summary>
  internal class Search
  {
    [STAThread]
    static void Main(string[] args)
    {
      Console.WriteLine("YouTube Data API: Search");
      Console.WriteLine("========================");

      try
      {
        new Search().Run().Wait();
      }
      catch (AggregateException ex)
      {
        foreach (var e in ex.InnerExceptions)
        {
          Console.WriteLine("Error: " + e.Message);
        }
      }

      Console.WriteLine("Press any key to continue...");
      Console.ReadKey();
    }

    private async Task Run()
    {
      var youtubeService = new YouTubeService(new BaseClientService.Initializer()
      {
        ApiKey = "REPLACE_ME",
        ApplicationName = this.GetType().ToString()
      });

      var searchListRequest = youtubeService.Search.List("snippet");
      searchListRequest.Q = "Google"; // Replace with your search term.
      searchListRequest.MaxResults = 50;

      // Call the search.list method to retrieve results matching the specified query term.
      var searchListResponse = await searchListRequest.ExecuteAsync();

      List<string> videos = new List<string>();
      List<string> channels = new List<string>();
      List<string> playlists = new List<string>();

      // Add each result to the appropriate list, and then display the lists of
      // matching videos, channels, and playlists.
      foreach (var searchResult in searchListResponse.Items)
      {
        switch (searchResult.Id.Kind)
        {
          case "youtube#video":
            videos.Add(String.Format("{0} ({1})", searchResult.Snippet.Title, searchResult.Id.VideoId));
            break;

          case "youtube#channel":
            channels.Add(String.Format("{0} ({1})", searchResult.Snippet.Title, searchResult.Id.ChannelId));
            break;

          case "youtube#playlist":
            playlists.Add(String.Format("{0} ({1})", searchResult.Snippet.Title, searchResult.Id.PlaylistId));
            break;
        }
      }

      Console.WriteLine(String.Format("Videos:\n{0}\n", string.Join("\n", videos)));
      Console.WriteLine(String.Format("Channels:\n{0}\n", string.Join("\n", channels)));
      Console.WriteLine(String.Format("Playlists:\n{0}\n", string.Join("\n", playlists)));
    }
  }
}

Ruby

이 샘플은 API의 search.list 메서드를 호출하여 특정 키워드와 연결된 검색결과를 검색합니다.

Ruby 클라이언트 라이브러리를 사용하는 예입니다.

#!/usr/bin/ruby

require 'rubygems'
gem 'google-api-client', '>0.7'
require 'google/api_client'
require 'trollop'

# Set DEVELOPER_KEY to the API key value from the APIs & auth > Credentials
# tab of
# {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
# Please ensure that you have enabled the YouTube Data API for your project.
DEVELOPER_KEY = 'REPLACE_ME'
YOUTUBE_API_SERVICE_NAME = 'youtube'
YOUTUBE_API_VERSION = 'v3'

def get_service
  client = Google::APIClient.new(
    :key => DEVELOPER_KEY,
    :authorization => nil,
    :application_name => $PROGRAM_NAME,
    :application_version => '1.0.0'
  )
  youtube = client.discovered_api(YOUTUBE_API_SERVICE_NAME, YOUTUBE_API_VERSION)

  return client, youtube
end

def main
  opts = Trollop::options do
    opt :q, 'Search term', :type => String, :default => 'Google'
    opt :max_results, 'Max results', :type => :int, :default => 25
  end

  client, youtube = get_service

  begin
    # Call the search.list method to retrieve results matching the specified
    # query term.
    search_response = client.execute!(
      :api_method => youtube.search.list,
      :parameters => {
        :part => 'snippet',
        :q => opts[:q],
        :maxResults => opts[:max_results]
      }
    )

    videos = []
    channels = []
    playlists = []

    # Add each result to the appropriate list, and then display the lists of
    # matching videos, channels, and playlists.
    search_response.data.items.each do |search_result|
      case search_result.id.kind
        when 'youtube#video'
          videos << "#{search_result.snippet.title} (#{search_result.id.videoId})"
        when 'youtube#channel'
          channels << "#{search_result.snippet.title} (#{search_result.id.channelId})"
        when 'youtube#playlist'
          playlists << "#{search_result.snippet.title} (#{search_result.id.playlistId})"
      end
    end

    puts "Videos:\n", videos, "\n"
    puts "Channels:\n", channels, "\n"
    puts "Playlists:\n", playlists, "\n"
  rescue Google::APIClient::TransmissionError => e
    puts e.result.body
  end
end

main

오류

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

오류 유형 오류 세부정보 설명
badRequest (400) invalidChannelId channelId 매개변수가 잘못된 채널 ID를 지정했습니다.
badRequest (400) invalidLocation location 또는 locationRadius 매개변수 값의 형식이 잘못되었습니다.
badRequest (400) invalidRelevanceLanguage relevanceLanguage 매개변수 값의 형식이 잘못되었습니다.
badRequest (400) invalidSearchFilter 요청에 잘못된 조합의 검색 필터 및/또는 제한이 있습니다. forContentOwner 또는 forMine 매개변수를 true로 설정한 경우 type 매개변수를 video로 설정해야 합니다. eventType, videoCaption, videoCategoryId, videoDefinition, videoDimension, videoDuration, videoEmbeddable, videoLicense, videoSyndicated 또는 videoType 매개변수의 값을 설정한 경우 type 매개변수도 video로 설정해야 합니다.

사용해 보기

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