Method: advertisers.reachForecast.retrievePlannableUserLists

예측에 사용할 수 있는 서드 파티 및 퍼스트 파티 사용자 목록을 가져옵니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

경로 매개변수

매개변수
advertiserId

string (int64 format)

필수 항목입니다. 계획 가능한 사용자 목록을 가져올 광고주의 ID입니다.

쿼리 매개변수

파라미터
pageSize

integer

(선택사항) 요청한 페이지 크기입니다. 1에서 5000 사이여야 합니다. 지정하지 않으면 기본값인 5000이 사용됩니다.
pageToken

string

(선택사항) 서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이는 reachForecast.retrievePlannableUserLists 메서드에 대한 이전 호출에서 반환된 nextPageToken의 값입니다. 지정하지 않으면 결과의 첫 번째 페이지가 반환됩니다.
filter

string

(선택사항) 계획 가능한 사용자 목록 속성을 기준으로 필터링할 수 있습니다.

지원되는 문법:

  • 필터 표현식은 하나 이상의 제한으로 구성됩니다.
  • 제한은 AND 또는 OR 논리 연산자로 결합할 수 있습니다.
  • 제한은 {field} {operator} {value} 형식입니다.
  • displayName 필드는 HAS (:) 연산자를 사용해야 합니다.
  • 다른 모든 필드는 EQUALS (=) 연산자를 사용해야 합니다.

지원되는 필드:

  • plannableStatus
  • displayName
  • userListType
  • name

예:

  • 계획 가능한 모든 사용자 목록: plannableStatus="PLANNABLE"
  • 표시 이름에 '쇼핑'이 포함된 계획 가능한 사용자 목록: plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • 퍼스트 파티 사용자 목록: userListType="FIRST_PARTY"

이 필드의 길이는 500자를 초과할 수 없습니다.

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

요청 본문

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

응답 본문

reachForecast.retrievePlannableUserLists에 대한 응답입니다.

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

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

object (PlannableUserList)

출력 전용입니다. 계획 가능한 사용자 목록입니다.
nextPageToken

string

출력 전용입니다. 결과의 다음 페이지를 검색하는 토큰입니다.

승인 범위

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

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

자세한 내용은 OAuth 2.0 Overview를 참조하세요.

PlannableUserList

도달범위 예측에 사용되는 계획 가능한 사용자 목록입니다.

JSON 표현 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
필드
displayName

string

출력 전용입니다. 사용자 목록의 표시 이름입니다.
userListType

enum (UserListType)

출력 전용입니다. 사용자 목록의 유형입니다.
name

string

출력 전용입니다. 사용자 목록을 식별하는 리소스 이름입니다.

형식: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

출력 전용입니다. 사용자 목록의 계획 가능성 상태입니다.

UserListType

사용자 목록의 유형입니다.

열거형
USER_LIST_TYPE_UNSPECIFIED 지정되지 않은 사용자 목록 유형입니다.
FIRST_PARTY 퍼스트 파티 사용자 목록입니다.
THIRD_PARTY 서드 파티 사용자 목록입니다.

PlannableStatus

목록의 계획 가능 여부를 나타내는 상태입니다.

열거형
PLANNABLE_STATUS_UNSPECIFIED 지정되지 않은 계획 가능성 상태입니다.
PLANNABLE 사용자 목록을 계획할 수 있습니다.
UNPLANNABLE 사용자 목록을 계획할 수 없습니다.