Method: accounts.locations.reviews.list

הפונקציה מחזירה את רשימת הביקורות בחלוקה לדפים של המיקום שצוין. פעולה זו תקפה רק אם המיקום שצוין מאומת.

בקשת HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

שם המיקום שלגביו רוצים לאחזר ביקורות.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

כמה ביקורות לאחזר בכל דף. המספר המקסימלי של pageSize הוא 50.
pageToken

string

אם צוין, הוא יאחזר את דף הביקורות הבא.
orderBy

string

מציינת את השדה שלפיו צריך למיין את הביקורות. אם לא צויין ערך, סדר הצגת הביקורות שהוחזרו יהיה updateTime desc כברירת מחדל. הזמנות תקפות למיון לפי הן rating, rating desc ו-updateTime desc.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

הודעת תגובה ל-Reviews.ListReviews.

ייצוג JSON 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "averageRating": number,
  "totalReviewCount": integer,
  "nextPageToken": string
}
שדות
reviews[]

object (Review)

הביקורות.
averageRating

number

דירוג הכוכבים הממוצע של כל הביקורות על המיקום הזה בסולם של 1 עד 5. 5 הוא הדירוג הגבוה ביותר.
totalReviewCount

integer

המספר הכולל של ביקורות על המיקום הזה.
nextPageToken

string

אם מספר הביקורות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף הביקורות הבא בקריאה הבאה ל-review.list. אם אין יותר ביקורות, השדה הזה לא יופיע בתשובה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.