Autocomplete Data

کلاس AutocompleteSuggestion

‫google.maps.places.AutocompleteSuggestion کلاس

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

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

fetchAutocompleteSuggestions
fetchAutocompleteSuggestions(autocompleteRequest)
پارامترها: 
مقدار برگشتی:  Promise<{suggestions:Array<AutocompleteSuggestion>}>
فهرستی از AutocompleteSuggestions را واکشی می‌کند.

اگر AutocompleteRequest.sessionToken در درخواست ارائه شده باشد، آن کد جلسه به‌طور خودکار هنگام فراخوانی Place.fetchFields برای اولین‌بار، در هر Place برگردانده‌شده توسط PlacePrediction.toPlace در PlacePredictionهای حاصل گنجانده خواهد شد.
placePrediction
نوع:  PlacePrediction optional
حاوی نام قابل‌خواندن برای انسان برای نتیجه برگردانده‌شده است. برای نتایج مربوط به مؤسسه‌ها، این اطلاعات معمولاً نام و نشانی کسب‌وکار است.

اگر AutocompleteRequest.sessionToken در AutocompleteRequest استفاده‌شده برای واکشی این AutocompleteSuggestion ارائه شده باشد، همان کد به‌طور خودکار هنگام فراخوانی Place.fetchFields برای اولین‌بار در Place برگردانده‌شده توسط فراخوانی به PlacePrediction.toPlace گنجانده خواهد شد.

میانای AutocompleteRequest

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

درخواست میانای AutocompleteSuggestion.fetchAutocompleteSuggestions.

input
نوع:  string
رشته نوشتاری که باید در آن جستجو شود.
includedPrimaryTypes optional
نوع:  Array<string> optional
نوع مکان اصلی گنجانده‌شده (برای مثال، «رستوران» یا «پمپ بنزین»).

«مکان» فقط درصورتی برگردانده می‌شود که نوع اصلی آن در این فهرست گنجانده شده باشد. حداکثر ۵ مقدار را می‌توان مشخص کرد. اگر هیچ نوعی مشخص نشده باشد، همه انواع «مکان» برگردانده می‌شود.
includedRegionCodes optional
نوع:  Array<string> optional
فقط نتایج را در مناطق مشخص‌شده، که حداکثر با ۱۵ کد منطقه دوحرفی CLDR مشخص شده‌اند، لحاظ کنید. مجموعه خالی نتایج را محدود نخواهد کرد. اگر هم locationRestriction و هم includedRegionCodes تنظیم شده باشد، نتایج در منطقه تقاطع قرار خواهد گرفت.
inputOffset optional
نوع:  number optional
یک افست نویسه یونی‌کد با پایه صفر از input که موقعیت مکان‌نما را در input نشان می‌دهد. موقعیت مکان‌نما ممکن است بر پیش‌بینی‌های ارائه‌شده تأثیر بگذارد. اگر مشخص نشده باشد، به‌طور پیش‌فرض به طول input است.
language optional
نوع:  string optional
زبانی که نتایج به آن برگردانده می‌شود. به‌طور پیش‌فرض روی اولویت زبان مرورگر تنظیم می‌شود. اگر زبان استفاده‌شده در input با language متفاوت باشد، یا اگر «مکان» برگردانده‌شده ترجمه‌ای از زبان محلی به language نداشته باشد، ممکن است نتایج به زبان‌های مختلفی باشد.
locationBias optional
نوع:  LocationBias optional
نتایج را به مکان مشخصی متمایل می‌کند.

حداکثر یکی از locationBias یا locationRestriction باید تنظیم شود. اگر هیچ‌کدام تنظیم نشده باشد، نتایج براساس نشانی IP سوگیری خواهد داشت، یعنی نشانی IP به مکان غیردقیقی نگاشت می‌شود و به‌عنوان سیگنال سوگیری استفاده می‌شود.
locationRestriction optional
نوع:  LocationRestriction optional
نتایج را به مکان مشخص‌شده محدود می‌کند.

حداکثر یکی از locationBias یا locationRestriction باید تنظیم شود. اگر هیچ‌کدام تنظیم نشده باشد، نتایج براساس نشانی IP سوگیری خواهد داشت، یعنی نشانی IP به مکان غیردقیقی نگاشت می‌شود و به‌عنوان سیگنال سوگیری استفاده می‌شود.
origin optional
نوع:  LatLng|LatLngLiteral optional
نقطه مبدأ که فاصله ژئودزیک تا مقصد از آن محاسبه می‌شود (به‌صورت PlacePrediction.distanceMeters برگردانده می‌شود). اگر این مقدار حذف شود، فاصله ژئودزیک برگردانده نخواهد شد.
region optional
نوع:  string optional
کد منطقه، که به‌عنوان کد منطقه دوحرفی CLDR مشخص شده است. این پارامتر بر قالب‌بندی نشانی و رتبه‌بندی نتایج تأثیر می‌گذارد و ممکن است بر نتایج برگردانده‌شده نیز تأثیر بگذارد. این کار نتایج را به منطقه مشخص‌شده محدود نمی‌کند.
sessionToken optional
نوع:  AutocompleteSessionToken optional
نشانه‌ای که جلسه «تکمیل خودکار» را برای اهداف صورت‌حساب شناسایی می‌کند. کد جلسه جدیدی ازطریق AutocompleteSessionToken تولید کنید.

جلسه زمانی شروع می‌شود که کاربر شروع به تایپ کردن پُرسمان می‌کند و زمانی به‌پایان می‌رسد که کاربر مکانی را انتخاب می‌کند و با Place.fetchFields تماس می‌گیرد. هر جلسه می‌تواند چندین پُرسمان داشته باشد و پس‌از آن یک تماس fetchFields برقرار شود. اعتبارنامه‌های استفاده‌شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه «کنسول Google Cloud» باشد. وقتی جلسه‌ای به‌پایان می‌رسد، کد دیگر معتبر نیست؛ برنامه‌تان باید برای هر جلسه کد جدیدی تولید کند. اگر پارامتر sessionToken حذف شود یا اگر از کد جلسه مجدداً استفاده کنید، هزینه جلسه به‌گونه‌ای محاسبه می‌شود که گویی هیچ کد جلسه‌ای ارائه نشده است (هر درخواست به‌طور جداگانه صورت‌حساب می‌شود).

وقتی کد جلسه در درخواست به AutocompleteSuggestion.fetchAutocompleteSuggestions ارائه می‌شود، همان کد به‌طور خودکار در اولین تماس با fetchFields در Place که با فراخوانی PlacePrediction.toPlace در یکی از AutocompleteSuggestionهای حاصل برگردانده شده است، گنجانده می‌شود.

دستورالعمل‌های زیر را توصیه می‌کنیم:
  • از کد جلسه برای همه تماس‌های «تکمیل خودکار جا» استفاده کنید.
  • برای هر جلسه، یک کد جدید تولید کنید.
  • حتماً برای هر جلسه جدید، یک کد جلسه یکتا ارسال کنید. استفاده از یک کد برای بیش‌از یک جلسه باعث می‌شود که هر درخواست به‌صورت جداگانه صورت‌حساب شود.

کلاس AutocompleteSessionToken

‫google.maps.places.AutocompleteSessionToken کلاس

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

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

AutocompleteSessionToken
AutocompleteSessionToken()
پارامترها:  هیچ
نمونه جدیدی از AutocompleteSessionToken ایجاد می‌کند.

کلاس PlacePrediction

‫google.maps.places.PlacePrediction کلاس

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

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

distanceMeters
نوع:  number optional
طول ژئودزیک به متر از origin اگر origin مشخص شده باشد.
mainText
نوع:  FormattableText optional
نشان‌دهنده نام «مکان» است.
placeId
نوع:  string
شناسه یکتای «مکان» پیشنهادی. از این شناسه می‌توان در میاناهای برنامه‌سازی کاربردی دیگری که «شناسه مکان» را می‌پذیرند استفاده کرد.
secondaryText
نوع:  FormattableText optional
ویژگی‌های ابهام‌زدایی تکمیلی (مانند شهر یا منطقه) را برای شناسایی بیشتر «مکان» نشان می‌دهد.
text
نوع:  FormattableText
حاوی نام قابل‌خواندن برای انسان برای نتیجه برگردانده‌شده است. برای نتایج مربوط به مؤسسه‌ها، این اطلاعات معمولاً نام و نشانی کسب‌وکار است.

text برای توسعه‌دهندگانی توصیه می‌شود که می‌خواهند یک عنصر میانای کاربر را نشان دهند. توسعه‌دهندگانی که می‌خواهند دو عنصر میانای کاربر جداگانه اما مرتبط را نشان دهند، ممکن است بخواهند به‌جای آن از PlacePrediction.mainText و PlacePrediction.secondaryText استفاده کنند.
types
نوع:  Array<string>
فهرست انواع اعمال‌شده بر این «مکان» از جدول الف یا جدول ب در https://developers.google.com/maps/documentation/places/web-service/place-types.
BetafetchAddressValidation
fetchAddressValidation(request)
پارامترها: 
مقدار برگشتی:  Promise<AddressValidation>
درخواست «اعتبارسنجی نشانی» مرتبط با این جلسه تکمیل خودکار را ارسال می‌کند (درخواست را به‌طور داخلی با کد جلسه تکمیل خودکار پر می‌کند). هیچ اطلاعات مکانی از PlacePrediction به‌طور خودکار اضافه نمی‌شود - این روشی راحت برای کمک به مدیریت جلسه تکمیل خودکار است.
toPlace
toPlace()
پارامترها:  هیچ
مقدار برگشتی:  Place
نمایش Place این PlacePrediction را برمی‌گرداند. برای دریافت جزئیات کامل «مکان»، تماس بعدی با Place.fetchFields لازم است.

اگر AutocompleteRequest.sessionToken در AutocompleteRequest استفاده‌شده برای واکشی این PlacePrediction ارائه شده باشد، همان کد به‌طور خودکار هنگام فراخوانی fetchFields گنجانده خواهد شد.

یا هنگام استفاده از PlaceAutocompleteElement، اولین تماس با Place.fetchFields در Place که توسط PlacePrediction.toPlace برگردانده شده است به‌طور خودکار شامل کد جلسه خواهد بود.

StringRange کلاس

‫google.maps.places.StringRange کلاس

رشته فرعی را در نوشتار داده‌شده شناسایی می‌کند.

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

endOffset
نوع:  number
انحراف صفرپایه آخرین نویسه یونی‌کد رشته فرعی (انحصاری).
startOffset
نوع:  number
انحراف صفرپایه اولین نویسه یونی‌کد رشته فرعی (شامل).

کلاس FormattableText

‫google.maps.places.FormattableText کلاس

نوشتاری که پیش‌بینی «مکان» را نشان می‌دهد. نوشتار ممکن است به‌همان صورت یا قالب‌بندی‌شده استفاده شود.

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

matches
نوع:  Array<StringRange>
فهرستی از محدوده‌های رشته‌ای که مشخص می‌کند درخواست ورودی در کجا با FormattableText.text مطابقت دارد. از این محدوده‌ها می‌توان برای قالب‌بندی بخش‌های خاصی از text استفاده کرد. اگر تطابق براساس معیاری غیراز تطابق رشته‌ای (برای مثال، اصلاح املایی یا نویسه‌گردانی) تعیین شده باشد، ممکن است رشته‌های فرعی دقیقاً با AutocompleteRequest.input مطابقت نداشته باشند. این مقادیر، جابه‌جایی نویسه یونی‌کد FormattableText.text هستند. تضمین می‌شود که گستره‌ها به‌ترتیب افزایش مقادیر آفست مرتب شوند.
text
نوع:  string
نوشتاری که ممکن است همان‌طور که هست استفاده شود یا با FormattableText.matches قالب‌بندی شود.