Method: inventorySourceGroups.list

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

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v2/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 の概要をご覧ください。