Method: locations.getExtended

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

בקשת HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/{name=locations/*}:getExtended

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

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

פרמטרים
name

string

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

גוף הבקשה

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

גוף התשובה

מייצג מיקום יחד עם המטא-נתונים של העריכה שלו ומצב ההצגה הנוכחי.

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

ייצוג ב-JSON 
{
  "locationProvidedByMerchant": {
    object (Location)
  },
  "locationSeenByConsumers": {
    object (Location)
  },
  "extendedFieldData": {
    string: {
      object (ExtendedFieldData)
    },
    ...
  }
}
שדות
locationProvidedByMerchant

object (Location)

פלט בלבד. נתוני המיקום הבסיסיים שהמוכר מנהל.
locationSeenByConsumers

object (Location)

פלט בלבד. נתוני המיקום שמוצגים כרגע לצרכנים במפות Google ובחיפוש Google.
extendedFieldData

map (key: string, value: object (ExtendedFieldData))

פלט בלבד. נתוני שדה מורחבים, עם מפתח לפי השם של שדה ברמה העליונה של המשאב Location.

המפתחות הם תמיד שמות פשוטים של שדות ברמה העליונה, אף פעם לא נתיבי שדות בתצוגת עץ. כל שדה ברמה העליונה מטופל באופן אטומי, כך שאם משנים שדה משנה, המפה הזו תתייחס אליו כשינוי בשדה ברמה העליונה.

אובייקט שמכיל רשימה של צמדי "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.