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)

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

היקפי הרשאות

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

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

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