REST Resource: accounts.locations.reviews

リソース: Review

出力専用。ビジネスについてのクチコミを表します。

JSON 表現 
{
  "name": string,
  "reviewId": string,
  "reviewer": {
    object (Reviewer)
  },
  "starRating": enum (StarRating),
  "comment": string,
  "createTime": string,
  "updateTime": string,
  "reviewReply": {
    object (ReviewReply)
  }
}
フィールド
name

string

リソース名。クチコミの場合は accounts/{accountId}/locations/{locationId}/reviews/{reviewId} という形式になります。
reviewId

string

暗号化された一意の ID です。
reviewer

object (Reviewer)

レビューを書いた人です。
starRating

enum (StarRating)

クチコミの評価です。
comment

string

マークアップ付きの書式なしテキストによるクチコミの本文です。
createTime

string (Timestamp format)

クチコミが投稿されたときのタイムスタンプです。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

クチコミが最後に変更されたときのタイムスタンプです。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
reviewReply

object (ReviewReply)

このクチコミに対するビジネスのオーナーまたは管理者による返信です。

クチコミ投稿者

クチコミの投稿者を表します。

JSON 表現 
{
  "profilePhotoUrl": string,
  "displayName": string,
  "isAnonymous": boolean
}
フィールド
profilePhotoUrl

string

クチコミ投稿者のプロフィール写真へのリンクです。isAnonymous が false の場合にのみ入力されます。
displayName

string

クチコミ投稿者の名前。isAnonymous が false の場合にのみクチコミ投稿者の実名が入力されます。
isAnonymous

boolean

クチコミ投稿者が匿名のままにするよう設定しているかどうかを表します。

StarRating

星 5 つを最も高い評価とする評価です。

列挙型
STAR_RATING_UNSPECIFIED 指定されていません。
ONE 最高で星 5 つのうちの 1 つ星です。
TWO 最高で星 5 つのうちの 2 つ星です。
THREE 最高で星 5 つのうちの 3 つ星です。
FOUR 最高で星 5 つのうちの 4 つ星です。
FIVE 最高の評価です。

ReviewReply

クチコミに対するビジネスのオーナーまたは管理者による返信を表します。

JSON 表現 
{
  "comment": string,
  "updateTime": string,
  "reviewReplyState": enum (State)
}
フィールド
comment

string

マークアップが付いた書式なしテキストとしての返信の本文です。最大長は 4,096 バイトです。
updateTime

string (Timestamp format)

出力専用。返信が最後に変更されたときのタイムスタンプです。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
reviewReplyState

enum (State)

出力専用。クチコミへの返信の状態。

状態

クチコミへの返信のモデレーションの状態を表します。

列挙型
REVIEW_REPLY_STATE_UNSPECIFIED 状態が指定されていないことを示します。
PENDING 返信がモデレーション待ちであることを示します。
REJECTED 返信が拒否されたことを示します。
APPROVED 返信が承認されたことを示します。

メソッド

deleteReply

 指定したクチコミへの返信を削除します。

get

 指定したクチコミを返します。

list

 指定したビジネスについて、ページ分けされたクチコミの一覧を返します。

updateReply

 指定したクチコミへの返信を更新します。