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

是否忽略仅含评分的评价。

响应正文

如果成功,响应正文将包含结构如下的数据:

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

对营业地点的评价。