Method: customLists.list

맞춤 목록을 나열합니다.

순서는 orderBy 매개변수로 정의됩니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v1/customLists

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

쿼리 매개변수

매개변수
pageSize

integer

요청한 페이지 크기입니다. 1에서 200 사이여야 합니다. 지정하지 않으면 기본값은 100입니다. 잘못된 값이 지정된 경우 오류 코드 INVALID_ARGUMENT을 반환합니다.

pageToken

string

서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이전 customLists.list 메서드 호출에서 반환된 nextPageToken 값입니다. 지정하지 않으면 결과의 첫 페이지가 표시됩니다.

orderBy

string

목록을 정렬할 기준 필드입니다. 사용 가능한 값:

  • customListId(기본값)
  • displayName

기본 정렬 순서는 오름차순입니다. 필드에 내림차순을 지정하려면 필드 이름에 서픽스 'desc'를 추가해야 합니다. 예: displayName desc

filter

string

맞춤 목록 필드로 필터링할 수 있습니다.

지원되는 구문:

  • 커스텀 목록의 필터 표현식에는 최대 1개의 제한사항만 포함할 수 있습니다.
  • 제한사항의 형식은 {field} {operator} {value}입니다.
  • 모든 필드에 HAS (:) 연산자를 사용해야 합니다.

지원되는 필드:

  • displayName

예:

  • 표시 이름에 'Google'이 포함된 모든 맞춤 목록: displayName:"Google"

이 필드의 길이는 500자(영문 기준) 이하여야 합니다.

자세한 내용은 LIST 요청 필터링 가이드를 참고하세요.

advertiserId

string (int64 format)

가져온 맞춤 목록에 대한 액세스 권한이 있는 DV360 광고주의 ID입니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
필드
customLists[]

object (CustomList)

맞춤 목록의 목록입니다.

비어 있는 경우 이 목록은 표시되지 않습니다.

nextPageToken

string

결과의 다음 페이지를 검색하는 토큰입니다. 이후 customLists.list 메서드 호출에서 pageToken 필드에 이 값을 전달하여 결과의 다음 페이지를 검색합니다.

승인 범위

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

  • https://www.googleapis.com/auth/display-video

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