Method: accounts.locations.list

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

שם החשבון שממנו יש לאחזר את המיקומים. אם הערך של Account הוא AccountType אישי, מוחזרים רק מיקומים שנמצאים בבעלותו הישירה של החשבון. אחרת, הוא יחזיר את כל המיקומים שהיו נגישים מהחשבון, באופן ישיר או עקיף.

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

string

קוד השפה של BCP 47 שבו יש להציג את מאפייני המיקום לתצוגה. אם השפה הזו לא זמינה, היא תסופק בשפת המיקום. אם אף אחת מהאפשרויות האלה לא זמינה, הן יסופקו באנגלית.

הוצא משימוש. אחרי 15 באוגוסט 2020, השדה הזה לא יהיה זמין יותר. תמיד ייעשה שימוש בשפה של המיקום.
orderBy

string

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

גוף הבקשה

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

גוף התשובה

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

הודעת תגובה לגבי Locations.ListLocations.

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

object (Location)

המיקומים.
nextPageToken

string

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

integer

המספר המשוער של המיקומים ברשימה, ללא קשר לחלוקה לדפים.

היקפי הרשאות

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

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

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