Method: places.searchText

Tìm kiếm địa điểm dựa trên truy vấn văn bản.

Yêu cầu HTTP

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

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
{
  "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)
  }
}
Trường
textQuery

string

Bắt buộc. Truy vấn văn bản để tìm kiếm bằng văn bản.

languageCode

string

Thông tin chi tiết về địa điểm sẽ hiển thị cùng với ngôn ngữ ưu tiên (nếu có). Nếu mã ngôn ngữ không được xác định hoặc không nhận dạng được, thì hệ thống có thể trả về thông tin chi tiết về địa điểm của bất kỳ ngôn ngữ nào, trong đó ưu tiên tiếng Anh nếu có các chi tiết đó.

Danh sách ngôn ngữ hiện được hỗ trợ: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Mã quốc gia/khu vực Unicode (CLDR) của vị trí gửi yêu cầu. Thông số này dùng để hiển thị thông tin chi tiết về địa điểm, như tên địa điểm theo khu vực cụ thể, nếu có. Tuỳ theo luật hiện hành, thông số này có thể ảnh hưởng đến kết quả.

Để biết thêm thông tin, hãy truy cập vào https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Xin lưu ý rằng mã vùng 3 chữ số hiện chưa được hỗ trợ.

rankPreference

enum (RankPreference)

Cách xếp hạng kết quả trong câu trả lời.

includedType

string

Loại địa điểm được yêu cầu. Danh sách đầy đủ các loại được hỗ trợ: https://developers.google.com/maps/documentation/places/web-service/place-types. Chỉ hỗ trợ một loại được bao gồm.

openNow

boolean

Dùng để hạn chế tìm kiếm ở những địa điểm hiện đang mở cửa. Giá trị mặc định là "false".

minRating

number

Lọc ra những kết quả có điểm xếp hạng trung bình của người dùng hoàn toàn thấp hơn giới hạn này. Giá trị hợp lệ phải là số thực từ 0 đến 5 (bao gồm) ở nhịp 0,5, tức là [0, 0.5, 1.0, ... , 5.0]. Điểm đánh giá đầu vào sẽ làm tròn đến khoảng 0,5(trần) gần nhất. Ví dụ: điểm xếp hạng là 0, 6 sẽ loại bỏ tất cả các kết quả có điểm xếp hạng nhỏ hơn 1.0.

maxResultCount
(deprecated)

integer

Không dùng nữa: Chuyển sang dùng pageSize.

Số lượng kết quả tối đa trên mỗi trang có thể được trả về. Nếu số lượng kết quả có sẵn lớn hơn maxResultCount, nextPageToken sẽ được trả về và có thể được chuyển đến pageToken để nhận trang kết quả tiếp theo trong các yêu cầu tiếp theo. Nếu giá trị là 0 hoặc không có giá trị nào được cung cấp, thì giá trị mặc định sẽ là 20. Giá trị tối đa là 20; các giá trị lớn hơn 20 sẽ bị buộc thành 20. Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

Nếu bạn chỉ định cả maxResultCountpageSize, thì maxResultCount sẽ bị bỏ qua.

pageSize

integer

Không bắt buộc. Số lượng kết quả tối đa trên mỗi trang có thể được trả về. Nếu số lượng kết quả có sẵn lớn hơn pageSize, nextPageToken sẽ được trả về và có thể được chuyển đến pageToken để nhận trang kết quả tiếp theo trong các yêu cầu tiếp theo. Nếu giá trị là 0 hoặc không có giá trị nào được cung cấp, thì giá trị mặc định sẽ là 20. Giá trị tối đa là 20; các giá trị trên 20 sẽ được đặt thành 20. Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

Nếu bạn chỉ định cả maxResultCountpageSize, thì maxResultCount sẽ bị bỏ qua.

pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ cuộc gọi TextSearch trước đó. Cung cấp mã này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác ngoài pageToken, pageSizemaxResultCount được cung cấp cho TextSearch phải khớp với lệnh gọi ban đầu đã cung cấp mã thông báo trang. Nếu không, lỗi INVALID_ARGUMENT sẽ được trả về.

priceLevels[]

enum (PriceLevel)

Dùng để hạn chế tìm kiếm ở những địa điểm được đánh dấu là có các mức giá nhất định. Người dùng có thể chọn bất kỳ tổ hợp mức giá nào. Mặc định là chọn tất cả mức giá.

strictTypeFiltering

boolean

Dùng để đặt chế độ lọc loại nghiêm ngặt cho includeType. Nếu bạn đặt chính sách này thành true, thì hệ thống sẽ chỉ trả về kết quả cùng loại. Giá trị mặc định là false.

locationBias

object (LocationBias)

Khu vực cần tìm kiếm. Vị trí này được thể hiện dưới dạng sự thiên vị, nghĩa là kết quả xung quanh vị trí đã cho có thể được trả về. Không thể đặt cùng với locationRestriction.

locationRestriction

object (LocationRestriction)

Khu vực cần tìm kiếm. Vị trí này đóng vai trò là một quy định hạn chế, tức là sẽ không trả về các kết quả nằm ngoài vị trí đã cho. Không thể đặt cùng với locationBias.

evOptions

object (EVOptions)

Không bắt buộc. Đặt các tuỳ chọn xe điện có thể tìm kiếm được của một yêu cầu tìm kiếm địa điểm.

Nội dung phản hồi

Proto phản hồi cho places.searchText.

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 (Place)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
Trường
places[]

object (Place)

Danh sách địa điểm đáp ứng tiêu chí tìm kiếm văn bản của người dùng.

contextualContents[]

object (ContextualContent)

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

Danh sách nội dung theo ngữ cảnh, trong đó mỗi mục nhập liên kết với địa điểm tương ứng trong cùng một chỉ mục trong trường địa điểm. Các nội dung liên quan đến textQuery trong yêu cầu sẽ được ưu tiên. Nếu không có nội dung theo ngữ cảnh cho một trong các địa điểm, thì trang này sẽ trả về nội dung không theo ngữ cảnh. Trường này sẽ chỉ trống khi không có nội dung cho địa điểm này. Danh sách này phải có nhiều mục nhập như danh sách các địa điểm nếu được yêu cầu.

nextPageToken

string

Mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua hoặc trống thì sẽ không có trang tiếp theo.

RankPreference

Cách xếp hạng kết quả trong câu trả lời.

Enum
RANK_PREFERENCE_UNSPECIFIED Đối với truy vấn theo danh mục, chẳng hạn như "Nhà hàng ở Thành phố New York", RELEVANCE là giá trị mặc định. Đối với các truy vấn không theo danh mục như "Mountain View, CA" bạn không nên đặt layoutPreference.
DISTANCE Xếp hạng kết quả theo khoảng cách.
RELEVANCE Xếp hạng kết quả theo mức độ liên quan. Thứ tự sắp xếp được xác định theo ngăn xếp xếp hạng thông thường.

LocationBias

Khu vực cần tìm kiếm. Vị trí này được thể hiện dưới dạng sự thiên vị, nghĩa là kết quả xung quanh vị trí đã cho có thể được trả về.

Biểu diễn dưới dạng 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.
}
Trường

Trường kết hợp type.

type chỉ có thể là một trong những trạng thái sau đây:

rectangle

object (Viewport)

Một hộp hình chữ nhật được xác định bởi góc Đông Bắc và Tây Nam. rectangle.high() phải là điểm Đông Bắc của khung nhìn hình chữ nhật. rectangle.low() phải là điểm phía Tây Nam của khung nhìn hình chữ nhật. rectangle.low().latitude() không được lớn hơn rectangle.high().latitude(). Điều này sẽ dẫn đến phạm vi vĩ độ trống. Khung nhìn hình chữ nhật không được rộng hơn 180 độ.

circle

object (Circle)

Hình tròn được xác định bởi tâm và bán kính.

LocationRestriction

Khu vực cần tìm kiếm. Vị trí này đóng vai trò là một quy định hạn chế, tức là sẽ không trả về các kết quả nằm ngoài vị trí đã cho.

Biểu diễn dưới dạng JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Trường

Trường kết hợp type.

type chỉ có thể là một trong những trạng thái sau đây:

rectangle

object (Viewport)

Một hộp hình chữ nhật được xác định bởi góc Đông Bắc và Tây Nam. rectangle.high() phải là điểm Đông Bắc của khung nhìn hình chữ nhật. rectangle.low() phải là điểm phía Tây Nam của khung nhìn hình chữ nhật. rectangle.low().latitude() không được lớn hơn rectangle.high().latitude(). Điều này sẽ dẫn đến phạm vi vĩ độ trống. Khung nhìn hình chữ nhật không được rộng hơn 180 độ.

EVOptions

Lựa chọn xe điện có thể tìm kiếm được trong một yêu cầu tìm kiếm địa điểm.

Biểu diễn dưới dạng JSON
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Trường
minimumChargingRateKw

number

Không bắt buộc. Tốc độ sạc tối thiểu bắt buộc (tính bằng kilowatt). Một địa điểm có mức tính phí thấp hơn mức đã chỉ định sẽ bị lọc ra.

connectorTypes[]

enum (EVConnectorType)

Không bắt buộc. Danh sách các loại giắc cắm xe điện ưu tiên. Hệ thống sẽ lọc ra một địa điểm không hỗ trợ bất kỳ loại trình kết nối nào được liệt kê.

ContextualContent

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

Nội dung theo ngữ cảnh cho truy vấn địa điểm.

Biểu diễn dưới dạng JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Trường
reviews[]

object (Review)

Danh sách các bài đánh giá về địa điểm này, liên quan đến cụm từ tìm kiếm về địa điểm.

photos[]

object (Photo)

Thông tin (bao gồm cả tài liệu tham khảo) về hình ảnh của địa điểm này, liên quan đến cụm từ tìm kiếm về địa điểm.

justifications[]

object (Justification)

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

Thông tin giải thích cho địa điểm.

Lý giải

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

Thông tin giải thích cho địa điểm. Giải thích trả lời cho câu hỏi tại sao một địa điểm lại có thể thu hút người dùng cuối.

Biểu diễn dưới dạng 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.
}
Trường

Trường kết hợp justification.

justification chỉ có thể là một trong những trạng thái sau đây:

reviewJustification

object (ReviewJustification)

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

ReviewJustification

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết.

Lý do cho bài đánh giá của người dùng. Việc này làm nổi bật một mục trong bài đánh giá của người dùng mà người dùng cuối quan tâm. Ví dụ: nếu cụm từ tìm kiếm là "pizza củi", phần lý do đánh giá sẽ đánh dấu văn bản có liên quan đến cụm từ tìm kiếm.

Biểu diễn dưới dạng JSON
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Trường
highlightedText

object (HighlightedText)

review

object (Review)

Bài đánh giá tạo văn bản được đánh dấu.

HighlightedText

Văn bản được đánh dấu trong phần lý do. Đây là một phần của bài đánh giá. Từ chính xác cần làm nổi bật được đánh dấu bằng HighlightedTextText. Có thể có một vài từ trong văn bản được đánh dấu.

Biểu diễn dưới dạng JSON
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
Trường
text

string

highlightedTextRanges[]

object (HighlightedTextRange)

Danh sách dải ô của văn bản được đánh dấu.

HighlightedTextRange

Phạm vi của văn bản được đánh dấu.

Biểu diễn dưới dạng JSON
{
  "startIndex": integer,
  "endIndex": integer
}
Trường
startIndex

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Thử nghiệm: Xem https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative để biết thêm chi tiết. Lý do cho thuộc tính BusinessAvailabilityAttributes. Biểu đồ này cho biết một số đặc điểm của một doanh nghiệp có thể thu hút người dùng cuối.

Biểu diễn dưới dạng JSON
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Trường
takeout

boolean

Nếu một địa điểm phục vụ đồ ăn mang đi.

delivery

boolean

Nếu một địa điểm cung cấp dịch vụ giao hàng.

dineIn

boolean

Nếu một địa điểm có phục vụ ăn tại chỗ.