Method: googleLocations.search

همه مکان های ممکن را که با درخواست مشخص شده مطابقت دارند جستجو کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست شامل داده هایی با ساختار زیر است:

نمایندگی 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 مراجعه کنید.