Method: customLists.list

カスタムリストを一覧表示します。

順序は orderBy パラメータで定義されます。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
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 リクエストのガイドをご覧ください。
結合パラメータ accessor。必須。リクエストが作成されているディスプレイ＆ビデオ 360 エンティティを識別します。LIST リクエストは、accessor 内で識別されたディスプレイ＆ビデオ 360 エンティティがアクセスできるカスタムリスト エンティティのみを返します。accessor は次のいずれかになります。
advertiserId

string (int64 format)

取得したカスタム リストにアクセスできるディスプレイ＆ビデオ 360 広告主の 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 Overview をご覧ください。