فئة AutocompleteService
google.maps.places.AutocompleteService
class
يحتوي على طرق ذات صلة باسترداد توقّعات البحث المقترَحة.
يمكنك الوصول إليه من خلال الاتصال بالرقم const {AutocompleteService} = await google.maps.importLibrary("places")
. اطّلِع على المكتبات في واجهة برمجة تطبيقات JavaScript للخرائط.
الشركة المصنِّعة | |
---|---|
AutocompleteService |
AutocompleteService() المَعلمات: بدون
لإنشاء مثيل جديد من AutocompleteService |
الطُرق | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) المَعلمات:
القيمة المعروضة:
Promise<AutocompleteResponse> يسترجع التوقّعات المتعلّقة بإكمال الأماكن تلقائيًا استنادًا إلى طلب الإكمال التلقائي المقدَّم. |
getQueryPredictions |
getQueryPredictions(request, callback) المَعلمات:
القيمة المعروضة: لا شيء
يسترجع عبارات البحث المقترَحة من خلال ميزة "الإكمال التلقائي" استنادًا إلى طلب الإكمال التلقائي المقدَّم. |
واجهة AutocompletionRequest
google.maps.places.AutocompletionRequest
واجهة
طلب إرسال ميزة "الإكمال التلقائي" إلى AutocompleteService.getPlacePredictions
الخصائص | |
---|---|
input |
النوع:
string أدخل المستخدم سلسلة الإدخال. |
|
النوع:
LatLngBounds|LatLngBoundsLiteral optional حدود الانحياز في التوقّعات وستتّجه التوقّعات نحو bounds المحدّد، ولكن ليس حصريًا عليه. سيتم تجاهل كل من location وradius في حال ضبط bounds . |
componentRestrictions optional |
النوع:
ComponentRestrictions optional قيود المكوّنات تُستخدَم قيود المكوّنات لتقييد التوقّعات على تلك التي تقع ضمن المكوّن الرئيسي فقط. على سبيل المثال، البلد. |
language optional |
النوع:
string 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 منه |
|
النوع:
number optional نصف قطر المنطقة المستخدَمة لتحديد الميل في التنبؤ. يتم تحديد radius بالأمتار، ويجب أن تكون مصحوبة دائمًا بسمة location . بدلاً من ذلك، يمكن استخدام bounds . |
region optional |
النوع:
string optional رمز منطقة يُستخدَم لتنسيق النتائج وفلترة النتائج ولا تقتصر الاقتراحات على هذا البلد. يقبل رمز المنطقة قيمة نطاق المستوى الأعلى لرموز البلدان (ccTLD) المكوّنة من حرفَين. تتطابق معظم رموز نطاقات المستوى الأعلى لرمز البلد مع رموز ISO 3166-1، مع بعض الاستثناءات البارزة. على سبيل المثال، رمز المستوى الأعلى للمنطقة الجغرافية للمملكة المتحدة هو uk ( .co.uk ) بينما رمزه وفقًا لمعيار ISO 3166-1 هو gb (للجهة المعروفة رسميًا باسم "المملكة المتحدة لبريطانيا العظمى وأيرلندا الشمالية"). |
sessionToken optional |
النوع:
AutocompleteSessionToken optional مرجع فريد يُستخدَم لتجميع الطلبات الفردية في جلسات |
types optional |
النوع:
Array<string> optional أنواع التوقّعات التي سيتم عرضها للاطّلاع على الأنواع المتوافقة، يُرجى الاطّلاع على دليل المطوّر. في حال عدم تحديد أي أنواع، سيتم عرض جميع الأنواع. |
واجهة AutocompleteResponse
google.maps.places.AutocompleteResponse
واجهة
ردّ الإكمال التلقائي الذي يعرضه الطلب إلى AutocompleteService.getPlacePredictions
يحتوي على قائمة بقيم AutocompletePrediction
.
الخصائص | |
---|---|
predictions |
النوع:
Array<AutocompletePrediction> قائمة AutocompletePrediction |
QueryAutocompletionRequest
google.maps.places.QueryAutocompletionRequest
واجهة
يجب إرسال طلب QueryAutocompletion إلى QueryAutocompleteService
.
الخصائص | |
---|---|
input |
النوع:
string أدخل المستخدم سلسلة الإدخال. |
bounds optional |
النوع:
LatLngBounds|LatLngBoundsLiteral optional حدود الانحياز في التوقّعات وستتّجه التوقّعات نحو bounds المحدّد، ولكن ليس حصريًا عليه. سيتم تجاهل كل من location وradius في حال ضبط bounds . |
location optional |
النوع:
LatLng optional الموقع الجغرافي لتحديد انحياز التوقّعات ستكون التوقّعات متحيّزة نحو location وradius المحدّدين. بدلاً من ذلك، يمكن استخدام bounds . |
offset optional |
النوع:
number optional موضع الحرف في عبارة الإدخال الذي تستخدم فيه الخدمة النص للتوقّعات (موضع المؤشر في حقل الإدخال). |
radius optional |
النوع:
number optional نصف قطر المنطقة المستخدَمة لتحديد الميل في التنبؤ. يتم تحديد radius بالأمتار، ويجب أن تكون مصحوبة دائمًا بسمة location . بدلاً من ذلك، يمكن استخدام bounds . |
واجهة ComponentRestrictions
google.maps.places.ComponentRestrictions
واجهة
يحدِّد القيود المفروضة على المكوّنات التي يمكن استخدامها مع خدمة الإكمال التلقائي.
الخصائص | |
---|---|
country optional |
النوع:
string|Array<string> optional تقييد التوقّعات بالبلد المحدّد (رمز البلد وفقًا لمعيار ISO 3166-1 Alpha-2، بدون تمييز بين الأحرف الكبيرة والصغيرة) على سبيل المثال، 'us' أو 'br' أو 'au' . يمكنك تقديم سلسلة واحدة أو صفيف من سلاسل رموز البلدان التي يصل عددها إلى خمس سلاسل. |
واجهة AutocompletePrediction
google.maps.places.AutocompletePrediction
واجهة
يمثّل عبارة بحث مقترَحة واحدة من خلال ميزة "الإكمال التلقائي".
الخصائص | |
---|---|
description |
النوع:
string هذه هي النسخة غير المنسَّقة من طلب البحث الذي تقترحه خدمة "الأماكن". |
matched_substrings |
النوع:
Array<PredictionSubstring> مجموعة من السلسلة الفرعية في وصف المكان التي تتطابق مع العناصر في إدخال المستخدم، وهي مناسبة للاستخدام في تمييز هذه السلسلة الفرعية يتم تحديد كل سلسلة فرعية من خلال إزاحة وطول يتم التعبير عنهما بأحرف Unicode. |
place_id |
النوع:
string معرّف مكان يمكن استخدامه لاسترداد تفاصيل عن هذا المكان باستخدام خدمة تفاصيل الأماكن (راجِع PlacesService.getDetails ). |
structured_formatting |
النوع:
StructuredFormatting معلومات منظَّمة عن وصف المكان، مقسّمة إلى نص رئيسي ونص ثانوي، بما في ذلك صفيف من السلسلة الفرعية المطابقة من إدخال الإكمال التلقائي، ويتم تحديده من خلال إزاحة وطول، ويتم التعبير عنه بأحرف Unicode. |
terms |
النوع:
Array<PredictionTerm> معلومات عن العبارات الفردية في الوصف أعلاه، من الأكثر إلى الأقل تحديدًا على سبيل المثال، "Taco Bell" و"Willitis" و "CA". |
types |
النوع:
Array<string> مصفوفة من الأنواع التي ينتمي إليها التوقّع، على سبيل المثال 'establishment' أو 'geocode' |
distance_meters optional |
النوع:
number optional المسافة بالمتر بين المكان و AutocompletionRequest.origin |
واجهة QueryAutocompletePrediction
google.maps.places.QueryAutocompletePrediction
واجهة
تمثّل عبارة بحث مقترَحة واحدة من ميزة "الإكمال التلقائي" لطلبات البحث.
الخصائص | |
---|---|
description |
النوع:
string هذه هي النسخة غير المنسَّقة من طلب البحث الذي تقترحه خدمة "الأماكن". |
matched_substrings |
النوع:
Array<PredictionSubstring> مجموعة من السلسلة الفرعية في وصف المكان التي تتطابق مع العناصر في إدخال المستخدم، وهي مناسبة للاستخدام في تمييز هذه السلسلة الفرعية يتم تحديد كل سلسلة فرعية من خلال إزاحة وطول يتم التعبير عنهما بأحرف Unicode. |
terms |
النوع:
Array<PredictionTerm> معلومات عن المصطلحات الفردية الواردة في الوصف أعلاه تظهر العبارات الفئوية أولاً (مثل "مطعم"). تظهر عبارات العناوين من الأكثر إلى الأقل تحديدًا. على سبيل المثال، "القاهرة" و "EG". |
place_id optional |
النوع:
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
واجهة
يحتوي على معلومات منظَّمة عن وصف المكان، مقسّمة إلى نص رئيسي ونص ثانوي، بما في ذلك صفيف من السلسلة الفرعية المطابقة من إدخال الإكمال التلقائي، ويتم تحديده من خلال إزاحة وطول يتم التعبير عنهما بأحرف Unicode.
الخصائص | |
---|---|
main_text |
النوع:
string هذا هو الجزء الرئيسي من النص في الوصف غير المنسَّق للمكان الذي تقترحه خدمة "الأماكن". عادةً ما يكون اسم المكان. |
main_text_matched_substrings |
النوع:
Array<PredictionSubstring> مجموعة من السلسلة الفرعية في النص الرئيسي التي تتطابق مع العناصر في إدخال المستخدم، وهي مناسبة للاستخدام في تمييز هذه السلسلة الفرعية يتم تحديد كل سلسلة فرعية من خلال إزاحة وطول يتم التعبير عنهما بأحرف Unicode. |
secondary_text |
النوع:
string هذا هو الجزء الثانوي من النص في الوصف غير المنسَّق للمكان الذي تقترحه خدمة "الأماكن". عادةً ما يكون الموقع الجغرافي للمكان. |