Method: accounts.locations.reviews.list

傳回指定位置的評論分頁清單。指定地點已通過驗證時,這項作業才有效。

HTTP 要求

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews

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

路徑參數

參數
parent

string

要擷取評論的地點名稱。

查詢參數

參數
pageSize

integer

每網頁要擷取的評論數量。pageSize 上限為 50。

pageToken

string

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

orderBy

string

指定要做為評論排序依據的欄位。如未指定,傳回的評論順序會預設為 updateTime desc。要排序的有效訂單為 ratingrating descupdateTime desc

要求主體

要求主體必須為空白。

回應主體

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

Review.ListReviews 的回應訊息。

JSON 表示法
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "averageRating": number,
  "totalReviewCount": integer,
  "nextPageToken": string
}
欄位
reviews[]

object (Review)

評論。

averageRating

number

此地點所有評論的平均星級評等 (以 1 到 5 分表示,5 代表最高評分)。

totalReviewCount

integer

這個地點的評論總數。

nextPageToken

string

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

授權範圍

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

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

詳情請參閱 OAuth 2.0 總覽