Method: sellers.orders.list

注文を一覧表示します。

  • 例: GET /v1/sellers/321/orders
  • 注文のリストと、成功した場合は次のページを取得するためのトークンを返します。
  • ユーザーが販売者にアクセスできない場合、または販売者 ID が存在しない場合は、エラーコード PERMISSION_DENIED を返します。
  • 販売者が無効なページサイズまたはページトークンを指定した場合は、エラーコード INVALID_ARGUMENT が返されます。

HTTP リクエスト

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/orders

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

パスパラメータ

パラメータ
parent

string

必須。この注文のコレクションを所有する親。形式: sellers/{seller}

クエリ パラメータ

パラメータ
pageSize

integer

返される最大アイテム数。サービスが返す値はこれよりも少ないことがあります。注文の最大数は 1,000 です。指定されていない場合、最大で 1, 000 件の注文が返されます。
pageToken

string

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

string

リストフィルタ。現在、外部 ID と状態のフィルタリング（構文:「externalId = [EXTERNAL_ID]」）がサポートされています。"state = [STATE]" のように構成されます。論理演算子 AND と OR を使用してフィルタを連結できます。
orderBy

string

結果の並べ替え順序を指定するために使用される文字列による順序。現在、updateTime による並べ替えをサポートしています。「updateTime」を指定してください結果は updateTime の昇順または「updateTime desc」に並べ替えられます。降順に指定します。

リクエスト本文

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

レスポンスの本文

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

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

object (Order)

注文のリスト。
nextPageToken

string

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。