Method: googleLocations.search

חיפוש בכל המיקומים האפשריים שתואמים לבקשה שצוינה.

בקשת HTTP

POST https://mybusiness.googleapis.com/v4/googleLocations:search

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON
{
  "resultCount": integer,

  // Union field search_query can be only one of the following:
  "location": {
    object (Location)
  },
  "query": string
  // End of list of possible types for union field search_query.
}
שדות
resultCount

integer

מספר ההתאמות שיש להחזיר. ערך ברירת המחדל הוא 3, ומקסימום 10. הערה: זמן האחזור עשוי להתארך אם תבקשו יותר. אין עימוד.

שדה איחוד search_query. שאילתת חיפוש. ניתן להזין אותו כאובייקט מיקום או כשאילתת מחרוזת. הערך של search_query יכול להיות רק אחת מהאפשרויות הבאות:
location

object (Location)

מיקום לחיפוש. אם תספקו כתובת, נוכל למצוא מיקומים שתואמים לפרטי המיקום שסופקו.

query

string

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

גוף התגובה

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

הודעת תגובה ל-GoogleLocations.SearchGoogleLocations.

ייצוג JSON
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
שדות
googleLocations[]

object (GoogleLocation)

אוסף של מיקומים ב-GoogleLocations שהם התאמות פוטנציאליות לבקשה שצוינה, בסדר יורד מהגבוה לנמוך ביותר.

היקפי הרשאות

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

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

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