Method: places.searchNearby

البحث عن أماكن بالقرب من مواقع جغرافية

طلب 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 (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  },
  "includeFutureOpeningBusinesses": boolean
}
الحقول
languageCode

string

سيتم عرض تفاصيل المكان باللغة المفضَّلة إذا كانت متاحة. إذا لم يتم تحديد رمز اللغة أو لم يتم التعرّف عليه، قد يتم عرض تفاصيل أي لغة، مع تفضيل اللغة الإنجليزية إذا كانت هذه التفاصيل متوفرة.

قائمة اللغات المتاحة حاليًا: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

رمز Unicode للبلد/المنطقة (CLDR) الخاص بالموقع الجغرافي الذي يأتي منه الطلب تُستخدَم هذه المَعلمة لعرض تفاصيل المكان، مثل اسم المكان الخاص بالمنطقة، إذا كان متاحًا. يمكن أن تؤثّر المَعلمة في النتائج استنادًا إلى القانون الساري.

لمزيد من المعلومات، يُرجى الاطّلاع على https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

يُرجى العِلم أنّ رموز المناطق المكوّنة من 3 أرقام غير متاحة حاليًا.
includedTypes[]

string

نوع المكان المُضمَّن (مثل "restaurant" أو "gas_station") من https://developers.google.com/maps/documentation/places/web-service/place-types

يمكن تحديد ما يصل إلى 50 نوعًا من الجدول أ.

في حال وجود أي أنواع متعارضة، أي أنّ نوعًا يظهر في كلّ من includedTypes وexcludedTypes، سيتم عرض الخطأ INVALID_ARGUMENT.

إذا تم تحديد نوع "مكان" مع قيود متعددة على النوع، لن يتم عرض سوى الأماكن التي تستوفي جميع القيود. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}، ستوفّر الأماكن التي يتم عرضها خدمات ذات صلة بـ "المطاعم" ولكنّها لا تعمل بشكل أساسي كـ "مطاعم".
excludedTypes[]

string

نوع المكان المستبعَد (مثل "restaurant" أو "gas_station") من https://developers.google.com/maps/documentation/places/web-service/place-types

يمكن تحديد ما يصل إلى 50 نوعًا من الجدول أ.

إذا قدّم العميل كلاً من includedTypes (مثل مطعم) وexcludedTypes (مثل مقهى)، يجب أن يتضمّن الردّ أماكن مصنّفة كمطعم ولكن ليس كمقهى. يتضمّن الردّ أماكن تطابق نوعًا واحدًا على الأقل من includedTypes ولا تطابق أيًا من excludedTypes.

في حال وجود أي أنواع متعارضة، أي أنّ نوعًا يظهر في كلّ من includedTypes وexcludedTypes، سيتم عرض الخطأ INVALID_ARGUMENT.

إذا تم تحديد نوع "مكان" مع قيود متعددة على النوع، لن يتم عرض سوى الأماكن التي تستوفي جميع القيود. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}، ستوفّر الأماكن التي يتم عرضها خدمات ذات صلة بـ "المطاعم" ولكنّها لا تعمل بشكل أساسي كـ "مطاعم".
includedPrimaryTypes[]

string

نوع المكان الأساسي المُدرَج (مثل "restaurant" أو "gas_station") من https://developers.google.com/maps/documentation/places/web-service/place-types يمكن أن يكون للمكان نوع أساسي واحد فقط من جدول الأنواع المتوافقة المرتبطة به.

يمكن تحديد ما يصل إلى 50 نوعًا من الجدول أ.

في حال وجود أي أنواع أساسية متعارضة، أي إذا ظهر نوع في كلّ من includedPrimaryTypes وexcludedPrimaryTypes، سيتم عرض الخطأ INVALID_ARGUMENT.

إذا تم تحديد نوع "مكان" مع قيود متعددة على النوع، لن يتم عرض سوى الأماكن التي تستوفي جميع القيود. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}، ستوفّر الأماكن التي يتم عرضها خدمات ذات صلة بـ "المطاعم" ولكنّها لا تعمل بشكل أساسي كـ "مطاعم".
excludedPrimaryTypes[]

string

تم استبعاد نوع المكان الأساسي (مثل "restaurant" أو "gas_station") من https://developers.google.com/maps/documentation/places/web-service/place-types.

يمكن تحديد ما يصل إلى 50 نوعًا من الجدول أ.

في حال وجود أي أنواع أساسية متعارضة، أي إذا ظهر نوع في كلّ من includedPrimaryTypes وexcludedPrimaryTypes، سيتم عرض الخطأ INVALID_ARGUMENT.

إذا تم تحديد نوع "مكان" مع قيود متعددة على النوع، لن يتم عرض سوى الأماكن التي تستوفي جميع القيود. على سبيل المثال، إذا كان لدينا {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}، ستوفّر الأماكن التي يتم عرضها خدمات ذات صلة بـ "المطاعم" ولكنّها لا تعمل بشكل أساسي كـ "مطاعم".
maxResultCount

integer

تعرض هذه المَعلمة أكبر عدد ممكن من النتائج. يجب أن تتراوح القيمة بين 1 و20 (القيمة التلقائية)، بما في ذلك الرقمان. إذا لم يتم ضبط الرقم، سيتم استخدام الحدّ الأقصى. إذا تم ضبط الرقم على قيمة سالبة أو تجاوز الحد الأقصى، سيتم عرض الخطأ INVALID_ARGUMENT.
locationRestriction

object (LocationRestriction)

الحقل مطلوب. تمثّل هذه السمة المنطقة المطلوب البحث فيها.
rankPreference

enum (RankPreference)

كيفية ترتيب النتائج في الردّ
routingParameters

object (RoutingParameters)

اختياريّ. المَعلمات التي تؤثّر في التوجيه إلى نتائج البحث
includeFutureOpeningBusinesses

boolean

اختياريّ. إذا كانت القيمة صحيحة، يجب تضمين الأنشطة التجارية التي لم يتم افتتاحها بعد ولكن سيتم افتتاحها في المستقبل.

نص الاستجابة

بروتوكول الردّ على طلب البحث في الجوار

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
الحقول
places[]

object (Place)

قائمة بالأماكن التي تستوفي متطلبات المستخدم، مثل أنواع الأماكن وعددها وقيود الموقع الجغرافي المحدّد
routingSummaries[]

object (RoutingSummary)

قائمة بملخّصات التوجيه، حيث يرتبط كل إدخال بالمكان المقابل له في الفهرس نفسه في الحقل places. إذا لم يتوفّر ملخّص التوجيه لأحد الأماكن، سيتضمّن إدخالاً فارغًا. يجب أن تتضمّن هذه القائمة عددًا من الإدخالات يساوي عدد الأماكن إذا طُلب ذلك.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

LocationRestriction

تمثّل هذه السمة المنطقة المطلوب البحث فيها.

تمثيل JSON 
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
الحقول

حقل الربط type

يمكن أن يكون التعليق type إحدى القيم التالية فقط:
circle

object (Circle)

دائرة محدّدة بنقطة مركز ونصف قطر

RankPreference

كيفية ترتيب النتائج في الردّ

عمليات التعداد
RANK_PREFERENCE_UNSPECIFIED لم يتم ضبط قيمة RankPreference. سيتم استخدام الترتيب حسب مدى الرواج تلقائيًا.
DISTANCE ترتيب النتائج حسب المسافة
POPULARITY ترتيب النتائج حسب مدى الرواج