Places Autocomplete Service (deprecated)

کلاس AutocompleteService

کلاس google.maps.places.AutocompleteService
کتابخانه "places"

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

const {AutocompleteService} = await google.maps.importLibrary("places");
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)
پارامترها:
مقدار برگشتی: هیچ
پیش‌بینی‌های تکمیل خودکار پُرسمان را براساس درخواست تکمیل خودکار پُرسمان ارائه‌شده بازیابی می‌کند.

میانای AutocompletionRequest

میانا google.maps.places.AutocompletionRequest

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

میانای AutocompleteResponse

میانا google.maps.places.AutocompleteResponse

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

میانای QueryAutocompletionRequest

میانا google.maps.places.QueryAutocompletionRequest

درخواست QueryAutocompletion برای ارسال به QueryAutocompleteService.
input
نوع: string
رشته ورودی که کاربر وارد کرده است.
bounds
اختیاری
مرزهای سوگیری پیش‌بینی. پیش‌بینی‌ها به سمت bounds ارائه‌شده سوگیری خواهند داشت، اما به آن محدود نخواهند بود. اگر bounds تنظیم شده باشد، location و radius نادیده گرفته خواهند شد.
location
اختیاری
نوع: LatLng optional
مکان برای سوگیری پیش‌بینی. پیش‌بینی‌ها نسبت به location و radius ارائه‌شده سوگیری خواهند داشت. همچنین، bounds می‌تواند استفاده شود.
offset
اختیاری
نوع: number optional
موقعیت نویسه در عبارت ورودی که سرویس از نوشتار برای پیش‌بینی استفاده می‌کند (موقعیت مکان‌نما در فیلد ورودی).
radius
اختیاری
نوع: number optional
شعاع منطقه‌ای که برای سوگیری پیش‌بینی استفاده می‌شود. radius به متر مشخص می‌شود و همیشه باید با ویژگی location همراه باشد. همچنین، bounds می‌تواند استفاده شود.

میانای ComponentRestrictions

میانا google.maps.places.ComponentRestrictions

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

میانای AutocompletePrediction

میانا google.maps.places.AutocompletePrediction

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

میانای QueryAutocompletePrediction

میانا google.maps.places.QueryAutocompletePrediction

نشان‌دهنده یک پیش‌بینی «تکمیل خودکار پُرسمان» است.
description
نوع: string
این نسخه قالب‌بندی‌نشده پُرسمان پیشنهادی سرویس «مکان‌ها» است.
matched_substrings
مجموعه‌ای از رشته‌های فرعی در شرح مکان که با عناصر ورودی کاربر مطابقت دارد و برای استفاده در برجسته کردن آن رشته‌های فرعی مناسب است. هر رشته فرعی با یک آفست و یک طول که با نویسه‌های یونیکد بیان می‌شود شناسایی می‌شود.
terms
اطلاعات مربوط به شرایط فردی در شرح بالا. اصطلاحات دسته‌بندی اول می‌آیند (برای مثال، «رستوران»). عبارت‌های نشانی از خاص‌ترین به عام‌ترین نشان داده می‌شود. برای مثال، «San Francisco» (سان فرانسیسکو) و «CA» (کالیفرنیا).
place_id
اختیاری
نوع: string optional
فقط درصورتی دردسترس است که پیش‌بینی مکان باشد. شناسه مکانی که می‌توان از آن برای بازیابی جزئیات مربوط به این مکان بااستفاده از سرویس جزئیات مکان استفاده کرد (PlacesService.getDetails را ببینید).

PredictionTerm میانجی

میانا google.maps.places.PredictionTerm

نشان‌دهنده عبارت پیش‌بینی است.
offset
نوع: number
فاصله، در نویسه‌های یونی‌کد، از شروع این عبارت در شرح مکان.
value
نوع: string
مقدار این عبارت، برای مثال، «Taco Bell».

PredictionSubstring میانجی

میانا google.maps.places.PredictionSubstring

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

میانای StructuredFormatting

میانا google.maps.places.StructuredFormatting

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