Method: accounts.locations.list

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

חובה. שם החשבון שממנו רוצים לאחזר מיקומים.

  • מזהה חשבון ספציפי: אם החשבון הוא מסוג AccountType.PERSONAL, התגובה מחזירה רק מיקומים שבבעלות ישירה של החשבון הזה. בכל שאר הסוגים (למשל, AccountType.LOCATION_GROUP), הפונקציה מחזירה את כל המיקומים הנגישים.

  • תו כללי לחיפוש (-): שימוש ב-accounts/- מזהה את המשתמש המאומת. היקף ההרשאות הזה מוגדר כברירת מחדל ל-AccountType.PERSONAL, אבל כולל גם מיקומים בבעלות ישירה וגם מיקומים בבעלות עקיפה (למשל, מיקומים שאפשר לגשת אליהם דרך קבוצות הרשאה).

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

string

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