Method: accounts.locations.reviews.list

指定したビジネスに関するクチコミのページ分けされたリストを返します。この操作は、指定したビジネスのオーナー確認が済んでいる場合にのみ有効です。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

クチコミを取得するビジネスの名前です。

クエリ パラメータ

パラメータ
pageSize

integer

1 ページあたりで取得するクチコミ数です。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 段階で表します。最高評価は 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 の概要をご覧ください。