傳回所有指定地點的分頁評論清單。指定的位置必須通過驗證,這項作業才會生效。
HTTP 要求
POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
要擷取多個地點評論清單的帳戶名稱。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 | |
---|---|
{ "locationNames": [ string ], "pageSize": integer, "pageToken": string, "orderBy": string, "ignoreRatingOnlyReviews": boolean } |
欄位 | |
---|---|
locationNames[] |
要擷取評論的地點集合,以名稱指定。 |
pageSize |
每頁要擷取的評論數量。預設值為 50。 |
pageToken |
如果有指定,它會擷取下一頁的評論。 |
orderBy |
選用設定。指定評論排序依據的欄位。如未指定,傳回的評論順序將預設為 |
ignoreRatingOnlyReviews |
是否忽略僅限評分的評論。 |
回應主體
如果成功,回應主體會含有以下結構的資料:
Review.BatchGetReviews 的回應訊息。
JSON 表示法 | |
---|---|
{
"locationReviews": [
{
object ( |
欄位 | |
---|---|
locationReviews[] |
含有位置資訊的評論。 |
nextPageToken |
如果評論數量超過要求的頁面大小,這個欄位就會填入符記,以便在後續呼叫中擷取下一個評論頁面。如果已經沒有評論,系統就不會在回覆中顯示這個欄位。 |
授權範圍
需要下列其中一種 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 ( |
欄位 | |
---|---|
name |
位置資源名稱。 |
review |
對地點的評論。 |