Method: googleLocations.search

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش 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

تعداد موارد منطبق برای برگرداندن. مقدار پیش‌فرض ۳ و حداکثر مقدار ۱۰ است. توجه داشته باشید که اگر تعداد بیشتری درخواست شود، ممکن است تأخیر افزایش یابد. صفحه‌بندی وجود ندارد.
پرسمان جستجو. این را می‌توان به‌صورت شیء مکان یا پُرسمان رشته‌ای ارائه کرد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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 مراجعه کنید.