Method: advertisers.reachForecast.retrievePlannableUserLists

予測に使用できるファーストパーティとサードパーティのユーザーリストを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。プラン可能なユーザーリストを取得する広告主の ID。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。1～5000 の範囲で指定してください。指定しない場合、デフォルトは 5000 になります。
pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークン。通常、これは reachForecast.retrievePlannableUserLists メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合は、結果の最初のページが返されます。
filter

string

省略可。プラン可能なユーザーリストのプロパティでフィルタリングできます。

サポートされている構文:

  • フィルタ式は、1 つ以上の制限で構成されます。
  • 制限は、論理演算子 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 ユーザーリストをプランニングできません。