رابط AutocompleteRequest
google.maps.places . AutocompleteRequest
رابط google.maps.places . AutocompleteRequest
درخواست رابط برای AutocompleteSuggestion.fetchAutocompleteSuggestions
.
خواص | |
---|---|
input | نوع: string رشته متنی که در آن جستجو می شود. |
includedPrimaryTypes optional | نوع: Array <string> optional شامل نوع مکان اصلی (به عنوان مثال، "رستوران" یا "پمپ بنزین"). یک مکان تنها در صورتی برگردانده می شود که نوع اصلی آن در این لیست گنجانده شده باشد. حداکثر 5 مقدار قابل تعیین است. اگر هیچ نوع مشخصی وجود نداشته باشد، همه انواع Place برگردانده می شوند. |
includedRegionCodes optional | نوع: Array <string> optional فقط شامل نتایج در مناطق مشخص شده، مشخص شده به عنوان حداکثر 15 کد منطقه دو نویسه 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 Console باشد. پس از پایان جلسه، رمز دیگر معتبر نیست. برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر sessionToken حذف شود، یا اگر از یک نشانه جلسه استفاده مجدد کنید، هزینه جلسه به گونه ای محاسبه می شود که گویی هیچ نشانه جلسه ارائه نشده است (هر درخواست جداگانه صورتحساب می شود).ما دستورالعمل های زیر را توصیه می کنیم:
|
کلاس AutocompleteSessionToken
google.maps.places . AutocompleteSessionToken
کلاس google.maps.places . AutocompleteSessionToken
نشان دهنده یک نشانه جلسه است که برای ردیابی یک جلسه تکمیل خودکار استفاده می شود.
با فراخوانی const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
دسترسی پیدا کنید. کتابخانه ها را در Maps JavaScript API ببینید.
سازنده | |
---|---|
AutocompleteSessionToken | AutocompleteSessionToken() پارامترها: ندارد یک نمونه جدید از AutocompleteSessionToken ایجاد می کند. |
AutocompleteSuggestion کلاس
google.maps.places . AutocompleteSuggestion
کلاس
یک نتیجه پیشنهاد تکمیل خودکار.
با فراخوانی const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
دسترسی پیدا کنید. کتابخانه ها را در Maps JavaScript API ببینید.
روش های استاتیک | |
---|---|
fetchAutocompleteSuggestions | fetchAutocompleteSuggestions(autocompleteRequest) مولفه های:
مقدار بازگشتی: Promise <{suggestions: Array < AutocompleteSuggestion >}> فهرستی از AutocompleteSuggestions را واکشی می کند. |
خواص | |
---|---|
placePrediction | نوع: PlacePrediction optional حاوی نام قابل خواندن توسط انسان برای نتیجه برگشتی است. برای نتایج تاسیس، این معمولاً نام و آدرس کسب و کار است. |
کلاس PlacePrediction
google.maps.places . 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 شناسه منحصر به فرد مکان پیشنهادی. این شناسه را می توان در سایر APIهایی که شناسه مکان را می پذیرند استفاده کرد. |
secondaryText | نوع: FormattableText optional نمایانگر ویژگیهای ابهامزدایی اضافی (مانند شهر یا منطقه) برای شناسایی بیشتر مکان است. |
text | نوع: FormattableText حاوی نام قابل خواندن توسط انسان برای نتیجه برگشتی است. برای نتایج تاسیس، این معمولاً نام و آدرس کسب و کار است. text برای توسعه دهندگانی که می خواهند یک عنصر رابط کاربری را نشان دهند توصیه می شود. برنامهنویسانی که میخواهند دو عنصر رابط کاربری مجزا، اما مرتبط را نشان دهند، ممکن است بخواهند به جای آن از PlacePrediction.mainText و PlacePrediction.secondaryText استفاده کنند. |
types | نوع: Array <string> فهرست انواعی که برای این مکان از جدول A یا جدول B در https://developers.google.com/maps/documentation/places/web-service/place-types اعمال می شود. |
مواد و روش ها | |
---|---|
toPlace | toPlace() پارامترها: ندارد ارزش برگشتی: Place یک نمایش مکان از این PlacePrediction را برمیگرداند. برای دریافت جزئیات کامل مکان، تماس بعدی با Place.fetchFields لازم است. |
کلاس StringRange
google.maps.places . StringRange
کلاس google.maps.places . StringRange
یک زیر رشته را در یک متن مشخص شناسایی می کند.
با فراخوانی const {StringRange} = await google.maps.importLibrary("places")
دسترسی پیدا کنید. کتابخانه ها را در Maps JavaScript API ببینید.
خواص | |
---|---|
endOffset | نوع: number آفست مبتنی بر صفر آخرین کاراکتر یونیکد رشته فرعی (انحصاری). |
startOffset | نوع: number آفست مبتنی بر صفر اولین کاراکتر یونیکد رشته فرعی (شامل). |
کلاس FormattableText
google.maps.places . 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 قالب بندی شود. |