یک درخواست Find Place (Legacy) یک ورودی متنی دریافت میکند و یک مکان را برمیگرداند. ورودی میتواند هر نوع داده متنی Places، مانند نام، آدرس یا شماره تلفن باشد. درخواست باید یک رشته باشد. یک درخواست Find Place (Legacy) با استفاده از دادههای غیر رشتهای مانند مختصات lat/lng یا کد پلاس، خطا ایجاد میکند.
درخواستهای یافتن مکان (قدیمی)
یک درخواست Find Place (Legacy) یک HTTP URL به شکل زیر است:
https://maps.googleapis.com/maps/api/place/findplacefromtext/output?parameters
که در آن output میتواند یکی از مقادیر زیر باشد:
-
json(توصیه میشود) خروجی را در قالب نشانهگذاری شیء جاوا اسکریپت (JSON) نشان میدهد. -
xmlخروجی را به صورت XML نشان میدهد
پارامترهای خاصی برای شروع درخواست Find Place (Legacy) مورد نیاز است. همانطور که در URL ها استاندارد است، همه پارامترها با استفاده از کاراکتر ampersand ( & ) از هم جدا می شوند.
پارامترهای مورد نیاز
ورودی
رشته متنی که باید در آن جستجو شود، برای مثال: "رستوران" یا "خیابان اصلی ۱۲۳". این باید نام مکان، آدرس یا دسته بندی موسسات باشد. هر نوع ورودی دیگری میتواند باعث ایجاد خطا شود و تضمینی برای بازگشت نتایج معتبر وجود ندارد. API مکانها، تطابقهای کاندید را بر اساس این رشته برمیگرداند و نتایج را بر اساس ارتباط درک شده آنها مرتب میکند.
نوع ورودی
نوع ورودی. این میتواند یکی از دو نوع
textqueryیاphonenumberباشد. شماره تلفنها باید در قالب بینالمللی باشند (با علامت بعلاوه ("+") قبل از آنها، به دنبال آن کد کشور و سپس خود شماره تلفن). برای اطلاعات بیشتر به توصیهنامه E.164 ITU مراجعه کنید.
پارامترهای اختیاری
زمینهها
احتیاط: درخواستهای جستجوی مکان و درخواستهای جزئیات مکان، فیلدهای یکسانی را برنمیگردانند. درخواستهای جستجوی مکان، زیرمجموعهای از فیلدهایی را که توسط درخواستهای جزئیات مکان برگردانده میشوند، برمیگردانند. اگر فیلد مورد نظر شما توسط جستجوی مکان برگردانده نمیشود، میتوانید از جستجوی مکان برای دریافتplace_idاستفاده کنید، سپس از آن شناسه مکان برای ایجاد درخواست جزئیات مکان استفاده کنید. برای اطلاعات بیشتر در مورد فیلدهایی که در درخواست جستجوی مکان در دسترس نیستند، به پشتیبانی از فیلدهای API مکانها مراجعه کنید.از پارامتر fields برای مشخص کردن لیستی از انواع دادههای مکانی که با کاما از هم جدا شدهاند و قرار است برگردانده شوند، استفاده کنید. برای مثال:
fields=formatted_address,name,geometry. هنگام مشخص کردن مقادیر ترکیبی از اسلش استفاده کنید. برای مثال:opening_hours/open_now.فیلدها به سه دسته صورتحساب تقسیم میشوند: پایه ، تماس و اتمسفر . فیلدهای پایه با نرخ پایه و فیلدهای تماس و اتمسفر با نرخ بالاتری صورتحساب میشوند. SKUهای پایه، تماس و اتمسفر علاوه بر SKU پایه (جزئیات مکانها، یافتن مکان، جستجوی نزدیک یا جستجوی متن) برای درخواستی که آنها را فعال کرده است، هزینه دریافت میکنند. برای اطلاعات بیشتر، به برگه قیمتگذاری مراجعه کنید.
پایه
دسته پایه شامل فیلدهای زیر است:
address_components،adr_address،business_status،formatted_address،geometry،icon،icon_mask_base_uri،icon_background_color،name،permanently_closed( منسوخ شده )،photo،place_id،plus_code،type،url،utc_offset،vicinity،wheelchair_accessible_entrance.تماس
دستهبندی «تماس» شامل فیلدهای زیر است:
current_opening_hours،formatted_phone_number،international_phone_number،opening_hours،secondary_opening_hours،websiteجو
دستهبندی Atmosphere شامل فیلدهای زیر است:
curbside_pickup،deliverydine_in،editorial_summary،price_level،rating،reservable،reviews،serves_beer،serves_breakfast،serves_brunch،serves_dinner،serves_lunch،serves_vegetarian_food،serves_wine،takeout،user_ratings_total.نکته: Attributionها،html_attributions، همیشه با هر فراخوانی برگردانده میشوند، صرف نظر از اینکه آیا فیلد درخواست شده است یا خیر.زبان
زبانی که نتایج با آن برگردانده میشوند.
- فهرست زبانهای پشتیبانیشده را ببینید. گوگل اغلب زبانهای پشتیبانیشده را بهروزرسانی میکند، بنابراین این فهرست ممکن است جامع نباشد.
- اگر
languageارائه نشود، API تلاش میکند از زبان ترجیحی مشخص شده در سربرگAccept-Languageاستفاده کند. - این API تمام تلاش خود را میکند تا آدرسی را ارائه دهد که هم برای کاربر و هم برای افراد محلی قابل خواندن باشد. برای دستیابی به این هدف، آدرسهای خیابان را به زبان محلی برمیگرداند و در صورت لزوم با رعایت زبان ترجیحی، آنها را به اسکریپتی که توسط کاربر قابل خواندن باشد، تبدیل میکند. تمام آدرسهای دیگر به زبان ترجیحی برگردانده میشوند. اجزای آدرس همگی به همان زبانی برگردانده میشوند که از اولین جزء انتخاب شده است.
- اگر نامی در زبان مورد نظر موجود نباشد، API از نزدیکترین مورد منطبق استفاده میکند.
- زبان ترجیحی تأثیر کمی بر مجموعه نتایجی که API برای برگرداندن انتخاب میکند و ترتیب برگرداندن آنها دارد. کدگذار جغرافیایی بسته به زبان، اختصارات را به طور متفاوتی تفسیر میکند، مانند اختصارات مربوط به انواع خیابان، یا مترادفهایی که ممکن است در یک زبان معتبر باشند اما در زبان دیگر معتبر نباشند. به عنوان مثال، utca و tér مترادف خیابان در زبان مجارستانی هستند.
سوگیری مکانی
با مشخص کردن شعاع به علاوهی lat/lng، یا دو جفت lat/lng که نشاندهندهی نقاط یک مستطیل هستند، نتایج را در یک ناحیهی مشخصشده ترجیح دهید. اگر این پارامتر مشخص نشود، API بهطور پیشفرض از بایاس آدرس IP استفاده میکند.
- IP bias: به API دستور میدهد که از آدرس IP biasing استفاده کند. رشته
ipbiasرا به آن بدهید (این گزینه هیچ پارامتر اضافی ندارد). - Circular: رشتهای که شعاع را بر حسب متر به علاوهی lat/lng بر حسب درجهی اعشاری مشخص میکند. از قالب زیر استفاده کنید:
circle:radius@lat,lng. - مستطیلی: رشتهای که دو جفت lat/lng را بر حسب درجه اعشاری مشخص میکند و نقاط جنوب/غرب و شمال/شرق یک مستطیل را نشان میدهد. از قالب زیر استفاده کنید:
rectangle:south,west|north,east. توجه داشته باشید که مقادیر east/west در محدوده -180, 180 قرار میگیرند و مقادیر north/sout در محدوده -90, 90 قرار میگیرند.
- IP bias: به API دستور میدهد که از آدرس IP biasing استفاده کند. رشته
نمونههایی از Find Place (میراث)
مثال زیر یک درخواست Find Place (Legacy) برای "Museum of Contemporary Art Australia" را نشان میدهد که شامل فیلدهای photos ، formatted_address ، name ، rating ، opening_hours و geometry است:
آدرس اینترنتی
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=Museum%20of%20Contemporary%20Art%20Australia &inputtype=textquery &key=YOUR_API_KEY
حلقه
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=Museum%20of%20Contemporary%20Art%20Australia&inputtype=textquery&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&key=YOUR_API_KEY'
مثال زیر یک درخواست Find Place (Legacy) برای عبارت "Mongolian Grill" را نشان میدهد که از پارامتر locationbias برای ترجیح نتایج در محدوده ۲۰۰۰ متری مختصات مشخص شده استفاده میکند:
آدرس اینترنتی
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry &input=mongolian &inputtype=textquery &locationbias=circle%3A2000%4047.6918452%2C-122.2226413 &key=YOUR_API_KEY
حلقه
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=mongolian&inputtype=textquery&locationbias=circle%3A2000%4047.6918452%2C-122.2226413&fields=formatted_address%2Cname%2Crating%2Copening_hours%2Cgeometry&key=YOUR_API_KEY'
مثال زیر یک درخواست Find Place (Legacy) برای یک شماره تلفن را نشان میدهد. توجه داشته باشید که پیشوند تماس بینالمللی "+" به %2B کدگذاری شده است تا این درخواست یک URL سازگار باشد. در صورت عدم کدگذاری، پیشوند + به یک فاصله در سرور رمزگشایی میشود و منجر به جستجوی نامعتبر شماره تلفن میشود.
آدرس اینترنتی
https://maps.googleapis.com/maps/api/place/findplacefromtext/json ?input=%2B16502530000 &inputtype=phonenumber &key=YOUR_API_KEY
حلقه
curl -L -X GET 'https://maps.googleapis.com/maps/api/place/findplacefromtext/json?input=%2B16502530000&inputtype=phonenumber&key=YOUR_API_KEY'
پاسخهای Find Place (میراث)
یک پاسخ Find Place (Legacy) فقط شامل انواع دادههایی است که با استفاده از پارامتر fields مشخص شدهاند، به علاوه html_attributions . مثال زیر پاسخ درخواست Find Place (Legacy) برای "Museum of Contemporary Art Australia" را نشان میدهد که شامل فیلدهای formatted_address ، geometry ، name ، opening_hours ، photos و rating است.
جیسون
{ "candidates": [ { "formatted_address": "140 George St, The Rocks NSW 2000, Australia", "geometry": { "location": { "lat": -33.8599358, "lng": 151.2090295 }, "viewport": { "northeast": { "lat": -33.85824377010728, "lng": 151.2104386798927 }, "southwest": { "lat": -33.86094342989272, "lng": 151.2077390201073 }, }, }, "name": "Museum of Contemporary Art Australia", "opening_hours": { "open_now": false }, "rating": 4.4, }, ], "status": "OK", }
XML
<FindPlaceFromTextResponse> <candidates> <name>Museum of Contemporary Art Australia</name> <formatted_address>140 George St, The Rocks NSW 2000, Australia</formatted_address> <geometry> <location> <lat>-33.8599358</lat> <lng>151.2090295</lng> </location> <viewport> <southwest> <lat>-33.8609434</lat> <lng>151.2077390</lng> </southwest> <northeast> <lat>-33.8582438</lat> <lng>151.2104387</lng> </northeast> </viewport> </geometry> <rating>4.4</rating> <opening_hours> <open_now>false</open_now> </opening_hours> </candidates> <status>OK</status> </FindPlaceFromTextResponse>
PlacesFindPlaceFromTextResponse
| Field | Required | Type | Description |
|---|---|---|---|
| required | Array< Place > | Contains an array of Place candidates.
Place Search requests return a subset of the fields that are
returned by Place Details requests. If the field you want is not
returned by Place Search, you can use Place Search to get a
place_id, then use that Place ID to make a Place Details request.
See Place for more information. |
| required | PlacesSearchStatus | Contains the status of the request, and may contain debugging information to help you track down why the request failed. See PlacesSearchStatus for more information. |
| optional | string |
When the service returns a status code other than
|
| optional | Array<string> |
When the service returns additional information about the request
specification, there may be an additional
|
PlacesSearchStatus
Status codes returned by service.
-
OKindicating the API request was successful. -
ZERO_RESULTSindicating that the search was successful but returned no results. This may occur if the search was passed alatlngin a remote location. INVALID_REQUESTindicating the API request was malformed, generally due to missing required query parameter (locationorradius).OVER_QUERY_LIMITindicating any of the following:- You have exceeded the QPS limits.
- Billing has not been enabled on your account.
- The monthly $200 credit, or a self-imposed usage cap, has been exceeded.
- The provided method of payment is no longer valid (for example, a credit card has expired).
REQUEST_DENIEDindicating that your request was denied, generally because:- The request is missing an API key.
- The
keyparameter is invalid.
-
UNKNOWN_ERRORindicating an unknown error.
Place
Attributes describing a place. Not all attributes will be available for all place types.
| Field | Required | Type | Description |
|---|---|---|---|
| optional | Array< AddressComponent > | An array containing the separate components applicable to this address. See AddressComponent for more information. |
| optional | string | A representation of the place's address in the adr microformat . |
| optional | string |
Indicates the operational status of the place, if it is a business.
If no data exists,
The allowed values include: OPERATIONAL ,
CLOSED_TEMPORARILY , and CLOSED_PERMANENTLY |
| optional | boolean | Specifies if the business supports curbside pickup. |
| optional | PlaceOpeningHours |
Contains the hours of operation for the next seven days (including
today). The time period starts at midnight on the date of the
request and ends at 11:59 pm six days later. This field includes the
See PlaceOpeningHours for more information. |
| optional | boolean | Specifies if the business supports delivery. |
| optional | boolean | Specifies if the business supports indoor or outdoor seating options. |
| optional | PlaceEditorialSummary | Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered. See PlaceEditorialSummary for more information. |
| optional | string | A string containing the human-readable address of this place. Often this address is equivalent to the postal address. Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions. The formatted address is logically composed of one or more address components. For example, the address "111 8th Avenue, New York, NY" consists of the following components: "111" (the street number), "8th Avenue" (the route), "New York" (the city) and "NY" (the US state). Do not parse the formatted address programmatically. Instead you should use the individual address components, which the API response includes in addition to the formatted address field. |
| optional | string | Contains the place's phone number in its local format . |
| optional | Geometry | Contains the location and viewport for the location. See Geometry for more information. |
| optional | string | Contains the URL of a suggested icon which may be displayed to the user when indicating this result on a map. |
| optional | string | Contains the default HEX color code for the place's category. |
| optional | string |
Contains the URL of a recommended icon, minus the
|
| optional | string |
Contains the place's phone number in international format.
International format includes the country code, and is prefixed with
the plus, +, sign. For example, the international_phone_number for
Google's Sydney, Australia office is |
| optional | string |
Contains the human-readable name for the returned result. For
|
| optional | PlaceOpeningHours | Contains the regular hours of operation. See PlaceOpeningHours for more information. |
| optional | boolean |
Use |
| optional | Array< PlacePhoto > | An array of photo objects, each containing a reference to an image. A request may return up to ten photos. More information about place photos and how you can use the images in your application can be found in the Place Photos documentation. See PlacePhoto for more information. |
| optional | string |
A textual identifier that uniquely identifies a place. To retrieve
information about the place, pass this identifier in the
|
| optional | PlusCode | An encoded location reference, derived from latitude and longitude coordinates, that represents an area: 1/8000th of a degree by 1/8000th of a degree (about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named). See Open Location Code and plus codes . See PlusCode for more information. |
| optional | number | The price level of the place, on a scale of 0 to 4. The exact amount indicated by a specific value will vary from region to region. Price levels are interpreted as follows:
|
| optional | number | Contains the place's rating, from 1.0 to 5.0, based on aggregated user reviews. |
| optional | string | |
| optional | boolean | Specifies if the place supports reservations. |
| optional | Array< PlaceReview > |
A JSON array of up to five reviews. By default, the reviews are
sorted in order of relevance. Use the
Google recommends indicating to users whether results are ordered by
See PlaceReview for more information. |
| optional | string | |
| optional | Array< PlaceOpeningHours > |
Contains an array of entries for the next seven days including
information about secondary hours of a business. Secondary hours are
different from a business's main hours. For example, a restaurant
can specify drive through hours or delivery hours as its secondary
hours. This field populates the See PlaceOpeningHours for more information. |
| optional | boolean | Specifies if the place serves beer. |
| optional | boolean | Specifies if the place serves breakfast. |
| optional | boolean | Specifies if the place serves brunch. |
| optional | boolean | Specifies if the place serves dinner. |
| optional | boolean | Specifies if the place serves lunch. |
| optional | boolean | Specifies if the place serves vegetarian food. |
| optional | boolean | Specifies if the place serves wine. |
| optional | boolean | Specifies if the business supports takeout. |
| optional | Array<string> | Contains an array of feature types describing the given result. See the list of supported types . |
| optional | string | Contains the URL of the official Google page for this place. This will be the Google-owned page that contains the best available information about the place. Applications must link to or embed this page on any screen that shows detailed results about the place to the user. |
| optional | number | The total number of reviews, with or without text, for this place. |
| optional | number | Contains the number of minutes this place’s current timezone is offset from UTC. For example, for places in Sydney, Australia during daylight saving time this would be 660 (+11 hours from UTC), and for places in California outside of daylight saving time this would be -480 (-8 hours from UTC). |
| optional | string |
For establishment (
For all other results, the This content is meant to be read as-is. Do not programmatically parse the formatted address. |
| optional | string | The authoritative website for this place, such as a business' homepage. |
| optional | boolean | Specifies if the place has an entrance that is wheelchair-accessible. |
AddressComponent
| Field | Required | Type | Description |
|---|---|---|---|
| required | string | The full text description or name of the address component as returned by the Geocoder. |
| required | string | An abbreviated textual name for the address component, if available. For example, an address component for the state of Alaska may have a long_name of "Alaska" and a short_name of "AK" using the 2-letter postal abbreviation. |
| required | Array<string> | An array indicating the type of the address component. See the list of supported types . |
PlaceEditorialSummary
Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.
| Field | Required | Type | Description |
|---|---|---|---|
| optional | string | The language of the previous fields. May not always be present. |
| optional | string | A medium-length textual summary of the place. |
Geometry
An object describing the location.
| Field | Required | Type | Description |
|---|---|---|---|
| required | LatLngLiteral | See LatLngLiteral for more information. |
| required | Bounds | See Bounds for more information. |
LatLngLiteral
An object describing a specific location with Latitude and Longitude in decimal degrees.
| Field | Required | Type | Description |
|---|---|---|---|
| required | number | Latitude in decimal degrees |
| required | number | Longitude in decimal degrees |
Bounds
A rectangle in geographical coordinates from points at the southwest and northeast corners.
| Field | Required | Type | Description |
|---|---|---|---|
| required | LatLngLiteral | See LatLngLiteral for more information. |
| required | LatLngLiteral | See LatLngLiteral for more information. |
PlaceOpeningHours
An object describing the opening hours of a place.
| Field | Required | Type | Description |
|---|---|---|---|
| optional | boolean | A boolean value indicating if the place is open at the current time. |
| optional | Array< PlaceOpeningHoursPeriod > | An array of opening periods covering seven days, starting from Sunday, in chronological order. See PlaceOpeningHoursPeriod for more information. |
| optional | Array< PlaceSpecialDay > | An array of up to seven entries corresponding to the next seven days. See PlaceSpecialDay for more information. |
| optional | string |
A type string used to identify the type of secondary hours (for
example, |
| optional | Array<string> | An array of strings describing in human-readable text the hours of the place. |
PlaceOpeningHoursPeriod
| Field | Required | Type | Description |
|---|---|---|---|
| required | PlaceOpeningHoursPeriodDetail | Contains a pair of day and time objects describing when the place opens. See PlaceOpeningHoursPeriodDetail for more information. |
| optional | PlaceOpeningHoursPeriodDetail |
May contain a pair of day and time objects describing when the place
closes. If a place is always open, the close section will be missing
from the response. Clients can rely on always-open being represented
as an open period containing day with value See PlaceOpeningHoursPeriodDetail for more information. |
PlaceSpecialDay
| Field | Required | Type | Description |
|---|---|---|---|
| optional | string | A date expressed in RFC3339 format in the local timezone for the place, for example 2010-12-31. |
| optional | boolean |
True if there are exceptional hours for this day. If
|
PlaceOpeningHoursPeriodDetail
| Field | Required | Type | Description |
|---|---|---|---|
| required | number | A number from 0–6, corresponding to the days of the week, starting on Sunday. For example, 2 means Tuesday. |
| required | string | May contain a time of day in 24-hour hhmm format. Values are in the range 0000–2359. The time will be reported in the place’s time zone. |
| optional | string | A date expressed in RFC3339 format in the local timezone for the place, for example 2010-12-31. |
| optional | boolean | True if a given period was truncated due to a seven-day cutoff, where the period starts before midnight on the date of the request and/or ends at or after midnight on the last day. This property indicates that the period for open or close can extend past this seven-day cutoff. |
PlacePhoto
A photo of a Place. The photo can be accesed via the Place Photo API using an url in the following pattern:
https://maps.googleapis.com/maps/api/place/photo?maxwidth=400&photo_reference=photo_reference&key=YOUR_API_KEY
See Place Photos for more information.
| Field | Required | Type | Description |
|---|---|---|---|
| required | number | The height of the photo. |
| required | Array<string> | The HTML attributions for the photo. |
| required | string | A string used to identify the photo when you perform a Photo request. |
| required | number | The width of the photo. |
PlusCode
An encoded location reference, derived from latitude and longitude coordinates, that represents an area, 1/8000th of a degree by 1/8000th of a degree (about 14m x 14m at the equator) or smaller. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named).
| Field | Required | Type | Description |
|---|---|---|---|
| required | string |
The |
| optional | string |
The |
PlaceReview
A review of the place submitted by a user.
| Field | Required | Type | Description |
|---|---|---|---|
| required | string | The name of the user who submitted the review. Anonymous reviews are attributed to "A Google user". |
| required | number | The user's overall rating for this place. This is a whole number, ranging from 1 to 5. |
| required | string | The time that the review was submitted in text, relative to the current time. |
| required | number | The time that the review was submitted, measured in the number of seconds since since midnight, January 1, 1970 UTC. |
| optional | string | The URL to the user's Google Maps Local Guides profile, if available. |
| optional | string | An IETF language code indicating the language of the returned review.This field contains the main language tag only, and not the secondary tag indicating country or region. For example, all the English reviews are tagged as 'en', and not 'en-AU' or 'en-UK' and so on.This field is empty if there is only a rating with no review text. |
| optional | string |
An IETF language code indicating the original language of the
review. If the review has been translated, then
|
| optional | string | The URL to the user's profile photo, if available. |
| optional | string |
The user's review. When reviewing a location with Google Places,
text reviews are considered optional. Therefore, this field may be
empty. Note that this field may include simple HTML markup. For
example, the entity reference |
| optional | boolean | A boolean value indicating if the review was translated from the original language it was written in.If a review has been translated, corresponding to a value of true, Google recommends that you indicate this to your users. For example, you can add the following string, “Translated by Google”, to the review. |