Method: projects.locations.privateOffers.documents.list

指定された親の PrivateOfferDocuments を一覧表示します。

HTTP リクエスト

GET https://commerceproducer.googleapis.com/v1beta/{parent=projects/*/locations/*/privateOffers/*}/documents

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

パスパラメータ

パラメータ
parent

string

必須。ListPrivateOfferDocumentsRequest の親の値。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返される結果の最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 500 です。500 を超える値は 500 に強制変換されます。指定しない場合、サーバーはデフォルトで最大値を使用します。
pageToken

string

省略可。前のリスト レスポンス メッセージから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページネーションを行う場合、リストリクエストの他のすべてのパラメータは、ページトークンを返したリクエストと一致している必要があります。

リクエストの本文

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

レスポンスの本文

PrivateOfferDocuments の一覧表示に対するレスポンスのメッセージ

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

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

object (PrivateOfferDocument)

PrivateOfferDocuments のリスト。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform

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

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • commerceproducer.privateOfferDocuments.list

詳細については、IAM のドキュメントをご覧ください。