רשימת המיקומים של החשבון שצוין.
בקשת HTTP
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
שם החשבון שממנו רוצים לאחזר את המיקומים. אם המאפיין |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
כמה מיקומים לאחזר בכל דף. ברירת המחדל היא 100, המינימום הוא 1 וגודל הדף המקסימלי הוא 100. |
pageToken |
אם צוין, הפונקציה מאחזרת את |
filter |
מסנן שמגביל את החזרה של המיקומים. התשובה תכלול רק ערכים שתואמים למסנן. אם השדה מידע נוסף על שדות חוקיים ועל שימוש לדוגמה זמין במדריך לעבודה עם נתוני מיקום. |
languageCode |
קוד השפה BCP 47 שאליו צריך להוסיף את מאפייני המיקום של התצוגה. אם השפה הזו לא זמינה, הם יסופקו בשפה של המיקום. אם אף אחת מהן לא זמינה, היא תצוין באנגלית. הוּצא משימוש. אחרי 15 באוגוסט 2020 השדה הזה לא יופיע יותר. במקום זאת, תמיד ייעשה שימוש בשפה של המיקום. |
orderBy |
סדר המיון של הבקשה. אם יש כמה שדות, צריך להפריד ביניהם בפסיקים בהתאם לתחביר של SQL. סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד, צריך להוסיף את הסיומת ' description'. השדות החוקיים ל-orderBy הם locationName ו-storeCode. לדוגמה: 'locationName, storeCode description' או 'locationName' או 'storeCode description' |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
הודעת תגובה עבור Locations.ListLocations.
ייצוג JSON | |
---|---|
{
"locations": [
{
object ( |
שדות | |
---|---|
locations[] |
המיקומים. |
nextPageToken |
אם מספר המיקומים חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון לאחזור דף המיקומים הבא בקריאה הבאה אל |
totalSize |
המספר המשוער של מיקומים ברשימה, ללא קשר לדפים. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.