Method: places.searchNearby

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

درخواست HTTP

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

این URL از سینتکس Transcoding در 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

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

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

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

includedTypes[]

string

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

حداکثر ۵۰ نوع از جدول الف ممکن است مشخص شود.

اگر انواع متناقضی وجود داشته باشد، یعنی یک نوع هم در includedTypes و هم در excludeTypes ظاهر شود، خطای INVALID_ARGUMENT برگردانده می‌شود.

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

excludedTypes[]

string

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

حداکثر ۵۰ نوع از جدول الف ممکن است مشخص شود.

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

اگر انواع متناقضی وجود داشته باشد، یعنی یک نوع هم در includedTypes و هم در excludeTypes ظاهر شود، خطای INVALID_ARGUMENT برگردانده می‌شود.

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

includedPrimaryTypes[]

string

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

حداکثر ۵۰ نوع از جدول الف ممکن است مشخص شود.

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

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

excludedPrimaryTypes[]

string

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

حداکثر ۵۰ نوع از جدول الف ممکن است مشخص شود.

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

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

maxResultCount

integer

حداکثر تعداد نتایج برای بازگشت. این مقدار باید بین ۱ تا ۲۰ (پیش‌فرض) باشد، به طور کلی. اگر عدد تنظیم نشده باشد، به حد بالایی برمی‌گردد. اگر عدد منفی تنظیم شود یا از حد بالایی فراتر رود، خطای 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

محدودیت مکانی

منطقه مورد جستجو.

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

دایره‌ای که با نقطه مرکز و شعاع تعریف می‌شود.

ترجیح رتبه

نحوه رتبه‌بندی نتایج در پاسخ.

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