Method: guaranteedOrders.list

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

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/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 リクエストのフィルタ ガイドをご覧ください。

共用体パラメータ accessor。必須。

リクエストが行われるディスプレイ&ビデオ 360 エンティティを識別できます。LIST リクエストは、accessor 内で識別されるディスプレイ&ビデオ 360 エンティティにアクセス可能な保証型オーダー エンティティのみを返します。accessor は次のいずれかになります。
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 の概要をご覧ください。