Method: accounts.locations.batchGetReviews

傳回所有指定地點的評論分頁清單。指定地點必須經過驗證,這項操作才有效。

HTTP 要求

POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews

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

路徑參數

參數
name

string

要擷取多個地點評論清單的帳戶名稱。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "locationNames": [
    string
  ],
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string,
  "ignoreRatingOnlyReviews": boolean
}
欄位
locationNames[]

string

要擷取評論的地點集合,以名稱指定。

pageSize

integer

每網頁要擷取的評論數量。預設值為 50。

pageToken

string

如果有指定,系統會擷取下一頁的評論。

orderBy

string

選用設定。指定要做為評論排序依據的欄位。如未指定,傳回的評論順序會預設為 updateTime desc。要排序的有效訂單為 ratingrating descupdateTime descrating 會以遞增順序傳回評論。updateTime不支援(例如遞增順序)。

ignoreRatingOnlyReviews

boolean

是否忽略僅限評分的評論。

回應主體

如果成功,回應主體即會包含具有以下結構的資料:

Review.BatchGetReviews 的回應訊息。

JSON 表示法
{
  "locationReviews": [
    {
      object (LocationReview)
    }
  ],
  "nextPageToken": string
}
欄位
locationReviews[]

object (LocationReview)

包含位置資訊的評論。

nextPageToken

string

如果評論數超過要求的頁面大小,系統會在這個欄位填入一個符記,以擷取後續呼叫的下一頁評論。如果沒有任何評論,回應中就不會顯示這個欄位。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

詳情請參閱 OAuth 2.0 總覽

LocationReview

代表評論與位置資訊。

JSON 表示法
{
  "name": string,
  "review": {
    object (Review)
  }
}
欄位
name

string

位置資源名稱。

review

object (Review)

地點評論。