Method: accounts.locations.reviews.list

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

HTTP 要求

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

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

路徑參數

參數
parent

string

要擷取評論的位置名稱。

查詢參數

參數
pageSize

integer

每頁要擷取的評論數。最多可輸入 50 個半形字元。pageSize

pageToken

string

如果已指定,則會擷取下一頁的評論。

orderBy

string

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

要求主體

要求主體必須為空白。

回應主體

Reviews.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 Overview