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
(deprecated)

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 Overview をご覧ください。

LocationReview

ビジネス情報のクチコミを表します。

JSON 表現 
{
  "name": string,
  "review": {
    object (Review)
  }
}
フィールド
name

string

ビジネスのリソース名。
review

object (Review)

ビジネスに関するクチコミ。