Method: guaranteedOrders.list

現在のユーザーがアクセスできる保証型取引を一覧表示します。

順序は orderBy パラメータで定義されます。entityStatus による filter が指定されていない場合、エンティティ ステータスが ENTITY_STATUS_ARCHIVED の保証型取引は結果に含まれません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v5/guaranteedOrders

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

  • displayName（デフォルト）

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

string

保証型取引のフィールドでフィルタできます。

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

サポートされるフィールド: * guaranteedOrderId * exchange * displayName * status.entityStatus

例:

  • 有効なすべての保証型の取引: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Google アド マネージャーまたは Rubicon エクスチェンジに属する保証型取引オーダー: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

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

必須。

リクエストが行われているディスプレイ＆ビデオ 360 エンティティを識別します。LIST リクエストは、accessor で識別されたディスプレイ＆ビデオ 360 エンティティがアクセスできる保証型取引オーダー エンティティのみを返します。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
partnerId

string (int64 format)

保証型取引オーダーにアクセスできるパートナーの ID。
advertiserId

string (int64 format)

保証型取引オーダーにアクセスできる広告主の ID。
相互に排他的なフィールドの終了。

リクエストの本文

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

レスポンスの本文

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

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

object (GuaranteedOrder)

保証型取引のリスト。

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

string

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

認可スコープ

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

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

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