Method: exchanges.orders.list

注文を一覧表示します。

HTTP リクエスト

GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*}/orders

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

パスパラメータ

パラメータ
parent

string

親リソース名。例: 「exchanges/123」必須。

クエリ パラメータ

パラメータ
pageSize

integer

返される最大アイテム数。デフォルトは 50 です。最大値は 200 です。指定しない場合、デフォルトのページサイズは 50 です。pageSize が 200 を超える場合、ページサイズとして 200 が使用されます。

pageToken

string

前の List リクエストから返された nextPageToken 値(存在する場合)。

filter

string

商品のプロパティでフィルタできます。

サポートされる構文:

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

例:

  • ステータスが「ACCEPTED」に設定された注文を取得する status=ACCEPTED

  • 表示名が「display name」の注文を取得 displayName="display name"

  • 更新時間が「2024-02-12T18:47:29.784Z」より大きい注文を取得 updateTime>"2024-02-12T18:47:29.784Z"

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

リクエストの本文

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

レスポンスの本文

注文リストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (Order)

リストに表示される注文。返されるアイテムの最大数は、リクエスト内の pageSize フィールドに基づきます。

nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

認可スコープ

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

  • https://www.googleapis.com/auth/doubleclickbidmanager

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