Method: assetSearch.list

저작물 메타데이터를 기준으로 저작물을 검색합니다. 전체 저작물을 검색하거나 콘텐츠 소유자가 소유한 저작물만 검색할 수 있습니다. 이 메소드는 CMS의 저작물 페이지에 있는 고급 검색 기능을 모방한 것입니다.

HTTP 요청

GET https://youtubepartner.googleapis.com/youtube/partner/v1/assetSearch

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
createdAfter

string

createdAfter 매개변수는 반환된 애셋 집합을 지정된 날짜/시간 이후에 생성된 애셋으로 제한합니다. 예를 들면 2015-01-29T23:00:00Z입니다.

createdBefore

string

createdBefore 매개변수는 반환된 애셋 집합을 지정된 날짜/시간 이전에 생성된 애셋으로 제한합니다. 예를 들면 2015-01-29T23:00:00Z입니다.

hasConflicts

boolean

hasConflicts 매개변수를 사용하면 소유권 분쟁이 있는 저작물만 검색할 수 있습니다. 유일한 유효한 값은 true입니다. 매개변수 값을 false로 설정해도 결과는 영향을 받지 않습니다.

includeAnyProvidedlabel

boolean

includeAnyProvidedlabel 매개변수가 true로 설정된 경우 제공된 라벨 중 하나라도 포함된 저작물을 검색합니다. 그렇지 않으면 제공된 라벨이 모두 포함된 저작물을 검색합니다.

isrcs

string

ISRC가 50개까지 쉼표로 구분된 목록입니다. 이 매개변수에 값을 지정하면 API 서버는 q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort, type 매개변수에 설정된 모든 값을 무시합니다.

labels

string

labels 매개변수는 검색하려는 특정 저작물 라벨이 있는 저작물을 지정합니다. 매개변수 값은 쉼표로 구분된 저작물 라벨 목록입니다.

metadataSearchFields

string

metadataSearchField 매개변수는 검색할 메타데이터 필드를 지정합니다. 메타데이터 필드와 콜론(:)으로 연결된 값 쌍을 쉼표로 구분한 목록입니다. 예: customId:my_custom_id,artist:Dandexx

onBehalfOfContentOwner

string

onBehalfOfContentOwner 매개변수는 사용자가 대리하는 콘텐츠 소유자를 식별합니다. 이 매개변수는 계정이 여러 콘텐츠 소유자와 연결된 사용자를 지원합니다.

ownershipRestriction

enum (OwnershipRestriction)

ownershipRestriction 매개변수는 검색의 소유권 필터링 옵션을 지정합니다. 기본적으로 현재 인증된 사용자가 소유한 저작물에서만 검색이 수행됩니다.

pageToken

string

pageToken 매개변수는 반환할 특정 결과 페이지를 식별하는 토큰을 지정합니다. 이 매개변수를 이전 API 응답의 nextPageToken 값 값으로 설정하여 검색결과의 다음 페이지를 검색합니다.

q

string

YouTube는 id, type, customId 필드 내에서 모든 저작물을 비롯하여 저작물 유형(영화, 뮤직비디오 등)에 따라 달라지는 여러 기타 메타데이터 필드(예: actor, album, director, isrc, tmsId)를 검색합니다.

sort

enum (Sort)

sort 매개변수는 검색 결과가 정렬되는 방식을 지정합니다. 결과는 항상 내림차순으로 정렬됩니다.

type

string

type 매개변수는 검색하려는 애셋의 유형을 지정합니다. 매개변수 값은 쉼표로 구분된 애셋 유형 목록입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

이 응답은 검색어와 일치하는 YouTube 저작물 목록을 보여줍니다. 목록의 각 항목에는 저작물의 메타데이터가 포함됩니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "kind": string,
  "pageInfo": {
    object (PageInfo)
  },
  "items": [
    {
      object (AssetSnippet)
    }
  ],
  "nextPageToken": string
}
필드
kind

string

API 응답 유형입니다. 이 작업에서 값은 youtubePartner#assetSnippetList입니다.

pageInfo

object (PageInfo)

pageInfo 객체는 결과 집합의 페이징 정보를 캡슐화합니다.

items[]

object (AssetSnippet)

요청 기준과 일치하는 애셋 리소스의 목록입니다.

nextPageToken

string

pageToken 매개변수의 값으로 사용하여 다음 결과 페이지를 검색할 수 있는 토큰입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/youtubepartner

자세한 내용은 OAuth 2.0 개요를 참고하세요.

OwnershipRestriction

소유권 제한의 열거형입니다.

열거형
OWNERSHIP_RESTRICTION_UNSPECIFIED 기본값
MINE 현재 사용자가 소유한 애셋 중 검색어와 일치하는 애셋을 찾습니다. 이것이 기본 동작입니다.
NONE 소유자와 관계없이 검색어와 일치하는 모든 애셋을 찾습니다.

정렬

애셋 검색 목록 요청에서 지원되는 정렬 순서의 열거형입니다.

열거형
SORT_UNSPECIFIED 기본값
CLAIMS 각 저작물의 소유권 주장 수를 기준으로 정렬합니다.
TIME 각 애셋의 수정 시간을 기준으로 정렬합니다. 기본값입니다.
VIEWS 각 저작물의 대략적인 일일 조회수를 기준으로 정렬합니다.