- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- LocationRestriction
- RankPreference
Tìm kiếm địa điểm gần vị trí.
Yêu cầu HTTP
POST https://places.googleapis.com/v1/places:searchNearby
URL sử dụng cú pháp Chuyển mã gRPC.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:
| Biểu diễn dưới dạng JSON |
|---|
{ "languageCode": string, "regionCode": string, "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ], "maxResultCount": integer, "locationRestriction": { object ( |
| Trường | |
|---|---|
languageCode |
Thông tin chi tiết về địa điểm sẽ hiển thị bằng ngôn ngữ ưu tiên (nếu có). Nếu mã ngôn ngữ không được chỉ định hoặc không được nhận dạng, thì thông tin chi tiết về địa điểm bằng ngôn ngữ bất kỳ đều có thể được trả về, ưu tiên tiếng Anh nếu có thông tin chi tiết như vậy. Danh sách các ngôn ngữ được hỗ trợ hiện tại: https://developers.google.com/maps/faq#languagesupport. |
regionCode |
Mã quốc gia/khu vực Unicode (CLDR) của vị trí nơi yêu cầu được đưa ra. Tham số này được dùng để hiển thị thông tin chi tiết về địa điểm, chẳng hạn như tên địa điểm theo khu vực (nếu có). Tham số này có thể ảnh hưởng đến kết quả dựa trên luật hiện hành. Để biết thêm thông tin, hãy xem https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Xin lưu ý rằng mã vùng gồm 3 chữ số hiện không được hỗ trợ. |
includedTypes[] |
Loại Địa điểm được đưa vào (ví dụ: "nhà hàng" hoặc "trạm xăng") từ https://developers.google.com/maps/documentation/places/web-service/place-types. Bạn có thể chỉ định tối đa 50 loại trong Bảng A. Nếu có bất kỳ loại nào xung đột, tức là một loại xuất hiện trong cả includedTypes và excludedTypes, thì lỗi INVALID_ARGUMENT sẽ được trả về. Nếu bạn chỉ định một loại Địa điểm có nhiều hạn chế về loại, thì chỉ những địa điểm đáp ứng tất cả các hạn chế đó mới được trả về. Ví dụ: nếu chúng ta có {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, thì những địa điểm được trả về sẽ cung cấp các dịch vụ liên quan đến "nhà hàng" nhưng không hoạt động chủ yếu với vai trò là "nhà hàng". |
excludedTypes[] |
Loại Địa điểm bị loại trừ (ví dụ: "nhà hàng" hoặc "trạm xăng") trong https://developers.google.com/maps/documentation/places/web-service/place-types. Bạn có thể chỉ định tối đa 50 loại trong Bảng A. Nếu ứng dụng cung cấp cả includedTypes (ví dụ: nhà hàng) và excludedTypes (ví dụ: quán cà phê), thì phản hồi phải bao gồm những địa điểm là nhà hàng nhưng không phải quán cà phê. Phản hồi bao gồm những địa điểm khớp với ít nhất một trong các includedTypes và không khớp với bất kỳ excludedTypes nào. Nếu có bất kỳ loại nào xung đột, tức là một loại xuất hiện trong cả includedTypes và excludedTypes, thì lỗi INVALID_ARGUMENT sẽ được trả về. Nếu bạn chỉ định một loại Địa điểm có nhiều hạn chế về loại, thì chỉ những địa điểm đáp ứng tất cả các hạn chế đó mới được trả về. Ví dụ: nếu chúng ta có {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, thì những địa điểm được trả về sẽ cung cấp các dịch vụ liên quan đến "nhà hàng" nhưng không hoạt động chủ yếu với vai trò là "nhà hàng". |
includedPrimaryTypes[] |
Loại Địa điểm chính được đưa vào (ví dụ: "nhà hàng" hoặc "trạm xăng") từ https://developers.google.com/maps/documentation/places/web-service/place-types. Một địa điểm chỉ có thể có một loại chính trong bảng các loại được hỗ trợ liên kết với địa điểm đó. Bạn có thể chỉ định tối đa 50 loại trong Bảng A. Nếu có bất kỳ loại chính nào xung đột, tức là một loại xuất hiện trong cả includedPrimaryTypes và excludedPrimaryTypes, thì lỗi INVALID_ARGUMENT sẽ được trả về. Nếu bạn chỉ định một loại Địa điểm có nhiều hạn chế về loại, thì chỉ những địa điểm đáp ứng tất cả các hạn chế đó mới được trả về. Ví dụ: nếu chúng ta có {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, thì những địa điểm được trả về sẽ cung cấp các dịch vụ liên quan đến "nhà hàng" nhưng không hoạt động chủ yếu với vai trò là "nhà hàng". |
excludedPrimaryTypes[] |
Loại Địa điểm chính bị loại trừ (ví dụ: "nhà hàng" hoặc "trạm xăng") trong https://developers.google.com/maps/documentation/places/web-service/place-types. Bạn có thể chỉ định tối đa 50 loại trong Bảng A. Nếu có bất kỳ loại chính nào xung đột, tức là một loại xuất hiện trong cả includedPrimaryTypes và excludedPrimaryTypes, thì lỗi INVALID_ARGUMENT sẽ được trả về. Nếu bạn chỉ định một loại Địa điểm có nhiều hạn chế về loại, thì chỉ những địa điểm đáp ứng tất cả các hạn chế đó mới được trả về. Ví dụ: nếu chúng ta có {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, thì những địa điểm được trả về sẽ cung cấp các dịch vụ liên quan đến "nhà hàng" nhưng không hoạt động chủ yếu với vai trò là "nhà hàng". |
maxResultCount |
Số lượng kết quả tối đa cần trả về. Giá trị này phải nằm trong khoảng từ 1 đến 20 (mặc định). Nếu bạn chưa đặt số, thì số đó sẽ quay lại giới hạn trên. Nếu bạn đặt số thành giá trị âm hoặc vượt quá giới hạn trên, thì lỗi INVALID_ARGUMENT sẽ được trả về. |
locationRestriction |
Bắt buộc. Vùng cần tìm kiếm. |
rankPreference |
Cách xếp hạng kết quả trong câu trả lời. |
routingParameters |
Không bắt buộc. Các tham số ảnh hưởng đến việc định tuyến đến kết quả tìm kiếm. |
includeFutureOpeningBusinesses |
Không bắt buộc. Nếu đúng, hãy thêm những doanh nghiệp chưa mở cửa nhưng sẽ mở cửa trong tương lai. |
Nội dung phản hồi
Proto phản hồi cho tính năng Tìm kiếm lân cận.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
| Biểu diễn dưới dạng JSON |
|---|
{ "places": [ { object ( |
| Trường | |
|---|---|
places[] |
Danh sách các địa điểm đáp ứng yêu cầu của người dùng, chẳng hạn như loại địa điểm, số lượng địa điểm và hạn chế về vị trí cụ thể. |
routingSummaries[] |
Danh sách tóm tắt về việc định tuyến, trong đó mỗi mục liên kết với địa điểm tương ứng trong cùng một chỉ mục trong trường |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/maps-platform.places.nearbysearchhttps://www.googleapis.com/auth/maps-platform.placeshttps://www.googleapis.com/auth/cloud-platform
LocationRestriction
Vùng cần tìm kiếm.
| Biểu diễn dưới dạng JSON |
|---|
{ // Union field |
| Trường | |
|---|---|
Trường nhóm
|
|
circle |
Một hình tròn được xác định bằng điểm giữa và bán kính. |
RankPreference
Cách xếp hạng kết quả trong câu trả lời.
| Enum | |
|---|---|
RANK_PREFERENCE_UNSPECIFIED |
Chưa đặt giá trị RankPreference. Theo mặc định, sẽ sử dụng thứ hạng theo MỨC ĐỘ PHỔ BIẾN. |
DISTANCE |
Xếp hạng kết quả theo khoảng cách. |
POPULARITY |
Sắp xếp kết quả theo mức độ phổ biến. |