Method: accounts.locations.batchGetReviews

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

HTTP リクエスト

POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews

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

パスパラメータ

パラメータ
name

string

複数のビジネスにまたがるクチコミの一覧を取得するアカウントの名前です。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "locationNames": [
    string
  ],
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string,
  "ignoreRatingOnlyReviews": boolean
}
フィールド
locationNames[]

string

クチコミを取得するビジネスのコレクションで、名前で指定します。
pageSize

integer

1 ページあたりで取得するクチコミ数です。デフォルト値は 50 です。
pageToken

string

指定すると、クチコミの次のページが取得されます。
orderBy

string

省略可。クチコミの並べ替えの基準とするフィールドを指定します。指定しない場合、返されるクチコミの順序はデフォルトの updateTime desc になります。並べ替えで有効な順序は rating、rating desc、updateTime desc です。rating はクチコミを昇順で返します。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)

ビジネスのクチコミです。