- درخواست HTTP
- درخواست بدن
- بدن پاسخگو
- رتبه اولویت
- LocationBias
- محدودیت مکان
- EVOptions
- محتوای متنی
- توجیه
- بازبینی توجیه
- متن برجسته شده
- HighlightedTextRange
- BusinessAvailabilityAttributes توجیه
جستجوی مکان مبتنی بر پرس و جو متنی.
درخواست HTTP
POST https://places.googleapis.com/v1/places:searchText
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
زمینه های | |
---|---|
textQuery | ضروری. پرس و جو متن برای جستجوی متنی. |
languageCode | جزئیات مکان در صورت وجود با زبان ترجیحی نمایش داده می شود. اگر کد زبان نامشخص یا ناشناخته باشد، جزئیات مکان هر زبانی ممکن است برگردانده شود، در صورت وجود چنین جزئیاتی، ترجیحاً انگلیسی است. لیست فعلی زبان های پشتیبانی شده: https://developers.google.com/maps/faq#languagesupport . |
regionCode | کد کشور/منطقه یونیکد (CLDR) مکانی که درخواست از آنجا می آید. این پارامتر برای نمایش جزئیات مکان، مانند نام مکان خاص منطقه، در صورت وجود استفاده می شود. این پارامتر می تواند بر نتایج بر اساس قانون قابل اجرا تأثیر بگذارد. برای اطلاعات بیشتر، به https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html مراجعه کنید. توجه داشته باشید که کدهای منطقه 3 رقمی در حال حاضر پشتیبانی نمی شوند. |
rankPreference | نتایج چگونه در پاسخ رتبه بندی خواهند شد. |
includedType | نوع مکان درخواستی لیست کامل انواع پشتیبانی شده: https://developers.google.com/maps/documentation/places/web-service/place-types . فقط از یک نوع شامل پشتیبانی کنید. |
openNow | برای محدود کردن جستجو به مکانهایی که در حال حاضر باز هستند استفاده میشود. حالت پیش فرض غلط است. |
minRating | نتایجی را فیلتر کنید که میانگین امتیاز آنها از این حد کمتر است. یک مقدار معتبر باید یک شناور بین 0 و 5 (شامل) در آهنگ 0.5 باشد، یعنی [0، 0.5، 1.0، ...، 5.0] شامل. رتبه ورودی تا نزدیکترین 0.5 (سقف) گرد خواهد شد. به عنوان مثال، رتبه 0.6 تمام نتایج با رتبه کمتر از 1.0 را حذف می کند. |
maxResultCount | منسوخ شده: به جای آن از حداکثر تعداد نتایجی که در هر صفحه قابل بازگشت است. اگر تعداد نتایج موجود بزرگتر از اگر هم |
pageSize | اختیاری. حداکثر تعداد نتایجی که در هر صفحه قابل بازگشت است. اگر تعداد نتایج موجود بزرگتر از اگر هم |
pageToken | اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی TextSearch. این را برای بازیابی صفحه بعدی ارائه دهید. هنگام صفحهبندی، همه پارامترهای غیر از |
priceLevels[] | برای محدود کردن جستجو به مکانهایی که بهعنوان سطوح قیمت مشخص علامتگذاری شدهاند استفاده میشود. کاربران می توانند هر ترکیبی از سطوح قیمت را انتخاب کنند. پیش فرض برای انتخاب همه سطوح قیمت. |
strictTypeFiltering | برای تنظیم فیلتر نوع دقیق برای includeType استفاده می شود. اگر روی true تنظیم شود، فقط نتایج از همان نوع برگردانده می شود. پیش فرض به غلط. |
locationBias | منطقه ای برای جستجو این مکان به عنوان یک سوگیری عمل می کند که به این معنی است که نتایج در اطراف مکان داده شده ممکن است برگردانده شوند. نمیتوان همراه با محدودیت مکان تنظیم کرد. |
locationRestriction | منطقه ای برای جستجو این مکان به عنوان یک محدودیت عمل می کند که به این معنی است که نتایج خارج از مکان معین بازگردانده نمی شوند. همراه با locationBias قابل تنظیم نیست. |
evOptions | اختیاری. گزینه های EV قابل جستجو درخواست جستجوی مکان را تنظیم کنید. |
بدن پاسخگو
پاسخ اولیه برای places.searchText.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "places": [ { object ( |
زمینه های | |
---|---|
places[] | فهرستی از مکان هایی که معیارهای جستجوی متنی کاربر را دارند. |
contextualContents[] | آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید. فهرستی از محتویات متنی که در آن هر ورودی به مکان مربوطه در همان نمایه در فیلد مکان ها مرتبط است. مطالبی که مرتبط با |
nextPageToken | نشانه ای که می تواند به عنوان |
رتبه اولویت
نتایج چگونه در پاسخ رتبه بندی خواهند شد.
Enums | |
---|---|
RANK_PREFERENCE_UNSPECIFIED | برای یک جستار طبقه بندی شده مانند "رستوران ها در شهر نیویورک"، RELEVANCE پیش فرض است. برای جستارهای غیر دسته بندی مانند "Mountain View, CA" توصیه می کنیم که rankPreference را تنظیم نشده رها کنید. |
DISTANCE | نتایج را بر اساس مسافت رتبه بندی می کند. |
RELEVANCE | نتایج را بر اساس ارتباط رتبه بندی می کند. ترتیب مرتب سازی که توسط پشته رتبه بندی عادی تعیین می شود. |
LocationBias
منطقه ای برای جستجو این مکان به عنوان یک سوگیری عمل می کند که به این معنی است که نتایج در اطراف مکان داده شده ممکن است برگردانده شوند.
نمایندگی JSON |
---|
{ // Union field |
زمینه های | |
---|---|
| |
rectangle | یک جعبه مستطیل که توسط گوشه شمال شرقی و جنوب غربی تعریف شده است. |
circle | دایره ای که با نقطه مرکزی و شعاع مشخص می شود. |
محدودیت مکان
منطقه ای برای جستجو این مکان به عنوان یک محدودیت عمل می کند که به این معنی است که نتایج خارج از مکان معین بازگردانده نمی شوند.
نمایندگی JSON |
---|
{ // Union field |
زمینه های | |
---|---|
| |
rectangle | یک جعبه مستطیل که توسط گوشه شمال شرقی و جنوب غربی تعریف شده است. |
EVOptions
گزینه های EV قابل جستجو درخواست جستجوی مکان.
نمایندگی JSON |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
زمینه های | |
---|---|
minimumChargingRateKw | اختیاری. حداقل نرخ شارژ مورد نیاز بر حسب کیلووات. مکانی با نرخ شارژ کمتر از نرخ مشخص شده فیلتر می شود. |
connectorTypes[] | اختیاری. فهرست انواع کانکتورهای EV ترجیحی. مکانی که از هیچ یک از انواع اتصال دهنده های ذکر شده پشتیبانی نمی کند، فیلتر می شود. |
محتوای متنی
آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.
محتوایی که با پرس و جوی مکان مطابقت دارد.
نمایندگی JSON |
---|
{ "reviews": [ { object ( |
زمینه های | |
---|---|
reviews[] | فهرست نظرات درباره این مکان، مرتبط با جستجوی مکان. |
photos[] | اطلاعات (از جمله مراجع) درباره عکسهای این مکان، مرتبط با جستار مکان. |
justifications[] | آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید. توجیهات برای مکان |
توجیه
آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.
توجیهات برای مکان Justifications به این سوال پاسخ می دهد که چرا یک مکان می تواند یک کاربر نهایی را مورد توجه قرار دهد.
نمایندگی JSON |
---|
{ // Union field |
زمینه های | |
---|---|
| |
reviewJustification | آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید. |
businessAvailabilityAttributesJustification | آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید. |
بازبینی توجیه
آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.
توجیهات بررسی کاربران این قسمتی از بررسی کاربر را برجسته می کند که برای کاربر نهایی جالب است. به عنوان مثال، اگر عبارت جستجو "پیتزا هیزم" باشد، توجیه بازبینی متن مربوط به عبارت جستجو را برجسته می کند.
نمایندگی JSON |
---|
{ "highlightedText": { object ( |
زمینه های | |
---|---|
highlightedText | |
review | مروری که متن برجسته شده از آن ایجاد شده است. |
متن برجسته شده
متن برجسته شده توسط توجیه. این زیر مجموعه ای از خود بررسی است. کلمه دقیقی که باید برجسته شود با HighlightedTextRange مشخص می شود. ممکن است چندین کلمه در متن برجسته شده باشد.
نمایندگی JSON |
---|
{
"text": string,
"highlightedTextRanges": [
{
object ( |
زمینه های | |
---|---|
text | |
highlightedTextRanges[] | فهرست محدوده های متن برجسته شده. |
HighlightedTextRange
محدوده متن هایلایت شده
نمایندگی JSON |
---|
{ "startIndex": integer, "endIndex": integer } |
زمینه های | |
---|---|
startIndex | |
endIndex | |
BusinessAvailabilityAttributes توجیه
آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید. BusinessAvailabilityAttributes توجیهات. این نشان میدهد که یک کسبوکار دارای ویژگیهایی است که میتواند کاربر نهایی را مورد توجه قرار دهد.
نمایندگی JSON |
---|
{ "takeout": boolean, "delivery": boolean, "dineIn": boolean } |
زمینه های | |
---|---|
takeout | اگر مکانی فراهم می کند. |
delivery | اگر مکانی تحویل داده شود. |
dineIn | اگر مکانی غذاخوری را فراهم می کند. |