מחזירה רשימה מעומדת של ביקורות עבור המיקום שצוין. פעולה זו תקפה רק אם המיקום שצוין מאומת.
בקשת HTTP
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
שם המיקום שעבורו רוצים לאחזר ביקורות. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
כמה ביקורות להביא לכל דף. הערך המקסימלי של |
pageToken |
אם צוין, הוא מאחזר את דף הביקורות הבא. |
orderBy |
מציין את השדה שלפיו רוצים למיין את הביקורות. אם לא צוין, סדר הביקורות שיוחזר יוגדר כברירת מחדל ל- |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
הודעת תגובה ל-Reviews.ListReviews.
ייצוג JSON | |
---|---|
{
"reviews": [
{
object ( |
שדות | |
---|---|
reviews[] |
הביקורות. |
averageRating |
דירוג הכוכבים הממוצע של כל הביקורות לגבי המיקום הזה בסולם של 1 עד 5, כאשר 5 הוא הדירוג הגבוה ביותר. |
totalReviewCount |
המספר הכולל של ביקורות עבור המיקום הזה. |
nextPageToken |
אם מספר הביקורות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון להורדת דף הביקורות הבא בקריאה הבאה אל reviews.list. אם אין ביקורות נוספות, השדה הזה לא יופיע בתשובה. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.