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 排序。可按 rating、rating desc 和 updateTime 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。