Method: inventorySources.list

現在のユーザーがアクセスできるインベントリ ソースを一覧表示します。

順序は orderBy パラメータで定義されます。filter と entityStatus が指定されていない場合、エンティティ ステータスが ENTITY_STATUS_ARCHIVED のインベントリ ソースは結果に含まれません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/inventorySources

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

  • displayName（デフォルト）

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

string

広告枠ソースのフィールドでフィルタできます。

サポートされる構文:

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

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

  • status.entityStatus
  • commitment
  • deliveryMethod
  • rateDetails.rateType
  • exchange

例:

  • 有効なすべての広告枠ソース: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Google アド マネージャーまたは Rubicon エクスチェンジに属する広告枠ソース: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。
結合パラメータ accessor。必須。リクエストが作成されているディスプレイ＆ビデオ 360 エンティティを識別します。LIST リクエストは、accessor 内で識別されたディスプレイ＆ビデオ 360 エンティティがアクセスできる広告枠ソース エンティティのみを返します。accessor は次のいずれかになります。
partnerId

string (int64 format)

在庫ソースにアクセスできるパートナーの ID。
advertiserId

string (int64 format)

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

リクエストの本文

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

レスポンスの本文

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

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

object (InventorySource)

広告在庫ソースのリスト。

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

string

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

認可スコープ

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

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

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