Method: searchText

جستجوی مکان‌ها با پُرسمان نوشتاری.

درخواست HTTP

POST https://mapstools.googleapis.com/v1alpha:searchText

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

متن درخواست

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

نمایش JSON 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "pageSize": integer,
  "includeExtendedDetails": boolean,
  "locationBias": {
    object (LocationBias)
  }
}
فیلدها
textQuery

string

الزامی. پُرسمان نوشتاری.
languageCode

string

اختیاری. زبان درخواستی برای برگرداندن خلاصه. اگر کد زبان نامشخص یا ناشناخته باشد، خلاصه با اولویت زبان انگلیسی برگردانده می‌شود.

برای مثال، «en» برای انگلیسی.

فهرست فعلی زبان‌های پشتیبانی‌شده: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

اختیاری. کد کشور/منطقه یونی‌کد (CLDR) مکانی که درخواست از آنجا می‌آید. این پارامتر برای نمایش جزئیات مکان، مانند نام مکان خاص منطقه، درصورت دردسترس بودن، استفاده می‌شود. این پارامتر می‌تواند براساس قانون ذی‌ربط بر نتایج تأثیر بگذارد.

برای مثال، «US» برای ایالات متحده.

برای اطلاعات بیشتر، به https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html مراجعه کنید.

توجه داشته باشید که کدهای منطقه ۳ رقمی درحال‌حاضر پشتیبانی نمی‌شوند.
pageSize

integer

اختیاری. حداکثر تعداد مکان‌هایی که باید برگردانده شود، تا ۱۰ مکان. سرویس ممکن است کمتر از این مقدار را برگرداند. مقدار پیش‌فرض ۵ است.

درخواست بیش‌از ۵ مکان باعث فعال شدن سطح Pro و افزایش هزینه صورت‌حساب و تأخیر می‌شود.
includeExtendedDetails

boolean

اختیاری. شامل جزئیات گسترده مکان در پاسخ می‌شود.

وقتی درخواست کاربر به اطلاعات آماری کیفی غنی، پویایی‌های هم‌زمان، یا مشخصه‌های نهاد تخصصی نیاز دارد، این فیلد را روی true تنظیم کنید: - مرورهای کیفی، احساسات مشتری، و بازخورد. - پیشنهادهای ویژه خاص مانند گزینه‌های منو، غذاها، غذاهای ویژه، نوشیدنی‌ها، یا نکات برجسته کسب‌وکار. - جو کیفی، دکوراسیون داخلی، زیبایی‌شناسی، محیط، یا حال‌وهوا. - داده‌های هم‌زمان و مشخصات تسهیلات تخصصی، خط‌مشی‌ها/نکات بازدیدکننده، زمان‌های انتظار.

false (پیش‌فرض) را برای جستجوهای اکتشافی استاندارد (مثلاً غذاها، انواع فروشگاه)، جستجوهای مکان/نشانی، اطلاعات تماس، ساعت کاری، و فراداده/امکانات رفاهی استاندارد بگذارید.

فعال کردن این فیلد باعث راه‌اندازی سطح Pro و افزایش هزینه صورت‌حساب و تأخیر می‌شود.
locationBias

object (LocationBias)

منطقه‌ای اختیاری برای سوگیری نتایج جستجو به آن. اگر مکان صریحی در textQuery باشد، به‌جای این فیلد برای سوگیری نتایج جستجو استفاده خواهد شد.

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه‌ای از SearchTextResponse است.

دامنه‌های مجوز

به گستره OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/maps-platform.mapstools