Method: inventorySourceGroups.list

現在のユーザーがアクセスできる広告枠ソースグループを一覧表示します。

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/inventorySourceGroups

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

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～200 の範囲で指定してください。指定しない場合のデフォルトは 100 です。
pageToken

string

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

string

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

  • displayName（デフォルト）
  • inventorySourceGroupId

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

string

広告枠ソースグループのフィールドによるフィルタリングを許可します。

サポートされる構文:

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

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

  • inventorySourceGroupId

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

詳しくは、LIST リクエストのフィルタに関するガイドをご覧ください。
ユニオン パラメータ accessor。必須。リクエストが行われているディスプレイ&ビデオ 360 エンティティを示します。LIST リクエストでは、accessor 内で特定されたディスプレイ&ビデオ 360 エンティティがアクセスできる広告枠ソース グループのエンティティのみが返されます。accessor は次のいずれかになります。
partnerId

string (int64 format)

広告枠ソースグループにアクセスできるパートナーの ID。

パートナーは、広告主が所有する広告枠ソースグループにはアクセスできません。
advertiserId

string (int64 format)

広告枠ソースグループにアクセスできる広告主の ID。

広告枠ソースグループがパートナー所有の場合、グループにアクセスできるのは、グループが明示的に共有されている広告主のみです。

リクエスト本文

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

レスポンスの本文

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

InventorySourceGroupService.ListInventorySourceGroups に対するレスポンス メッセージ。

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

object (InventorySourceGroup)

広告枠ソースグループのリスト。

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

string

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

認可スコープ

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

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

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