Method: accounts.locations.list

בתיבת הדו-שיח הזו מפורטים המיקומים של החשבון שצוין.

בקשת HTTP

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

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

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

פרמטרים
parent

string

חובה. שם החשבון שממנו יש לאחזר את המיקומים. אם ההורים [חשבון] [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. ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד, צריך להוסיף סיומת " סדר יורד" יש להוסיף. השדות החוקיים למיון לפי 'סידור לפי' הם 'שם' ו'קוד חנות'. לדוגמה: 'title, storeCode desc' או 'title' או 'storeCode desc'
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.