Method: googleLocations.search

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

בקשת HTTP

POST https://mybusinessbusinessinformation.googleapis.com/v1alpha/googleLocations:search

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "pageSize": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (Location)
  },
  "query": string
  // End of mutually exclusive fields.
}
שדות
pageSize

integer

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

object (Location)

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

string

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

גוף התשובה

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

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

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

object (GoogleLocation)

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

היקפי הרשאות

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

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

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