فئة AutocompleteService
class
google.maps.places.AutocompleteService
library "places"
تحتوي على طرق مرتبطة باسترداد عبارات البحث المقترَحة من خلال ميزة "الإكمال التلقائي".
const {AutocompleteService} = await google.maps.importLibrary("places");
الشركة المصنِّعة | |
|---|---|
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
اختياري |
النوع:
ComponentRestrictions optionalالقيود المفروضة على المكوّن تُستخدَم قيود المكوّنات لحصر التوقّعات على تلك الموجودة ضمن المكوّن الرئيسي. على سبيل المثال، البلد. |
language
اختياري |
النوع:
string optionalمعرّف اللغة التي يجب عرض النتائج بها، إن أمكن. قد يتم منح النتائج باللغة المحدّدة ترتيبًا أعلى، ولكن لا تقتصر الاقتراحات على هذه اللغة. اطّلِع على قائمة اللغات المتاحة. |
اختياري |
النوع:
LatLng optionalالموقع الجغرافي لانحياز التوقّعات ستكون التوقّعات منحازة إلى location وradius المحدّدَين. ويمكنك بدلاً من ذلك استخدام bounds. |
locationBias
اختياري |
النوع:
LocationBias optionalحدود مرنة أو تلميح لاستخدامه عند البحث عن أماكن |
locationRestriction
اختياري |
النوع:
LocationRestriction optionalالحدود التي تقيّد نتائج البحث |
offset
اختياري |
النوع:
number optionalموضع الحرف في عبارة الإدخال التي تستخدم الخدمة النص فيها لتقديم عبارات البحث المقترَحة (موضع المؤشر في حقل الإدخال). |
origin
اختياري |
النوع:
LatLng|LatLngLiteral optionalالموقع الجغرافي الذي يتم احتساب AutocompletePrediction.distance_meters منه |
اختياري |
النوع:
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 |
النوع:
Array<AutocompletePrediction>قائمة AutocompletePrediction. |
واجهة QueryAutocompletionRequest
واجهة
google.maps.places.QueryAutocompletionRequest
طلب QueryAutocompletion لإرساله إلى QueryAutocompleteService.
الخصائص | |
|---|---|
input |
النوع:
stringسلسلة الإدخال التي أدخلها المستخدم |
bounds
اختياري |
النوع:
LatLngBounds|LatLngBoundsLiteral optionalحدود انحياز التوقّعات ستكون التوقعات منحازة إلى bounds المحدّد، ولكن لن تقتصر عليه. سيتم تجاهل كل من location وradius في حال ضبط bounds. |
location
اختياري |
النوع:
LatLng optionalالموقع الجغرافي لانحياز التوقّعات ستكون التوقّعات منحازة إلى location وradius المحدّدَين. ويمكنك بدلاً من ذلك استخدام bounds. |
offset
اختياري |
النوع:
number optionalموضع الحرف في عبارة الإدخال التي تستخدم الخدمة النص فيها لتقديم عبارات البحث المقترَحة (موضع المؤشر في حقل الإدخال). |
radius
اختياري |
النوع:
number optionalنصف قطر المنطقة المستخدَمة لانحياز التوقّعات. يتم تحديد السمة radius بالأمتار، ويجب أن تكون مصحوبة دائمًا بالسمة location. ويمكنك بدلاً من ذلك استخدام bounds. |
ComponentRestrictions interface
واجهة
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 |
النوع:
Array<PredictionSubstring>مجموعة من السلاسل الفرعية في وصف المكان تتطابق مع العناصر في إدخال المستخدم، وهي مناسبة للاستخدام في تمييز تلك السلاسل الفرعية. يتم تحديد كل سلسلة فرعية من خلال إزاحة وطول، ويتم التعبير عنها بأحرف يونيكود. |
place_id |
النوع:
stringرقم تعريف المكان الذي يمكن استخدامه لاسترداد تفاصيل حول هذا المكان باستخدام خدمة تفاصيل المكان (يُرجى الاطّلاع على PlacesService.getDetails). |
structured_formatting |
النوع:
StructuredFormattingمعلومات منظَّمة حول وصف المكان، مقسَّمة إلى نص رئيسي ونص ثانوي، بما في ذلك مصفوفة من السلاسل الفرعية المطابقة من إدخال الإكمال التلقائي، والتي يتم تحديدها من خلال الإزاحة والطول، ويتم التعبير عنها بأحرف يونيكود. |
terms |
النوع:
Array<PredictionTerm>معلومات عن المصطلحات الفردية في الوصف أعلاه، من الأكثر إلى الأقل تحديدًا. على سبيل المثال، "Taco Bell" و"Willitis" و "CA". |
types |
النوع:
Array<string>مصفوفة من الأنواع التي تنتمي إليها عبارة البحث المقترَحة، مثل 'establishment' أو 'geocode'. |
distance_meters
اختياري |
النوع:
number optionalالمسافة بالأمتار بين المكان و AutocompletionRequest.origin |
واجهة QueryAutocompletePrediction
واجهة
google.maps.places.QueryAutocompletePrediction
تمثّل عبارة بحث مقترَحة واحدة من خلال ميزة "الإكمال التلقائي لطلب البحث".
الخصائص | |
|---|---|
description |
النوع:
stringهذه هي النسخة غير المنسَّقة من طلب البحث الذي اقترحته خدمة "الأماكن". |
matched_substrings |
النوع:
Array<PredictionSubstring>مجموعة من السلاسل الفرعية في وصف المكان تتطابق مع العناصر في إدخال المستخدم، وهي مناسبة للاستخدام في تمييز تلك السلاسل الفرعية. يتم تحديد كل سلسلة فرعية من خلال إزاحة وطول، ويتم التعبير عنها بأحرف يونيكود. |
terms |
النوع:
Array<PredictionTerm>معلومات حول المصطلحات الفردية في الوصف أعلاه تأتي العبارات الفئوية أولاً (على سبيل المثال، "مطعم"). تظهر عبارات العنوان من الأكثر إلى الأقل تحديدًا. على سبيل المثال، "الرياض" و "المنطقة الوسطى". |
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 |
النوع:
Array<PredictionSubstring>مجموعة من السلاسل الفرعية في النص الرئيسي تتطابق مع العناصر في إدخال المستخدم، وهي مناسبة للاستخدام في تمييز تلك السلاسل الفرعية. يتم تحديد كل سلسلة فرعية من خلال إزاحة وطول، ويتم التعبير عنها بأحرف يونيكود. |
secondary_text |
النوع:
stringهذا هو الجزء النصي الثانوي من الوصف غير المنسَّق للمكان الذي تقترحه خدمة "الأماكن". عادةً ما يكون الموقع الجغرافي للمكان. |