Method: projects.locations.privateOffers.documents.list

列出指定上層的 PrivateOfferDocuments。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標，ListPrivateOfferDocumentsRequest 的父項值。

查詢參數

參數
pageSize

integer

選用。要傳回的結果數上限。服務傳回的產品數量可能會少於這個值。許可的最大值為 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 說明文件。