הפונקציה מחזירה את רשימת הביקורות עם אפשרות ניווט בין הדפים לכל המיקומים שצוינו. הפעולה הזו תקפה רק אם המיקומים שצוינו מאומתים.
בקשת HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
name |
השם של החשבון שממנו רוצים לאחזר רשימה של ביקורות על כמה מיקומים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "locationNames": [ string ], "pageSize": integer, "pageToken": string, "orderBy": string, "ignoreRatingOnlyReviews": boolean } |
| שדות | |
|---|---|
locationNames[] |
אוסף של מיקומים שרוצים לאחזר לגביהם ביקורות, שצוינו לפי השמות שלהם. |
pageSize |
מספר הביקורות שיש לאחזר בכל דף. ערך ברירת המחדל הוא 50. |
pageToken |
אם מצוין, המערכת מאחזרת את הדף הבא של הביקורות. |
orderBy |
אופציונלי. מציינים את השדה שלפיו ימוינו הביקורות. אם לא מציינים ערך, סדר הביקורות שיוחזרו יהיה |
ignoreRatingOnlyReviews |
האם להתעלם מביקורות שכוללות דירוג בלבד. |
גוף התשובה
הודעת תגובה ל-Reviews.BatchGetReviews.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{
"locationReviews": [
{
object ( |
| שדות | |
|---|---|
locationReviews[] |
ביקורות עם פרטי מיקום. |
nextPageToken |
אם מספר הביקורות חורג מגודל הדף שצוין בבקשה, השדה הזה יאוכלס באסימון שישמש לאחזור הדף הבא של הביקורות בקריאות הבאות. אם אין יותר ביקורות, השדה הזה לא יופיע בתשובה. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.
LocationReview
מייצג ביקורת עם פרטי מיקום.
| ייצוג ב-JSON |
|---|
{
"name": string,
"review": {
object ( |
| שדות | |
|---|---|
name |
שם המשאב של המיקום. |
review |
ביקורת על המיקום. |