Method: advertisers.locationLists.assignedLocations.list

地域リストに割り当てられているビジネスを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。地域リストが属するディスプレイ&ビデオ 360 広告主の ID。
locationListId

string (int64 format)

必須。これらの割り当てが割り当てられているビジネス リストの ID。

クエリ パラメータ

パラメータ
pageSize

integer

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

string

サーバーが返す結果のページを識別するトークン。

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

string

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

  • assignedLocationId（デフォルト）

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

string

ビジネス リストの割り当てフィールドによるフィルタリングを許可します。

サポートされる構文:

  • フィルタ式は 1 つ以上の制限で構成されます。
  • 制限は OR 論理演算子で結合できます。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで EQUALS (=) 演算子を使用する必要があります。

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

  • assignedLocationId

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

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

リクエスト本文

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

レスポンスの本文

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

AssignedLocationService.ListAssignedLocations に対するレスポンス メッセージ。

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

object (AssignedLocation)

割り当て済みのロケーションのリスト。

空の場合、このリストは存在しません。
nextPageToken

string

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

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

認可スコープ

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

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

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