Method: places.searchNearby

مکان های نزدیک به مکان ها را جستجو کنید.

درخواست HTTP

POST https://places.googleapis.com/v1/places:searchNearby

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
فیلدها
language Code

string

جزئیات مکان در صورت وجود با زبان ترجیحی نمایش داده می شود. اگر کد زبان نامشخص یا ناشناخته باشد، جزئیات مکان هر زبانی ممکن است برگردانده شود، در صورت وجود چنین جزئیاتی، ترجیحاً انگلیسی است.

لیست فعلی زبان های پشتیبانی شده: https://developers.google.com/maps/faq#languagesupport .

region Code

string

کد کشور/منطقه یونیکد (CLDR) مکانی که درخواست از آنجا می آید. این پارامتر برای نمایش جزئیات مکان، مانند نام مکان خاص منطقه، در صورت وجود استفاده می شود. این پارامتر می تواند بر نتایج بر اساس قانون قابل اجرا تأثیر بگذارد.

برای اطلاعات بیشتر، به https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html مراجعه کنید.

توجه داشته باشید که کدهای منطقه 3 رقمی در حال حاضر پشتیبانی نمی شوند.

included Types[]

string

شامل نوع مکان (به عنوان مثال، "رستوران" یا "پمپ بنزین") از https://developers.google.com/maps/documentation/places/web-service/place-types .

حداکثر 50 نوع از جدول A ممکن است مشخص شود.

اگر انواع متضاد وجود داشته باشد، یعنی یک نوع در هر دو نوع include و excludedType ظاهر شود، یک خطای INVALID_ARGUMENT برگردانده می شود.

اگر یک نوع مکان با محدودیت‌های چندگانه مشخص شده باشد، تنها مکان‌هایی برگردانده می‌شوند که همه محدودیت‌ها را برآورده کنند. برای مثال، اگر {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} داشته باشیم، مکان‌های برگشتی خدمات مرتبط با "رستوران" را ارائه می‌کنند اما عمدتاً به عنوان "رستوران" عمل نمی‌کنند.

excluded Types[]

string

نوع مکان (مثلاً "رستوران" یا "پمپ بنزین") از https://developers.google.com/maps/documentation/places/web-service/place-types حذف شده است.

حداکثر 50 نوع از جدول A ممکن است مشخص شود.

اگر مشتری هر دو نوع include (مثلا رستوران) و excludedTypes (مثلا کافه) را ارائه دهد، پاسخ باید شامل مکان هایی باشد که رستوران هستند اما کافه نیستند. پاسخ شامل مکان‌هایی است که حداقل با یکی از TypeTypes و هیچ یک از ExcludedTypes مطابقت دارند.

اگر انواع متضاد وجود داشته باشد، یعنی یک نوع در هر دو نوع include و excludedType ظاهر شود، یک خطای INVALID_ARGUMENT برگردانده می شود.

اگر یک نوع مکان با محدودیت‌های چندگانه مشخص شده باشد، تنها مکان‌هایی برگردانده می‌شوند که همه محدودیت‌ها را برآورده کنند. برای مثال، اگر {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} داشته باشیم، مکان‌های برگشتی خدمات مرتبط با "رستوران" را ارائه می‌کنند اما عمدتاً به عنوان "رستوران" عمل نمی‌کنند.

included Primary Types[]

string

شامل نوع مکان اصلی (به عنوان مثال "رستوران" یا "پمپ_گاز") از https://developers.google.com/maps/documentation/places/web-service/place-types . یک مکان فقط می تواند یک نوع اصلی از جدول انواع پشتیبانی شده مرتبط با آن داشته باشد.

حداکثر 50 نوع از جدول A ممکن است مشخص شود.

اگر انواع اصلی متضاد وجود داشته باشد، یعنی یک نوع در هر دو includePrimaryTypes و excludedPrimaryTypes ظاهر می شود، یک خطای INVALID_ARGUMENT برگردانده می شود.

اگر یک نوع مکان با محدودیت‌های چندگانه مشخص شده باشد، تنها مکان‌هایی برگردانده می‌شوند که همه محدودیت‌ها را برآورده کنند. برای مثال، اگر {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} داشته باشیم، مکان‌های برگشتی خدمات مرتبط با "رستوران" را ارائه می‌کنند اما عمدتاً به عنوان "رستوران" عمل نمی‌کنند.

excluded Primary Types[]

string

نوع مکان اصلی (مثلاً "رستوران" یا "پمپ_گاز") از https://developers.google.com/maps/documentation/places/web-service/place-types مستثنی شده است.

حداکثر 50 نوع از جدول A ممکن است مشخص شود.

اگر انواع اصلی متضاد وجود داشته باشد، یعنی یک نوع در هر دو includePrimaryTypes و excludedPrimaryTypes ظاهر می شود، یک خطای INVALID_ARGUMENT برگردانده می شود.

اگر یک نوع مکان با محدودیت‌های چندگانه مشخص شده باشد، تنها مکان‌هایی برگردانده می‌شوند که همه محدودیت‌ها را برآورده کنند. برای مثال، اگر {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} داشته باشیم، مکان‌های برگشتی خدمات مرتبط با "رستوران" را ارائه می‌کنند اما عمدتاً به عنوان "رستوران" عمل نمی‌کنند.

max Result Count

integer

حداکثر تعداد نتایج برای بازگشت. باید بین 1 تا 20 (پیش‌فرض) باشد. اگر عدد تنظیم نشده باشد، به حد بالایی باز می گردد. اگر عدد روی منفی تنظیم شود یا از حد بالایی بیشتر شود، یک خطای INVALID_ARGUMENT برگردانده می شود.

location Restriction

object ( LocationRestriction )

مورد نیاز. منطقه ای برای جستجو

rank Preference

enum ( RankPreference )

نتایج چگونه در پاسخ رتبه بندی خواهند شد.

routing Parameters

object ( RoutingParameters )

اختیاری. پارامترهایی که بر مسیریابی به نتایج جستجو تأثیر می گذارند.

بدن پاسخگو

پاسخ اولیه برای جستجوی نزدیک.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
فیلدها
places[]

object ( Place )

فهرستی از مکان‌هایی که نیازهای کاربر را برآورده می‌کنند، مانند انواع مکان‌ها، تعداد مکان‌ها و محدودیت‌های مکانی خاص.

routing Summaries[]

object ( RoutingSummary )

فهرستی از خلاصه‌های مسیریابی که در آن هر ورودی به مکان مربوطه در همان فهرست در قسمت places مرتبط است. اگر خلاصه مسیریابی برای یکی از مکان‌ها در دسترس نباشد، یک ورودی خالی خواهد داشت. در صورت درخواست، این لیست باید به اندازه فهرست مکان ها ورودی داشته باشد.

محدودیت مکان

منطقه ای برای جستجو

نمایندگی 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 )

دایره ای که با نقطه مرکزی و شعاع مشخص می شود.

رتبه اولویت

نتایج چگونه در پاسخ رتبه بندی خواهند شد.

Enums
RANK_PREFERENCE_UNSPECIFIED مقدار RankPreference تنظیم نشده است. به طور پیش‌فرض از رتبه براساس POPULARITY استفاده می‌کند.
DISTANCE نتایج را بر اساس فاصله رتبه بندی می کند.
POPULARITY نتایج را بر اساس محبوبیت رتبه بندی می کند.