Method: customLists.list

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

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v2/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 内で識別された DV360 エンティティがアクセスできるカスタム リスト エンティティのみを返します。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 の概要をご覧ください。