Method: places.searchText

جستجوی مکان مبتنی بر پرس و جو متنی.

درخواست HTTP

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

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

درخواست بدن

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

نمایندگی JSON
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
زمینه های
textQuery

string

ضروری. پرس و جو متن برای جستجوی متنی.

languageCode

string

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

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

regionCode

string

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

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

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

rankPreference

enum ( RankPreference )

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

includedType

string

نوع مکان درخواستی لیست کامل انواع پشتیبانی شده: https://developers.google.com/maps/documentation/places/web-service/place-types . فقط از یک نوع شامل پشتیبانی کنید.

openNow

boolean

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

minRating

number

نتایجی را فیلتر کنید که میانگین امتیاز آنها از این حد کمتر است. یک مقدار معتبر باید یک شناور بین 0 و 5 (شامل) در آهنگ 0.5 باشد، یعنی [0، 0.5، 1.0، ...، 5.0] شامل. رتبه ورودی تا نزدیکترین 0.5 (سقف) گرد خواهد شد. به عنوان مثال، رتبه 0.6 تمام نتایج با رتبه کمتر از 1.0 را حذف می کند.

maxResultCount
(deprecated)

integer

منسوخ شده: به جای آن از pageSize استفاده کنید.

حداکثر تعداد نتایجی که در هر صفحه قابل بازگشت است. اگر تعداد نتایج موجود بزرگتر از maxResultCount باشد، nextPageToken برگردانده می شود که می تواند به pageToken منتقل شود تا صفحه بعدی نتایج در درخواست های بعدی دریافت شود. اگر مقدار 0 یا بدون ارائه شده باشد، پیش فرض 20 استفاده می شود. حداکثر مقدار 20 است. مقادیر بالای 20 به 20 تبدیل می شوند. مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

اگر هم maxResultCount و هم pageSize مشخص شده باشند، maxResultCount نادیده گرفته می شود.

pageSize

integer

اختیاری. حداکثر تعداد نتایجی که در هر صفحه قابل بازگشت است. اگر تعداد نتایج موجود بزرگتر از pageSize باشد، nextPageToken برگردانده می شود که می تواند به pageToken منتقل شود تا صفحه بعدی نتایج در درخواست های بعدی دریافت شود. اگر مقدار 0 یا بدون ارائه شده باشد، پیش فرض 20 استفاده می شود. حداکثر مقدار 20 است. مقادیر بالای 20 روی 20 تنظیم می شوند. مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

اگر هم maxResultCount و هم pageSize مشخص شده باشند، maxResultCount نادیده گرفته می شود.

pageToken

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی TextSearch. این را برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه‌بندی، همه پارامترهای غیر از pageToken ، pageSize و maxResultCount ارائه‌شده به TextSearch باید با فراخوانی اولیه‌ای که نشانه صفحه را ارائه می‌کند مطابقت داشته باشند. در غیر این صورت یک خطای INVALID_ARGUMENT برگردانده می شود.

priceLevels[]

enum ( PriceLevel )

برای محدود کردن جستجو به مکان‌هایی که به‌عنوان سطوح قیمت مشخص علامت‌گذاری شده‌اند استفاده می‌شود. کاربران می توانند هر ترکیبی از سطوح قیمت را انتخاب کنند. پیش فرض برای انتخاب همه سطوح قیمت.

strictTypeFiltering

boolean

برای تنظیم فیلتر نوع دقیق برای includeType استفاده می شود. اگر روی true تنظیم شود، فقط نتایج از همان نوع برگردانده می شود. پیش فرض به غلط.

locationBias

object ( LocationBias )

منطقه ای برای جستجو این مکان به عنوان یک سوگیری عمل می کند که به این معنی است که نتایج در اطراف مکان داده شده ممکن است برگردانده شوند. نمی‌توان همراه با محدودیت مکان تنظیم کرد.

locationRestriction

object ( LocationRestriction )

منطقه ای برای جستجو این مکان به عنوان یک محدودیت عمل می کند که به این معنی است که نتایج خارج از مکان معین بازگردانده نمی شوند. همراه با locationBias قابل تنظیم نیست.

evOptions

object ( EVOptions )

اختیاری. گزینه های EV قابل جستجو درخواست جستجوی مکان را تنظیم کنید.

بدن پاسخگو

پاسخ اولیه برای places.searchText.

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

نمایندگی JSON
{
  "places": [
    {
      object (Place)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
زمینه های
places[]

object ( Place )

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

contextualContents[]

object ( ContextualContent )

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

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

nextPageToken

string

نشانه ای که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف یا خالی باشد، هیچ صفحه بعدی وجود ندارد.

رتبه اولویت

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

Enums
RANK_PREFERENCE_UNSPECIFIED برای یک جستار طبقه بندی شده مانند "رستوران ها در شهر نیویورک"، RELEVANCE پیش فرض است. برای جستارهای غیر دسته بندی مانند "Mountain View, CA" توصیه می کنیم که rankPreference را تنظیم نشده رها کنید.
DISTANCE نتایج را بر اساس مسافت رتبه بندی می کند.
RELEVANCE نتایج را بر اساس ارتباط رتبه بندی می کند. ترتیب مرتب سازی که توسط پشته رتبه بندی عادی تعیین می شود.

LocationBias

منطقه ای برای جستجو این مکان به عنوان یک سوگیری عمل می کند که به این معنی است که نتایج در اطراف مکان داده شده ممکن است برگردانده شوند.

نمایندگی JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
زمینه های

type فیلد اتحادیه

type می تواند تنها یکی از موارد زیر باشد:

rectangle

object ( Viewport )

یک جعبه مستطیل که توسط گوشه شمال شرقی و جنوب غربی تعریف شده است. rectangle.high() باید نقطه شمال شرقی نمای مستطیل باشد. rectangle.low() باید نقطه جنوب غربی نمای مستطیل باشد. rectangle.low().latitude() نمی تواند بزرگتر از rectangle.high().latitude() باشد. این باعث ایجاد یک محدوده عرض جغرافیایی خالی می شود. یک نمای مستطیل نمی تواند از 180 درجه بیشتر باشد.

circle

object ( Circle )

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

محدودیت مکان

منطقه ای برای جستجو این مکان به عنوان یک محدودیت عمل می کند که به این معنی است که نتایج خارج از مکان معین بازگردانده نمی شوند.

نمایندگی JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
زمینه های

type فیلد اتحادیه

type می تواند تنها یکی از موارد زیر باشد:

rectangle

object ( Viewport )

یک جعبه مستطیل که توسط گوشه شمال شرقی و جنوب غربی تعریف شده است. rectangle.high() باید نقطه شمال شرقی نمای مستطیل باشد. rectangle.low() باید نقطه جنوب غربی نمای مستطیل باشد. rectangle.low().latitude() نمی تواند بزرگتر از rectangle.high().latitude() باشد. این باعث ایجاد یک محدوده عرض جغرافیایی خالی می شود. یک نمای مستطیل نمی تواند از 180 درجه بیشتر باشد.

EVOptions

گزینه های EV قابل جستجو درخواست جستجوی مکان.

نمایندگی JSON
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
زمینه های
minimumChargingRateKw

number

اختیاری. حداقل نرخ شارژ مورد نیاز بر حسب کیلووات. مکانی با نرخ شارژ کمتر از نرخ مشخص شده فیلتر می شود.

connectorTypes[]

enum ( EVConnectorType )

اختیاری. فهرست انواع کانکتورهای EV ترجیحی. مکانی که از هیچ یک از انواع اتصال دهنده های ذکر شده پشتیبانی نمی کند، فیلتر می شود.

محتوای متنی

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

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

نمایندگی JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
زمینه های
reviews[]

object ( Review )

فهرست نظرات درباره این مکان، مرتبط با جستجوی مکان.

photos[]

object ( Photo )

اطلاعات (از جمله مراجع) درباره عکس‌های این مکان، مرتبط با جستار مکان.

justifications[]

object ( Justification )

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

توجیهات برای مکان

توجیه

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

توجیهات برای مکان Justifications به این سوال پاسخ می دهد که چرا یک مکان می تواند یک کاربر نهایی را مورد توجه قرار دهد.

نمایندگی JSON
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
زمینه های

justification میدانی اتحادیه .

justification تنها می تواند یکی از موارد زیر باشد:

reviewJustification

object ( ReviewJustification )

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

businessAvailabilityAttributesJustification

object ( BusinessAvailabilityAttributesJustification )

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

بازبینی توجیه

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

توجیهات بررسی کاربران این قسمتی از بررسی کاربر را برجسته می کند که برای کاربر نهایی جالب است. به عنوان مثال، اگر عبارت جستجو "پیتزا هیزم" باشد، توجیه بازبینی متن مربوط به عبارت جستجو را برجسته می کند.

نمایندگی JSON
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
زمینه های
highlightedText

object ( HighlightedText )

review

object ( Review )

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

متن برجسته شده

متن برجسته شده توسط توجیه. این زیر مجموعه ای از خود بررسی است. کلمه دقیقی که باید برجسته شود با HighlightedTextRange مشخص می شود. ممکن است چندین کلمه در متن برجسته شده باشد.

نمایندگی JSON
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
زمینه های
text

string

highlightedTextRanges[]

object ( HighlightedTextRange )

فهرست محدوده های متن برجسته شده.

HighlightedTextRange

محدوده متن هایلایت شده

نمایندگی JSON
{
  "startIndex": integer,
  "endIndex": integer
}
زمینه های
startIndex

integer

endIndex

integer

BusinessAvailabilityAttributes توجیه

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید. BusinessAvailabilityAttributes توجیهات. این نشان می‌دهد که یک کسب‌وکار دارای ویژگی‌هایی است که می‌تواند کاربر نهایی را مورد توجه قرار دهد.

نمایندگی JSON
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
زمینه های
takeout

boolean

اگر مکانی فراهم می کند.

delivery

boolean

اگر مکانی تحویل داده شود.

dineIn

boolean

اگر مکانی غذاخوری را فراهم می کند.