Method: advertisers.locationLists.list

指定された広告主 ID に基づいて、地域リストを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/locationLists

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。取得したロケーション リストが属するディスプレイ＆ビデオ 360 広告主の ID。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～200 の範囲で指定してください。設定しない場合、デフォルトで 100 になります。無効な値が指定されている場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークンです。

通常、これは locationLists.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
orderBy

string

リストの並べ替え基準として使用するフィールド。有効な値は次のとおりです。

  • locationListId（デフォルト）
  • displayName

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「desc」を追加する必要があります。例: displayName desc。
filter

string

ロケーション リストのフィールドでフィルタできます。

サポートされる構文:

  • フィルタ式は、1 つ以上の制限で構成されます。
  • 制限は、AND 論理演算子または OR 論理演算子で組み合わせることができます。制限のシーケンスでは、暗黙的に AND が使用されます。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで EQUALS (=) 演算子を使用する必要があります。

サポートされているフィールド:

  • locationType

例:

  • すべてのリージョンの場所のリスト: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • すべての近接性ロケーションのリスト: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、LIST リクエストをフィルタするガイドをご覧ください。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "locationLists": [
    {
      object (LocationList)
    }
  ],
  "nextPageToken": string
}
フィールド
locationLists[]

object (LocationList)

地域リストのリスト。

空の場合は、このリストは表示されません。
nextPageToken

string

結果の次のページを取得するためのトークン。

この値を次の locationLists.list メソッド呼び出しの pageToken フィールドで渡して、結果の次ページを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。