Method: accounts.locations.reviews.list

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
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

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

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.