فئة Geocoder
google.maps.Geocoder
صف
مكتبة "geocoding"
خدمة للتحويل بين عنوان وLatLng.
const {Geocoder} = await google.maps.importLibrary("geocoding");
الشركة المصنِّعة | |
|---|---|
Geocoder |
Geocoder()المَعلمات: لا تتوفّر أي مَعلمات
تنشئ مثيلاً جديدًا من Geocoder يرسل طلبات الترميز الجغرافي إلى خوادم Google. |
الطُرق | |
|---|---|
geocode |
geocode(request[, callback])المَعلمات:
القيمة المعروضة:
Promise<GeocoderResponse>ترميز طلب جغرافيًا |
واجهة GeocoderRequest
واجهة
google.maps.GeocoderRequest
يشير هذا الحقل إلى مواصفات طلب الترميز الجغرافي الذي سيتم إرساله إلى Geocoder.
الخصائص | |
|---|---|
address
اختياري |
النوع:
string optionalالعنوان المطلوب ترميزه جغرافيًا يجب تقديم سمة واحدة فقط من السمات التالية: address وlocation وplaceId. |
bounds
اختياري |
النوع:
LatLngBounds|LatLngBoundsLiteral optionalLatLngBounds المطلوب البحث فيه اختيارية: |
componentRestrictions
اختياري |
النوع:
GeocoderComponentRestrictions optionalتُستخدَم المكوّنات لحصر النتائج في منطقة معيّنة. يتكوّن الفلتر من عنصر واحد أو أكثر من العناصر التالية: route وlocality وadministrativeArea وpostalCode وcountry. سيتم عرض النتائج التي تطابق جميع الفلاتر فقط. تتيح قيم الفلاتر استخدام الطرق نفسها لتصحيح الأخطاء الإملائية والمطابقة الجزئية مثل طلبات الترميز الجغرافي الأخرى. اختيارية: |
اختياري |
النوع:
Array<ExtraGeocodeComputation> optionalقائمة بالعمليات الحسابية الإضافية التي يمكن استخدامها لإكمال الطلب ملاحظة: قد تؤدي هذه العمليات الحسابية الإضافية إلى عرض حقول إضافية في الردّ. |
fulfillOnZeroResults
اختياري |
النوع:
boolean optionalيتم تنفيذ الوعد في حالة ZERO_RESULT في الردّ. قد يكون ذلك مطلوبًا لأنّه حتى في حال عدم توفّر نتائج ترميز جغرافي، قد يتم عرض حقول إضافية على مستوى الاستجابة. |
language
اختياري |
النوع:
string optionalمعرّف اللغة التي يجب عرض النتائج بها، إن أمكن ذلك. اطّلِع على قائمة اللغات المتاحة. |
location
اختياري |
النوع:
LatLng|LatLngLiteral optionalLatLng (أو LatLngLiteral) المطلوب البحث عنه تنفّذ أداة الترميز الجغرافي عملية عكس الترميز الجغرافي. لمزيد من المعلومات، يُرجى الاطّلاع على عكس الترميز الجغرافي. يجب تقديم سمة واحدة فقط من السمات التالية: address وlocation وplaceId. |
placeId
اختياري |
النوع:
string optionalرقم تعريف المكان المرتبط بالموقع الجغرافي تحدِّد أرقام تعريف الأماكن مكانًا بشكلٍ فريد في قاعدة بيانات "أماكن Google" وعلى "خرائط Google". مزيد من المعلومات عن أرقام تعريف الأماكن في دليل مطوّري Places API تنفّذ أداة الترميز الجغرافي عملية عكس الترميز الجغرافي. لمزيد من المعلومات، يُرجى الاطّلاع على عكس الترميز الجغرافي. يجب تقديم سمة واحدة فقط من السمات التالية: address وlocation وplaceId. |
region
اختياري |
النوع:
string optionalرمز البلد المستخدَم لتوجيه البحث، ويتم تحديده كعلامة فرعية لمنطقة Unicode مكوّنة من حرفَين (غير رقمي) أو معرّف CLDR. اختيارية: يُرجى الاطّلاع على تفاصيل تغطية "منصة خرائط Google" لمعرفة المناطق المعتمدة. |
واجهة GeocoderComponentRestrictions
واجهة
google.maps.GeocoderComponentRestrictions
يمثّل GeocoderComponentRestrictions مجموعة من الفلاتر التي تؤدي إلى منطقة معيّنة. لمعرفة التفاصيل حول آلية عمل ذلك، يُرجى الاطّلاع على فلترة مكوّنات الترميز الجغرافي.
الخصائص | |
|---|---|
administrativeArea
اختياري |
النوع:
string optionalيطابق جميع administrative_area levels. اختيارية: |
country
اختياري |
النوع:
string optionalتطابق اسم بلد أو رمز بلد مكوّن من حرفَين وفقًا لمعيار ISO 3166-1. اختيارية: |
locality
اختياري |
النوع:
string optionalتتم المطابقة مع النوعَين locality وsublocality. اختيارية: |
postalCode
اختياري |
النوع:
string optionalتتطابق مع postal_code وpostal_code_prefix. اختيارية: |
route
اختياري |
النوع:
string optionalتطابق الاسم الطويل أو الاسم المختصر لـ route. اختيارية: |
ثوابت ExtraGeocodeComputation
google.maps.ExtraGeocodeComputation
ثوابت
مكتبة "geocoding"
عمليات حسابية إضافية يتم إجراؤها أثناء إكمال طلب الترميز الجغرافي
ويمكن أيضًا استخدام هذه الثوابت كسلاسل. في TypeScript، يتم تحديد سلاسل القيم الثابتة حسب النوع ExtraGeocodeComputationString.
const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");
الثوابت | |
|---|---|
ADDRESS_DESCRIPTORS |
أنشِئ وصفًا للعنوان. |
ثوابت GeocoderStatus
google.maps.GeocoderStatus
ثوابت
مكتبة "geocoding"
الحالة التي تعرضها السمة Geocoder عند اكتمال طلب إلى geocode(). حدِّد هذه القيم حسب القيمة أو باستخدام اسم الثابت. على سبيل المثال، 'OK' أو google.maps.GeocoderStatus.OK.
ويمكن أيضًا استخدام هذه الثوابت كسلاسل. في TypeScript، يتم تحديد سلاسل القيم الثابتة حسب النوع GeocoderStatusString.
const {GeocoderStatus} = await google.maps.importLibrary("geocoding");
الثوابت | |
|---|---|
ERROR |
حدثت مشكلة أثناء الاتصال بخوادم Google. |
INVALID_REQUEST |
هذا الـ GeocoderRequest غير صالح. |
OK |
يحتوي الردّ على GeocoderResponse صالح. |
OVER_QUERY_LIMIT |
تجاوزت صفحة الويب الحدّ الأقصى لعدد الطلبات في فترة زمنية قصيرة جدًا. |
REQUEST_DENIED |
لا يُسمح لصفحة الويب باستخدام أداة الترميز الجغرافي. |
UNKNOWN_ERROR |
تعذّرت معالجة طلب الترميز الجغرافي بسبب خطأ في الخادم. قد ينجح الطلب إذا حاولت مرة أخرى. |
ZERO_RESULTS |
لم يتم العثور على أي نتيجة لـ GeocoderRequest. |
واجهة GeocoderResponse
واجهة
google.maps.GeocoderResponse
استجابة Geocoder التي يعرضها Geocoder والتي تحتوي على قائمة GeocoderResult.
الخصائص | |
|---|---|
results |
النوع:
Array<GeocoderResult>قائمة GeocoderResult. |
اختياري |
النوع:
AddressDescriptor optionalوصف نسبي لموقع جغرافي تتضمّن مجموعة مرتبة من المعالم القريبة والمناطق التي تحتوي على الموقع الجغرافي المستهدف. ولا تتم تعبئته إلا لطلبات عكس الترميز الجغرافي وعند تفعيل ExtraGeocodeComputation.ADDRESS_DESCRIPTORS فقط. |
plus_code
اختياري |
النوع:
PlacePlusCode optionalرمز Plus Code المرتبط بالموقع الجغرافي |
واجهة GeocoderResult
واجهة
google.maps.GeocoderResult
نتيجة واحدة لأداة الترميز الجغرافي تم استردادها من خادم الترميز الجغرافي قد يعرض طلب الترميز الجغرافي عناصر نتائج متعدّدة. يُرجى العِلم أنّه على الرغم من أنّ هذه النتيجة "تشبه JSON"، فهي ليست JSON بشكل صارم، لأنّها تتضمّن بشكل غير مباشر كائن LatLng.
الخصائص | |
|---|---|
address_components |
النوع:
Array<GeocoderAddressComponent>مصفوفة من GeocoderAddressComponent |
formatted_address |
النوع:
stringسلسلة تحتوي على عنوان هذا الموقع الجغرافي ويمكن لشخص عادي قراءتها |
geometry |
النوع:
GeocoderGeometryعنصر GeocoderGeometry |
place_id |
النوع:
stringرقم تعريف المكان المرتبط بالموقع الجغرافي تحدِّد أرقام تعريف الأماكن مكانًا بشكلٍ فريد في قاعدة بيانات "أماكن Google" وعلى "خرائط Google". مزيد من المعلومات عن أرقام تعريف الأماكن في دليل مطوّري Places API |
types |
النوع:
Array<string>مصفوفة من السلاسل التي تشير إلى نوع عنصر الترميز الجغرافي الذي تم عرضه. للاطّلاع على قائمة بالسلاسل المحتملة، يُرجى الرجوع إلى قسم أنواع مكوّنات العناوين في دليل المطوّر. |
اختياري |
النوع:
AddressDescriptor optionalوصف نسبي للموقع الجغرافي المرتبط بهذا الرمز الجغرافي تتضمّن مجموعة مرتبة من المعالم القريبة والمناطق التي تحتوي على الموقع الجغرافي المستهدف. لن تتم تعبئة هذا الحقل إلا لطلبات الترميز الجغرافي الأمامي والبحث عن رقم تعريف المكان، وفقط عندما يكون ExtraGeocodeComputation.ADDRESS_DESCRIPTORS مفعَّلاً، وفقط لأماكن معيّنة تم ترجمتها. |
partial_match
اختياري |
النوع:
boolean optionalما إذا كانت أداة الترميز الجغرافي لم تعرض مطابقة تامة للطلب الأصلي، على الرغم من أنّها تمكّنت من مطابقة جزء من العنوان المطلوب. في حال المطابقة التامة، ستكون القيمة undefined. |
plus_code
اختياري |
النوع:
PlacePlusCode optionalرمز Plus Codes المرتبط بالموقع الجغرافي |
postcode_localities
اختياري |
النوع:
Array<string> optionalمصفوفة من السلاسل التي تشير إلى جميع المناطق المشمولة في رمز بريدي معيّن لا تظهر هذه السمة إلا عندما تكون النتيجة رمزًا بريديًا يحتوي على عدة مناطق محلية. |
واجهة AddressDescriptor
واجهة
google.maps.AddressDescriptor
وصف نسبي لموقع جغرافي تتضمّن مجموعة مرتبة من المعالم القريبة والمناطق التي تحتوي على الموقع الجغرافي المستهدف.
الخصائص | |
|---|---|
areas |
قائمة مرتبة بالمناطق المجاورة أو التي تحتوي على الموقع الجغرافي يتم ترتيب المناطق الأكثر فائدة (التي يمكن التعرّف عليها والدقيقة) أولاً. |
landmarks |
قائمة مرتّبة بالمعالم القريبة يتم ترتيب المعالم الأكثر فائدة (المعروفة والقريبة) أولاً. |
واجهة GeocoderAddressComponent
واجهة
google.maps.GeocoderAddressComponent
مكوّن عنوان واحد ضمن GeocoderResult. قد يتألف العنوان الكامل من عدة مكوّنات.
الخصائص | |
|---|---|
long_name |
النوع:
stringالنص الكامل لمكوّن العنوان |
short_name |
النوع:
stringالنص المختصر لمكوّن العنوان المحدّد |
types |
النوع:
Array<string>مصفوفة من السلاسل تشير إلى نوع مكوّن العنوان هذا يمكنك الاطّلاع على قائمة بالأنواع الصالحة هنا |
واجهة GeocoderGeometry
واجهة
google.maps.GeocoderGeometry
معلومات هندسية حول GeocoderResult
الخصائص | |
|---|---|
location |
النوع:
LatLngإحداثيات خطوط العرض/الطول لهذه النتيجة |
location_type |
النوع:
GeocoderLocationTypeنوع الموقع الجغرافي الذي تم عرضه في location |
viewport |
النوع:
LatLngBoundsحدود إطار العرض المقترَح لعرض GeocoderResult هذا |
bounds
اختياري |
النوع:
LatLngBounds optionalالحدود الدقيقة لـ GeocoderResult، إن وُجدت |
ثوابت GeocoderLocationType
google.maps.GeocoderLocationType
ثوابت
مكتبة "geocoding"
يصف نوع الموقع الجغرافي الذي تم عرضه من ترميز جغرافي. حدِّد هذه القيم حسب القيمة أو باستخدام اسم الثابت. على سبيل المثال، 'ROOFTOP' أو google.maps.GeocoderLocationType.ROOFTOP.
ويمكن أيضًا استخدام هذه الثوابت كسلاسل. في TypeScript، يتم تحديد سلاسل القيم الثابتة حسب النوع GeocoderLocationTypeString.
const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");
الثوابت | |
|---|---|
APPROXIMATE |
النتيجة المعروضة تقريبية. |
GEOMETRIC_CENTER |
النتيجة المعروضة هي المركز الهندسي لنتيجة مثل خط (مثل شارع) أو مضلّع (منطقة). |
RANGE_INTERPOLATED |
تعكس النتيجة المعروضة قيمة تقريبية (عادةً على طريق) يتم استكمالها بين نقطتَين دقيقتَين (مثل التقاطعات). يتم عرض النتائج المُستقرأة بشكل عام عندما لا تتوفر الرموز الجغرافية للمباني لعنوان شارع. |
ROOFTOP |
تعكس النتيجة المعروضة رمزًا جغرافيًا دقيقًا. |
واجهة Landmark
واجهة
google.maps.Landmark
مكان يمثّل نقطة مرجعية للعنوان
الخصائص | |
|---|---|
display_name |
النوع:
stringاسم المَعلم |
display_name_language_code |
النوع:
stringلغة اسم المَعلم |
place_id |
النوع:
stringرقم تعريف المكان الخاص بالمؤسسة الأساسية التي تمثّل المعلم يمكن استخدامها للحصول على مزيد من المعلومات عن المَعلم من خلال "تفاصيل المكان" أو "البحث عن رقم تعريف المكان". |
spatial_relationship |
النوع:
SpatialRelationshipتحدّد العلاقة المكانية بين الموقع الجغرافي المستهدف والمعلم. |
straight_line_distance_meters |
النوع:
numberالمسافة المستقيمة بين الموقع الجغرافي المستهدف والمعلم |
types |
النوع:
Array<string>قيمة واحدة أو أكثر تشير إلى نوع النتيجة المعروضة. يُرجى الاطّلاع على الأنواع لمزيد من التفاصيل. |
travel_distance_meters
اختياري |
النوع:
number optionalتمثّل هذه السمة مسافة السفر على طول شبكة الطرق بين الموقع الجغرافي المستهدَف والمعلم. يمكن أن يكون هذا الحقل فارغًا إذا كان المعلم غير متصل بجزء من شبكة الطرق الأقرب إلى الهدف أو إذا لم يكن الموقع الجغرافي المستهدف ضمن شبكة الطرق. |
واجهة Area
واجهة
google.maps.Area
مكان يمثّل منطقة صغيرة، مثل حي أو منطقة فرعية أو مجمّع كبير يحتوي على الموقع الجغرافي المستهدف.
الخصائص | |
|---|---|
containment |
النوع:
Containmentيحدّد العلاقة المكانية بين الموقع الجغرافي المستهدف والمنطقة. |
display_name |
النوع:
stringاسم المنطقة |
display_name_language_code |
النوع:
stringلغة اسم المنطقة |
place_id |
النوع:
stringرقم تعريف المكان للمنطقة الأساسية يمكن استخدامها للحصول على مزيد من المعلومات عن المنطقة من خلال "تفاصيل المكان" أو "البحث عن رقم تعريف المكان". |
ثوابت الاحتواء
google.maps.Containment
ثوابت
مكتبة "geocoding"
قائمة تعداد تمثّل العلاقة المكانية بين المنطقة والموقع الجغرافي المستهدَف.
ويمكن أيضًا استخدام هذه الثوابت كسلاسل. في TypeScript، يتم تحديد سلاسل القيم الثابتة حسب النوع ContainmentString.
const {Containment} = await google.maps.importLibrary("geocoding");
الثوابت | |
|---|---|
NEAR |
يقع الموقع الجغرافي المستهدف خارج المنطقة، ولكنه قريب منها. |
OUTSKIRTS |
يقع الموقع الجغرافي المستهدف ضمن منطقة المساحة، بالقرب من الحافة. |
WITHIN |
يقع الموقع الجغرافي المستهدَف ضمن المنطقة، بالقرب من المركز. |
ثوابت SpatialRelationship
google.maps.SpatialRelationship
ثوابت
مكتبة "geocoding"
قائمة تعداد تمثّل العلاقة في المساحة بين المَعلم والهدف
ويمكن أيضًا استخدام هذه الثوابت كسلاسل. في TypeScript، يتم تحديد سلاسل القيم الثابتة حسب النوع SpatialRelationshipString.
const {SpatialRelationship} = await google.maps.importLibrary("geocoding");
الثوابت | |
|---|---|
ACROSS_THE_ROAD |
يقع الهدف مباشرةً مقابل المعلم على الجانب الآخر من الطريق. |
AROUND_THE_CORNER |
ليس على المسار نفسه الذي يقع فيه المَعلم، ولكنّه على بُعد منعطف واحد. |
BEHIND |
قريب من مبنى المَعلم ولكن بعيد عن نقطة الوصول إليه |
BESIDE |
الهدف مجاور مباشرةً للمعلم. |
DOWN_THE_ROAD |
على المسار نفسه الذي يقع فيه المعلم، ولكن ليس بجانبه أو على الجانب الآخر منه. |
NEAR |
هذه هي العلاقة التلقائية في حال عدم انطباق أي من العلاقات المحدّدة أدناه. |
WITHIN |
يحتوي المعلم على شكل هندسي مكاني والهدف يقع ضمن حدوده. |