Method: customLists.list

맞춤 목록을 나열합니다.

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

HTTP 요청

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

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

쿼리 매개변수

매개변수
pageSize

integer

요청한 페이지 크기입니다. 1~200의 값이어야 합니다. 지정하지 않으면 기본값은 100입니다. 잘못된 값이 지정되면 오류 코드 INVALID_ARGUMENT이 반환됩니다.
pageToken

string

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

string

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

  • customListId(기본)
  • displayName

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

string

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

지원되는 구문:

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

지원되는 필드:

  • displayName

예:

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

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

자세한 내용은 LIST 요청 필터링 가이드를 참고하세요.
공용체 매개변수 accessor입니다. 필수 항목입니다. 요청이 이루어지는 DV360 항목을 식별합니다. LIST 요청은 accessor에서 식별된 DV360 항목에 액세스할 수 있는 맞춤 목록 항목만 반환합니다. accessor은 다음 중 하나일 수 있습니다.
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 개요를 참고하세요.