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
リストの並べ替え基準として使用するフィールド。有効な値は次のとおりです。
デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「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 。必須。 リクエストがどの DV360 エンティティ内で行われたかを識別します。LIST リクエストでは、accessor 内で識別された DV360 エンティティがアクセスできる保証付きオーダー エンティティのみが返されます。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 Overview をご覧ください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-02-25 UTC。
[null,null,["最終更新日 2025-02-25 UTC。"],[[["Lists guaranteed orders accessible to the current user, filterable by order ID, exchange, display name, and entity status."],["Supports pagination with `pageSize` and `pageToken` for retrieving large result sets."],["Requires `https://www.googleapis.com/auth/display-video` authorization scope for access."],["Returns a list of guaranteed orders and a token for retrieving the next page of results, if available."],["Accessible via a `GET` request to `https://displayvideo.googleapis.com/v3/guaranteedOrders`."]]],["This document outlines how to retrieve a list of guaranteed orders via an HTTP GET request to `https://displayvideo.googleapis.com/v3/guaranteedOrders`. Key actions include setting optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` to customize the results. `partnerId` or `advertiserId` are required parameters. The response includes a list of `guaranteedOrders` and a `nextPageToken` for pagination. Filtering by fields like `entityStatus` is possible, and specific authorization scopes are needed. The request body should be empty.\n"]]