- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- LocationBias
- LocationRestriction
- Đề xuất
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Trả về kết quả dự đoán cho dữ liệu đầu vào đã cho.
Yêu cầu HTTP
POST https://places.googleapis.com/v1/places:autocomplete
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 có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "input": string, "locationBias": { object ( |
Trường | |
---|---|
input |
Bắt buộc. Chuỗi văn bản cần tìm kiếm. |
locationBias |
Không bắt buộc. Bù trừ kết quả tới một vị trí được chỉ định. Bạn chỉ được đặt tối đa một trong hai giá trị |
locationRestriction |
Không bắt buộc. Hạn chế kết quả trong một vị trí được chỉ định. Bạn chỉ được đặt tối đa một trong hai giá trị |
includedPrimaryTypes[] |
Không bắt buộc. Bao gồm loại Địa điểm chính (ví dụ: "nhà hàng" hoặc "gas_station") từ https://developers.google.com/maps/documentation/places/web-service/place-types. Địa điểm chỉ được trả về nếu loại chính của địa điểm đó được đưa vào danh sách này. Bạn có thể chỉ định tối đa 5 giá trị. Nếu không có loại nào được chỉ định, tất cả các loại Địa điểm sẽ được trả về. |
includedRegionCodes[] |
Không bắt buộc. Chỉ bao gồm kết quả trong các khu vực được chỉ định, được chỉ định ở mức tối đa 15 mã vùng hai ký tự CLDR. Việc để trống nhóm sẽ không hạn chế các kết quả. Nếu bạn đặt cả |
languageCode |
Không bắt buộc. Ngôn ngữ mà kết quả trả về. Giá trị mặc định là en-US. Kết quả có thể bằng nhiều ngôn ngữ nếu ngôn ngữ được sử dụng trong |
regionCode |
Không bắt buộc. Mã vùng, được chỉ định dưới dạng mã vùng gồm hai ký tự CLDR. Điều này ảnh hưởng đến định dạng địa chỉ, thứ hạng của kết quả và có thể ảnh hưởng đến những kết quả được trả về. Điều này không hạn chế kết quả trong khu vực được chỉ định. Để chỉ hiển thị kết quả theo một khu vực, hãy dùng |
origin |
Không bắt buộc. Điểm gốc để tính khoảng cách trắc địa đến điểm đến (được trả về là |
inputOffset |
Không bắt buộc. Độ lệch ký tự Unicode dựa trên 0 của Nếu trống, giá trị mặc định sẽ là độ dài |
includeQueryPredictions |
Không bắt buộc. Nếu đúng, câu trả lời sẽ bao gồm cả các gợi ý về địa điểm và truy vấn. Nếu không, câu trả lời sẽ chỉ trả về các gợi ý về Địa điểm. |
sessionToken |
Không bắt buộc. Một chuỗi xác định phiên Tự động hoàn thành cho mục đích thanh toán. Phải là chuỗi base64 an toàn cho URL và tên tệp, có độ dài tối đa là 36 ký tự ASCII. Nếu không, hệ thống sẽ trả về lỗi INVALID_ qu. Phiên bắt đầu khi người dùng bắt đầu nhập truy vấn và kết thúc khi họ chọn một địa điểm và thực hiện cuộc gọi đến Chi tiết địa điểm hoặc Xác thực địa chỉ. Mỗi phiên có thể có nhiều truy vấn, theo sau là một yêu cầu Thông tin chi tiết về địa điểm hoặc Yêu cầu xác thực địa chỉ. Thông tin đăng nhập được dùng cho từng yêu cầu trong một phiên phải thuộc cùng một dự án trên Google Cloud Console. Sau khi một phiên kết thúc, mã thông báo này không còn hợp lệ nữa. Ứng dụng phải tạo một mã thông báo mới cho mỗi phiên. Nếu tham số Bạn nên làm theo các nguyên tắc sau:
|
Nội dung phản hồi
Proto của phản hồi cho places.autocomplete.
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 |
---|
{
"suggestions": [
{
object ( |
Trường | |
---|---|
suggestions[] |
Chứa danh sách các đề xuất, được sắp xếp theo thứ tự mức độ liên quan giảm dần. |
LocationBias
Khu vực sẽ tìm kiếm. Kết quả có thể không chính xác xung quanh khu vực được chỉ định.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường hợp
|
|
rectangle |
Một khung nhìn được xác định bởi một góc ở phía Đông Bắc và một góc Tây Nam. |
circle |
Một đường tròn được xác định bởi một điểm ở tâm và bán kính. |
LocationRestriction
Khu vực sẽ tìm kiếm. Kết quả sẽ được giới hạn ở khu vực được chỉ định.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường hợp
|
|
rectangle |
Một khung nhìn được xác định bởi một góc ở phía Đông Bắc và một góc Tây Nam. |
circle |
Một đường tròn được xác định bởi một điểm ở tâm và bán kính. |
Đề xuất
Kết quả đề xuất Tự động hoàn thành.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường hợp
|
|
placePrediction |
Dự đoán cho một Địa điểm. |
queryPrediction |
Dự đoán cho một truy vấn. |
PlacePrediction
Kết quả dự đoán cho một cụm từ dự đoán Tự động hoàn thành theo địa điểm.
Biểu diễn dưới dạng JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Trường | |
---|---|
place |
Tên tài nguyên của Địa điểm được đề xuất. Tên này có thể được sử dụng trong các API khác chấp nhận Tên địa điểm. |
placeId |
Giá trị nhận dạng duy nhất của Địa điểm được đề xuất. Số nhận dạng này có thể được sử dụng trong các API khác chấp nhận ID địa điểm. |
text |
Chứa tên mà con người có thể đọc được của kết quả được trả về. Đối với kết quả thành lập, đây thường là tên và địa chỉ doanh nghiệp.
Văn bản này có thể khác với Có thể hỗ trợ nhiều ngôn ngữ nếu yêu cầu |
structuredFormat |
Bảng chi tiết dự đoán Địa điểm thành văn bản chính có chứa tên của Địa điểm và văn bản phụ chứa các đối tượng phân biệt bổ sung (chẳng hạn như một thành phố hoặc khu vực).
|
types[] |
Danh sách các loại phù hợp với Địa điểm này trong Bảng A hoặc Bảng B trong https://developers.google.com/maps/documentation/places/web-service/place-types. Một loại là phân loại một Địa điểm. Các địa điểm có loại chung sẽ có các đặc điểm tương tự. |
distanceMeters |
Chiều dài của đường trắc địa tính bằng mét từ |
FormattableText
Văn bản biểu thị thông tin dự đoán về Địa điểm hoặc cụm từ tìm kiếm. Văn bản có thể được sử dụng nguyên trạng hoặc định dạng.
Biểu diễn dưới dạng JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Trường | |
---|---|
text |
Văn bản có thể được dùng nguyên trạng hoặc định dạng bằng |
matches[] |
Danh sách các dải ô xác định vị trí yêu cầu đầu vào khớp trong Các giá trị này là độ lệch ký tự Unicode của |
StringRange
Xác định chuỗi con trong một văn bản nhất định.
Biểu diễn dưới dạng JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Trường | |
---|---|
startOffset |
Độ lệch dựa trên 0 của ký tự Unicode đầu tiên của chuỗi (bao gồm). |
endOffset |
Độ lệch dựa trên 0 của ký tự Unicode cuối cùng (không bao gồm). |
StructuredFormat
Chứa bảng chi tiết dự đoán địa điểm hoặc truy vấn thành văn bản chính và văn bản phụ.
Đối với các dự đoán về Địa điểm, văn bản chính có chứa tên cụ thể của Địa điểm đó. Đối với các truy vấn dự đoán, văn bản chính sẽ chứa truy vấn đó.
Văn bản phụ chứa các đối tượng địa lý khác biệt bổ sung (chẳng hạn như một thành phố hoặc vùng) để xác định thêm Địa điểm hoặc tinh chỉnh truy vấn.
Biểu diễn dưới dạng JSON |
---|
{ "mainText": { object ( |
Trường | |
---|---|
mainText |
Đại diện cho tên của Địa điểm hoặc truy vấn. |
secondaryText |
Đại diện cho các đối tượng địa lý khác nhau (chẳng hạn như một thành phố hoặc khu vực) để xác định thêm Địa điểm hoặc tinh chỉnh truy vấn. |
QueryPrediction
Kết quả dự đoán cho cụm từ dự đoán Tự động hoàn thành truy vấn.
Biểu diễn dưới dạng JSON |
---|
{ "text": { object ( |
Trường | |
---|---|
text |
Nội dung được dự đoán. Văn bản này không đại diện cho Địa điểm mà là một cụm từ tìm kiếm văn bản có thể dùng trong điểm cuối tìm kiếm (ví dụ: Tìm kiếm văn bản).
Có thể hỗ trợ nhiều ngôn ngữ nếu yêu cầu |
structuredFormat |
Bảng chi tiết dự đoán cụm từ tìm kiếm thành văn bản chính chứa cụm từ tìm kiếm và văn bản phụ chứa các đối tượng riêng biệt khác (chẳng hạn như một thành phố hoặc vùng).
|