Method: inventorySourceGroups.list

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

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/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 内で識別された DV360 エンティティにアクセスできる広告枠ソース グループのエンティティのみを返します。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 の概要をご覧ください。