Places Autocomplete Service

کلاس AutocompleteService

google.maps.places . AutocompleteService کلاس google.maps.places . AutocompleteService

شامل روش های مربوط به بازیابی پیش بینی های تکمیل خودکار است.

با فراخوانی const {AutocompleteService} = await google.maps.importLibrary("places") دسترسی پیدا کنید.
کتابخانه ها را در Maps JavaScript API ببینید.

AutocompleteService
AutocompleteService()
پارامترها: ندارد
یک نمونه جدید از AutocompleteService ایجاد می کند.
getPlacePredictions
getPlacePredictions(request[, callback])
پارامترها:
  • request : AutocompletionRequest درخواست تکمیل خودکار.
  • callback : function( Array < AutocompletePrediction > optional , PlacesServiceStatus ): void optional پاسخ به تماسی که آرایه ای از اشیاء AutocompletePrediction و مقدار PlacesServiceStatus را به عنوان آرگومان می پذیرد.
مقدار بازگشتی: Promise < AutocompleteResponse >
پیش بینی های تکمیل خودکار مکان را بر اساس درخواست تکمیل خودکار ارائه شده بازیابی می کند.
getQueryPredictions
getQueryPredictions(request, callback)
پارامترها:
ارزش بازگشتی: ندارد
پیش بینی های تکمیل خودکار پرس و جو را بر اساس درخواست تکمیل خودکار پرس و جو ارائه شده بازیابی می کند.

رابط درخواست تکمیل خودکار

google.maps.places . AutocompletionRequest رابط google.maps.places . AutocompletionRequest

یک درخواست تکمیل خودکار برای ارسال به AutocompleteService.getPlacePredictions .

input
نوع: string
کاربر رشته ورودی را وارد کرده است.
bounds optional
نوع: LatLngBounds | LatLngBoundsLiteral optional
مرزهای جهت گیری پیش بینی پیش‌بینی‌ها نسبت به bounds داده‌شده مغرضانه خواهد بود، اما محدود به آن نخواهد بود. در صورت تنظیم bounds location و radius هر دو نادیده گرفته می شوند.
componentRestrictions optional
نوع: ComponentRestrictions optional
محدودیت های مولفه محدودیت‌های مؤلفه برای محدود کردن پیش‌بینی‌ها فقط به آنهایی که در مؤلفه اصلی هستند استفاده می‌شوند. مثلا کشور.
language optional
نوع: string optional
در صورت امکان، یک شناسه زبان برای زبانی که نتایج باید به آن بازگردانده شوند. ممکن است به نتایج زبان انتخابی رتبه بالاتری داده شود، اما پیشنهادات محدود به این زبان نیست. لیست زبان های پشتیبانی شده را ببینید.
location optional
نوع: LatLng optional
مکان برای سوگیری پیش بینی پیش‌بینی‌ها نسبت به location و radius داده‌شده مغرضانه خواهد بود. متناوبا، می توان از bounds استفاده کرد.
locationBias optional
نوع: LocationBias optional
یک مرز نرم یا اشاره برای استفاده در هنگام جستجوی مکان‌ها.
locationRestriction optional
نوع: LocationRestriction optional
محدودیت هایی برای محدود کردن نتایج جستجو.
offset optional
نوع: number optional
موقعیت کاراکتر در عبارت ورودی که در آن سرویس از متن برای پیش بینی استفاده می کند (موقعیت مکان نما در قسمت ورودی).
origin optional
نوع: LatLng | LatLngLiteral optional
مکانی که AutocompletePrediction.distance_meters از آنجا محاسبه می شود.
radius optional
نوع: number optional
شعاع ناحیه مورد استفاده برای بایاسینگ پیش بینی. radius بر حسب متر مشخص می شود و همیشه باید با یک ویژگی location همراه باشد. متناوبا، می توان از bounds استفاده کرد.
region optional
نوع: string optional
یک کد منطقه ای که برای قالب بندی نتایج و برای فیلتر کردن نتایج استفاده می شود. این پیشنهادات را به این کشور محدود نمی کند. کد منطقه یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") را می پذیرد. اکثر کدهای ccTLD با کدهای ISO 3166-1 یکسان هستند، با برخی استثناهای قابل توجه. به عنوان مثال، ccTLD بریتانیا "uk" ( .co.uk ) است در حالی که کد ISO 3166-1 آن "gb" است (از لحاظ فنی برای نهاد "پادشاهی متحده بریتانیای کبیر و ایرلند شمالی").
sessionToken optional
نوع: AutocompleteSessionToken optional
مرجع منحصر به فرد مورد استفاده برای بسته بندی درخواست های فردی در جلسات.
types optional
نوع: Array <string> optional
انواع پیش بینی هایی که باید برگردانده شوند. برای انواع پشتیبانی شده، به راهنمای برنامه نویس مراجعه کنید. اگر هیچ نوع مشخص نشده باشد، همه انواع برگردانده می شوند.

رابط AutocompleteResponse

google.maps.places . AutocompleteResponse رابط google.maps.places . AutocompleteResponse

یک پاسخ تکمیل خودکار که با تماس به AutocompleteService.getPlacePredictions حاوی لیستی از AutocompletePrediction برگردانده می شود.

predictions
فهرست AutocompletePrediction s.

واسط QueryAutocompletionRequest

google.maps.places . QueryAutocompletionRequest واسط google.maps.places . QueryAutocompletionRequest

یک درخواست QueryAutocompletion برای ارسال به QueryAutocompleteService .

input
نوع: string
کاربر رشته ورودی را وارد کرده است.
bounds optional
نوع: LatLngBounds | LatLngBoundsLiteral optional
مرزهای جهت گیری پیش بینی پیش‌بینی‌ها نسبت به bounds داده‌شده مغرضانه خواهد بود، اما محدود به آن نخواهد بود. در صورت تنظیم bounds location و radius هر دو نادیده گرفته می شوند.
location optional
نوع: LatLng optional
مکان برای سوگیری پیش بینی پیش‌بینی‌ها نسبت به location و radius داده‌شده مغرضانه خواهد بود. متناوبا، می توان از bounds استفاده کرد.
offset optional
نوع: number optional
موقعیت کاراکتر در عبارت ورودی که در آن سرویس از متن برای پیش بینی استفاده می کند (موقعیت مکان نما در قسمت ورودی).
radius optional
نوع: number optional
شعاع ناحیه مورد استفاده برای بایاسینگ پیش بینی. radius بر حسب متر مشخص می شود و همیشه باید با یک ویژگی location همراه باشد. متناوبا، می توان از bounds استفاده کرد.

رابط ComponentRestrictions

google.maps.places . ComponentRestrictions رابط google.maps.places . ComponentRestrictions

محدودیت‌های مؤلفه‌ای را که می‌توان با سرویس تکمیل خودکار استفاده کرد، تعریف می‌کند.

country optional
نوع: string| Array <string> optional
پیش‌بینی‌ها را به کشور مشخص شده محدود می‌کند (کد کشور ISO 3166-1 Alpha-2، حساس به حروف کوچک و بزرگ). برای مثال، 'us' ، 'br' یا 'au' . شما می توانید یک یا یک آرایه از حداکثر پنج رشته کد کشور ارائه دهید.

رابط AutocompletePrediction

google.maps.places . AutocompletePrediction رابط google.maps.places . AutocompletePrediction

یک پیش‌بینی تکمیل خودکار را نشان می‌دهد.

description
نوع: string
این نسخه فرمت نشده درخواست پیشنهاد شده توسط سرویس Places است.
matched_substrings
مجموعه‌ای از رشته‌های فرعی در توضیحات مکان که با عناصر ورودی کاربر مطابقت دارد، مناسب برای استفاده در برجسته کردن آن زیررشته‌ها. هر زیر رشته با یک افست و یک طول مشخص می شود که در کاراکترهای یونیکد بیان می شود.
place_id
نوع: string
شناسه مکان که می تواند برای بازیابی جزئیات این مکان با استفاده از سرویس جزئیات مکان استفاده شود (به PlacesService.getDetails مراجعه کنید).
structured_formatting
اطلاعات ساختاریافته درباره توضیحات مکان، به یک متن اصلی و یک متن فرعی، شامل آرایه‌ای از رشته‌های فرعی منطبق از ورودی تکمیل خودکار، که با یک افست و طول مشخص شده‌اند، که در نویسه‌های یونیکد بیان می‌شوند، تقسیم‌بندی شده است.
terms
نوع: Array < PredictionTerm >
اطلاعات در مورد اصطلاحات فردی در توضیحات بالا، از بیشتر به کم خاص. به عنوان مثال، "Taco Bell"، "Willitis" و "CA".
types
نوع: Array <string>
آرایه‌ای از انواعی که پیش‌بینی به آن تعلق دارد، برای مثال 'establishment' یا 'geocode' .
distance_meters optional
نوع: number optional
فاصله مکان از AutocompletionRequest.origin بر حسب متر.

رابط QueryAutocompletePrediction

google.maps.places . QueryAutocompletePrediction رابط google.maps.places . QueryAutocompletePrediction

یک پیش‌بینی تکمیل خودکار Query را نشان می‌دهد.

description
نوع: string
این نسخه فرمت نشده درخواست پیشنهاد شده توسط سرویس Places است.
matched_substrings
مجموعه‌ای از رشته‌های فرعی در توضیحات مکان که با عناصر ورودی کاربر مطابقت دارد، مناسب برای استفاده در برجسته کردن آن زیررشته‌ها. هر زیر رشته با یک افست و یک طول مشخص می شود که در کاراکترهای یونیکد بیان می شود.
terms
نوع: Array < PredictionTerm >
اطلاعات در مورد شرایط فردی در توضیحات بالا. اصطلاحات طبقه بندی شده در درجه اول قرار می گیرند (به عنوان مثال، "رستوران"). شرایط نشانی از بیشتر به کمتر خاص ظاهر می شود. به عنوان مثال، "سان فرانسیسکو"، و "CA".
place_id optional
نوع: string optional
فقط در صورتی در دسترس است که پیش‌بینی یک مکان باشد. شناسه مکان که می تواند برای بازیابی جزئیات این مکان با استفاده از سرویس جزئیات مکان استفاده شود (به PlacesService.getDetails مراجعه کنید).

رابط PredictionTerm

google.maps.places . PredictionTerm رابط google.maps.places . PredictionTerm

یک عبارت پیش بینی را نشان می دهد.

offset
نوع: number
افست شروع این اصطلاح در توصیف مکان با حروف یونیکد.
value
نوع: string
ارزش این اصطلاح، به عنوان مثال، "تاکو بل".

رابط PredictionSubstring

google.maps.places . PredictionSubstring رابط google.maps.places . PredictionSubstring

یک زیررشته پیش بینی را نشان می دهد.

length
نوع: number
طول رشته فرعی.
offset
نوع: number
افست شروع رشته فرعی در رشته توضیحات.

رابط StructuredFormatting

google.maps.places . StructuredFormatting رابط google.maps.places . StructuredFormatting

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

main_text
نوع: string
این قسمت متنی اصلی توضیحات بدون قالب مکان است که توسط سرویس Places پیشنهاد شده است. معمولاً نام مکان.
main_text_matched_substrings
مجموعه ای از رشته های فرعی در متن اصلی که با عناصر ورودی کاربر مطابقت دارد و برای استفاده در برجسته کردن آن زیر رشته ها مناسب است. هر زیر رشته با یک افست و یک طول مشخص می شود که در کاراکترهای یونیکد بیان می شود.
secondary_text
نوع: string
این قسمت متنی ثانویه از توضیحات بدون قالب مکان است که توسط سرویس Places پیشنهاد شده است. معمولا موقعیت مکانی.