Places Autocomplete Service

فئة AutocompleteService

صف واحد (google.maps.places.AutocompleteService)

يحتوي على طرق ذات صلة باسترداد عبارات البحث المقترحة من خلال ميزة "الإكمال التلقائي".

يمكنك الوصول من خلال الاتصال بـ const {AutocompleteService} = await google.maps.importLibrary("places"). اطّلِع على المكتبات في واجهة برمجة تطبيقات JavaScript للخرائط.
AutocompleteService
AutocompleteService()
المعلّمات: بدون
تنشئ هذه الوحدة نسخة جديدة من AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
المعلّمات: 
قيمة العرض:  Promise<AutocompleteResponse>
استرداد طلبات الإكمال التلقائي استنادًا إلى طلب الإكمال التلقائي المقدَّم
getQueryPredictions
getQueryPredictions(request, callback)
المعلّمات: 
  • request:  QueryAutocompletionRequest طلب الإكمال التلقائي لطلب البحث
  • callback:  function(Array<QueryAutocompletePrediction> optional, PlacesServiceStatus): void معاودة الاتصال تقبل صفيفًا من عبارات البحث المقترحة من خلال الإكمال التلقائي للمعلِن وقيمة PlacesServiceStatus كوسيطة
قيمة العرض: بدون
لاسترداد عبارات البحث المقترحة من خلال ميزة "الإكمال التلقائي" استنادًا إلى طلب الإكمال التلقائي لطلب البحث المقدّم

واجهة AutoCompleteRequest

واجهة google.maps.places.AutocompletionRequest

سيتم إرسال طلب الإكمال التلقائي إلى AutocompleteService.getPlacePredictions.
input
النوع:  string
أدخل المستخدم سلسلة إدخال.
bounds optional
النوع:  LatLngBounds|LatLngBoundsLiteral optional
حدود لتوقّع التوقّعات. سيتم انحياز التوقعات - على سبيل المثال لا الحصر - للسمة bounds المحددة. سيتم تجاهل كل من location وradius في حال ضبط bounds.
componentRestrictions optional
النوع:  ComponentRestrictions optional
قيود المكوّنات يتم استخدام قيود المكوّنات لحصر عبارات البحث المقترحة بعبارات البحث داخل المكوّن الرئيسي فقط. على سبيل المثال، البلد.
language optional
النوع:  string optional
معرّف اللغة الذي يجب عرض النتائج عليه، إن أمكن. قد يتم منح النتائج باللغة المحددة ترتيبًا أعلى، لكن الاقتراحات لا تقتصر على هذه اللغة. اطّلع على قائمة اللغات المتاحة.
location 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 منه.
radius optional
النوع:  number optional
نطاق المنطقة المستخدمة لانحياز التوقع. يتم تحديد السمة radius بالمتر ويجب أن تكون مصحوبةً دائمًا بسمة location. بدلاً من ذلك، يمكن استخدام bounds.
region optional
النوع:  string optional
رمز منطقة يُستخدَم لتنسيق النتائج وفلترة النتائج. ولا يؤدي ذلك إلى حصر الاقتراحات بهذا البلد. يقبل رمز المنطقة قيمة تتألف من حرفين في ccTLD ("نطاق المستوى الأعلى"). وتتطابق معظم رموز ccTLD مع رموز ISO 3166-1، مع بعض الاستثناءات البارزة. على سبيل المثال، نطاق المستوى الأعلى الذي يتم ترميزه حسب البلد (ccTLD) في المملكة المتحدة هو "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
قائمة AutocompletePrediction.

واجهة QueryAutoCompleteRequest

واجهة google.maps.places.QueryAutocompletionRequest

سيتم إرسال طلب إكمال البحث التلقائي إلى 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.

AutocompleteSessionToken

صف واحد (google.maps.places.AutocompleteSessionToken)

يمثّل رمزًا مميزًا للجلسة يُستخدَم في تتبُّع جلسة إكمال تلقائي، ويمكن أن يكون سلسلة من مكالمات AutocompleteService.getPlacePredictions متبوعة بمكالمة واحدة على PlacesService.getDetails.

يمكنك الوصول من خلال الاتصال بـ const {AutocompleteSessionToken} = await google.maps.importLibrary("places"). اطّلِع على المكتبات في واجهة برمجة تطبيقات JavaScript للخرائط.
AutocompleteSessionToken
AutocompleteSessionToken()
المعلّمات: بدون
تنشئ هذه السياسة نسخة جديدة من AutocompleteSessionToken.

واجهة componentRestrictions

واجهة google.maps.places.ComponentRestrictions

تحدِّد هذه السياسة قيود المكوّنات التي يمكن استخدامها مع خدمة الإكمال التلقائي.
country optional
النوع:  string|Array<string> optional
لحصر عبارات البحث المقترحة بالبلد المحدّد (رمز البلد ISO 3166-1 Alpha-2، غير حساس لحالة الأحرف). على سبيل المثال، 'us' أو 'br' أو 'au'. يمكنك توفير سلسلة واحدة أو مصفوفة من ما يصل إلى خمس سلاسل لرموز البلدان.

واجهة توقّع الإكمال التلقائي

واجهة google.maps.places.AutocompletePrediction

تمثل توقّعًا واحدًا للإكمال التلقائي.
description
النوع:  string
هذه هي النسخة غير المنسّقة لطلب البحث الذي اقترحته خدمة "الأماكن".
matched_substrings
النوع:  Array<PredictionSubstring>
مجموعة من السلاسل الفرعية في وصف المكان تطابق العناصر في إدخال المستخدم، ومناسبة للاستخدام في تمييز هذه السلاسل الفرعية. ويتم تحديد كل سلسلة فرعية بإزاحة وطول، معبرًا عنهما بأحرف يونيكود.
place_id
النوع:  string
معرّف مكان يمكن استخدامه لاسترداد تفاصيل هذا المكان باستخدام خدمة تفاصيل المكان (راجع PlacesService.getDetails).
structured_formatting
النوع:  StructuredFormatting
معلومات منظَّمة عن وصف المكان، مقسّمة إلى نص رئيسي ونص ثانوي، بما في ذلك مصفوفة من السلاسل الفرعية المطابقة من إدخال الإكمال التلقائي، والتي يتم تحديدها من خلال معادلة وطول، معبرًا عنها بأحرف يونيكود.
terms
النوع:  Array<PredictionTerm>
تشير هذه السمة إلى معلومات حول العبارات الفردية في الوصف أعلاه، بدءًا من العبارات الأكثر تحديدًا وصولاً إلى الأوصاف المحدّدة. على سبيل المثال، "Taco Bell", " Willions" و "CA".
types
النوع:  Array<string>
مصفوفة من الأنواع التي ينتمي إليها التوقّع، مثل 'establishment' أو 'geocode'.
distance_meters optional
النوع:  number optional
المسافة بمتر المكان من AutocompletionRequest.origin.

واجهة توقّع البحث التلقائي

واجهة google.maps.places.QueryAutocompletePrediction

يمثل توقّعًا واحدًا للإكمال التلقائي لطلب البحث.
description
النوع:  string
هذه هي النسخة غير المنسّقة لطلب البحث الذي اقترحته خدمة "الأماكن".
matched_substrings
النوع:  Array<PredictionSubstring>
مجموعة من السلاسل الفرعية في وصف المكان تطابق العناصر في إدخال المستخدم، ومناسبة للاستخدام في تمييز هذه السلاسل الفرعية. ويتم تحديد كل سلسلة فرعية بإزاحة وطول، معبرًا عنهما بأحرف يونيكود.
terms
النوع:  Array<PredictionTerm>
معلومات عن العبارات الفردية في الوصف أعلاه. أمّا العبارات الفائقة، فتظهر أولاً (على سبيل المثال، "مطعم"). تظهر عبارات العنوان من الأكثر تحديدًا إلى الأقل تحديدًا. على سبيل المثال، "سان فرانسيسكو" و "كندا".
place_id optional
النوع:  string optional
متاح فقط إذا كانت عبارة البحث المقترحة من مكان معرّف مكان يمكن استخدامه لاسترداد تفاصيل هذا المكان باستخدام خدمة تفاصيل المكان (راجع PlacesService.getDetails).

واجهة توقّع عبارات

واجهة google.maps.places.PredictionTerm

يمثّل عبارة بحث مقترَحة.
offset
النوع:  number
الإزاحة بالأحرف يونيكود بداية هذه العبارة في وصف المكان
value
النوع:  string
قيمة هذه العبارة، على سبيل المثال، "Taco Bell".

واجهة PredictionSubstring

واجهة google.maps.places.PredictionSubstring

تمثل سلسلة فرعية للتوقع.
length
النوع:  number
طول السلسلة الفرعية.
offset
النوع:  number
الإزاحة لبداية السلسلة الفرعية داخل سلسلة الوصف.

واجهة FormatFormat

واجهة google.maps.places.StructuredFormatting

يحتوي على معلومات منظّمة حول وصف المكان، مقسم إلى نص رئيسي ونص ثانوي، بما في ذلك مصفوفة من سلاسل فرعية مطابقة من إدخال الإكمال التلقائي، والتي يتم تحديدها من خلال معادلة وطول، معبرًا عنها بأحرف يونيكود.
main_text
النوع:  string
هذا هو الجزء الرئيسي من الوصف غير المنسّق للمكان الذي تقترحه خدمة "الأماكن". عادةً ما يكون اسم المكان.
main_text_matched_substrings
النوع:  Array<PredictionSubstring>
مجموعة من السلاسل الفرعية في النص الرئيسي تتطابق مع العناصر الواردة في إدخال المستخدم، ويمكن استخدامها لإبراز هذه السلاسل الفرعية. ويتم تحديد كل سلسلة فرعية بإزاحة وطول، معبرًا عنهما بأحرف يونيكود.
secondary_text
النوع:  string
هذا هو الجزء الثانوي من الوصف غير المنسّق للمكان الذي تقترحه خدمة "الأماكن". عادةً ما يكون الموقع الجغرافي للمكان