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 をご覧ください。