البحث عن أماكن بالقرب من المواقع الجغرافية
طلب HTTP
POST https://places.googleapis.com/v1/places:searchNearby
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "languageCode": string, "regionCode": string, "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ], "maxResultCount": integer, "locationRestriction": { object ( |
الحقول | |
---|---|
language |
سيتم عرض تفاصيل المكان باللغة المفضّلة في حال توفّرها. إذا لم يتم تحديد رمز اللغة أو لم يتم التعرّف عليه، قد يتم عرض تفاصيل المكان بأي لغة، مع تفضيل اللغة الإنجليزية إذا كانت هذه التفاصيل متوفّرة. القائمة الحالية للّغات المتاحة: https://developers.google.com/maps/faq#languagesupport. |
region |
رمز البلد أو المنطقة بترميز Unicode (CLDR) للموقع الجغرافي الذي يتم إرسال الطلب منه تُستخدَم هذه المَعلمة لعرض تفاصيل المكان، مثل اسم المكان الخاص بالمنطقة، إن توفّر. يمكن أن تؤثّر المَعلمة في النتائج استنادًا إلى القانون الساري. لمزيد من المعلومات، يُرجى الاطّلاع على https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. يُرجى العِلم أنّ رموز المناطق المكونة من 3 أرقام غير متاحة حاليًا. |
included |
نوع المكان المُدرَج (مثل "مطعم" أو "محطة_بنزين") من https://developers.google.com/maps/documentation/places/web-service/place-types يمكن تحديد ما يصل إلى 50 نوعًا من الجدول "أ". إذا كانت هناك أيّ أنواع متعارضة، أيّ نوع يظهر في كلّ من includedTypes وexcludedTypes، يتم عرض خطأ INVALID_ARGUMENT. إذا تم تحديد نوع مكان مع قيود متعددة على النوع، يتم عرض الأماكن التي تستوفي جميع القيود فقط. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, تقدّم الأماكن المعروضة خدمات ذات صلة "بالمطعم" ولكنّها لا تعمل في المقام الأول كمطاعم. |
excluded |
نوع المكان المستبعَد (مثل "مطعم" أو "محطة_غاز") من https://developers.google.com/maps/documentation/places/web-service/place-types يمكن تحديد ما يصل إلى 50 نوعًا من الجدول "أ". إذا قدّم العميل كلاً من الأنواع المضمّنة (مثل مطعم) والأنواع المستبعَدة (مثل مقهى)، يجب أن يتضمّن الردّ الأماكن التي تُعدّ مطعمًا ولكن ليس مقهى. يتضمّن الردّ أماكن تتطابق مع نوع واحد على الأقل من الأنواع المضمّنة ولا تتطابق مع أي من الأنواع المستبعَدة. إذا كانت هناك أيّ أنواع متعارضة، أيّ نوع يظهر في كلّ من includedTypes وexcludedTypes، يتم عرض خطأ INVALID_ARGUMENT. إذا تم تحديد نوع مكان مع قيود متعددة على النوع، يتم عرض الأماكن التي تستوفي جميع القيود فقط. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, تقدّم الأماكن المعروضة خدمات ذات صلة "بالمطعم" ولكنّها لا تعمل في المقام الأول كمطاعم. |
included |
يجب تضمين نوع المكان الأساسي (مثل "مطعم" أو "محطة_غاز") من https://developers.google.com/maps/documentation/places/web-service/place-types. لا يمكن أن يتضمّن المكان سوى نوع أساسي واحد من جدول الأنواع المتوافقة المرتبط به. يمكن تحديد ما يصل إلى 50 نوعًا من الجدول "أ". إذا كانت هناك أيّ أنواع أساسية متعارضة، أيّ نوع يظهر في كلّ من includedPrimaryTypes وexcludedPrimaryTypes، يتم عرض خطأ INVALID_ARGUMENT. إذا تم تحديد نوع مكان مع قيود متعددة على النوع، يتم عرض الأماكن التي تستوفي جميع القيود فقط. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, تقدّم الأماكن المعروضة خدمات ذات صلة "بالمطعم" ولكنّها لا تعمل في المقام الأول كمطاعم. |
excluded |
تم استبعاد نوع المكان الأساسي (مثل "مطعم" أو "محطة_غاز") من https://developers.google.com/maps/documentation/places/web-service/place-types. يمكن تحديد ما يصل إلى 50 نوعًا من الجدول "أ". إذا كانت هناك أيّ أنواع أساسية متعارضة، أيّ نوع يظهر في كلّ من includedPrimaryTypes وexcludedPrimaryTypes، يتم عرض خطأ INVALID_ARGUMENT. إذا تم تحديد نوع مكان مع قيود متعددة على النوع، يتم عرض الأماكن التي تستوفي جميع القيود فقط. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, تقدّم الأماكن المعروضة خدمات ذات صلة "بالمطعم" ولكنّها لا تعمل في المقام الأول كمطاعم. |
max |
تعرض هذه المَعلمة أكبر عدد ممكن من النتائج. يجب أن تتراوح القيمة بين 1 و20 (القيمة التلقائية)، بما في ذلك الرقمان. إذا لم يتم ضبط الرقم، يتم الرجوع إلى الحد الأقصى. إذا تم ضبط الرقم على قيمة سالبة أو تجاوز الحد الأقصى، يتم عرض الخطأ INVALID_ARGUMENT. |
location |
مطلوب. المنطقة التي تريد البحث فيها. |
rank |
كيفية ترتيب النتائج في الردّ |
routing |
اختيارية: المَعلمات التي تؤثّر في التوجيه إلى نتائج البحث |
نص الاستجابة
نموذج الاستجابة لميزة "البحث عن مكان قريب"
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "places": [ { object ( |
الحقول | |
---|---|
places[] |
قائمة بالأماكن التي تستوفي متطلبات المستخدم، مثل أنواع الأماكن وعدد الأماكن والقيود المتعلّقة بالموقع الجغرافي |
routing |
قائمة بملخصات التوجيه التي يرتبط فيها كل إدخال بالمكان المقابل له في الفهرس نفسه في حقل |
LocationRestriction
المنطقة التي تريد البحث فيها.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الربط يمكن أن يكون |
|
circle |
دائرة محدّدة بنقطة المركز ونصف القطر |
RankPreference
كيفية ترتيب النتائج في الردّ
عمليات التعداد | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
لم يتم ضبط قيمة RankPreference. سيتم استخدام ترتيب حسب مدى الرواج تلقائيًا. |
DISTANCE |
ترتيب النتائج حسب المسافة |
POPULARITY |
ترتيب النتائج حسب مدى الرواج |