Method: accounts.locations.list

רשימת המיקומים של החשבון שצוין.

בקשת HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

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

פרמטרים
parent

string

חובה. שם החשבון שממנו רוצים לאחזר את המיקומים. אם חשבון ההורה [Account] [google.mybusiness.accountmanagement.v1.Account] הוא [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType], מוחזרים רק מיקומים שנמצאים בבעלותו הישירה של החשבון. אחרת, מוחזרים כל המיקומים שנגישים מהחשבון, בין אם באופן ישיר או עקיף.

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

פרמטרים
pageSize

integer

אפשרות. כמה מיקומים לאחזר בכל דף. אם לא הוגדר ערך ברירת המחדל הוא 10. גודל הדף המינימלי הוא 1 וגודל הדף המקסימלי הוא 100.
pageToken

string

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

string

אפשרות. מסנן שמגביל את החזרה של המיקומים. התשובה תכלול רק ערכים שתואמים למסנן. אם השדה filter ריק, אז האילוצים יחולו וכל המיקומים (לפי עימוד) מאוחזרים עבור החשבון המבוקש.

מידע נוסף על שדות חוקיים ועל שימוש לדוגמה זמין במדריך לעבודה עם נתוני מיקום.
orderBy

string

אפשרות. סדר המיון של הבקשה. אם יש כמה שדות, צריך להפריד ביניהם בפסיקים בהתאם לתחביר של SQL. סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד, צריך להוסיף את הסיומת ' description'. השדות החוקיים ל-orderBy הם title ו-storeCode. לדוגמה: "title, storeCode description" או "title" או "storeCode description"
readMask

string (FieldMask format)

חובה. יש לקרוא את האנונימיזציה כדי לציין אילו שדות יוחזרו בתגובה.

זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: "user.displayName,photo"

גוף הבקשה

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

גוף התגובה

הודעת תגובה עבור Locations.ListLocations.

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

ייצוג JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
שדות
locations[]

object (Location)

המיקומים.
nextPageToken

string

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

integer

המספר המשוער של מיקומים ברשימה, ללא קשר לדפים. השדה הזה יוחזר רק אם filter משמש כפרמטר של שאילתה.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

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