Method: query.suggest

Đưa ra đề xuất để tự động hoàn thành truy vấn.

Lưu ý: API này yêu cầu tài khoản người dùng cuối tiêu chuẩn để thực thi. Tài khoản dịch vụ không thể trực tiếp thực hiện các yêu cầu API truy vấn; để sử dụng một tài khoản dịch vụ nhằm thực hiện truy vấn, hãy thiết lập chế độ uỷ quyền trên toàn miền của Google Workspace.

Yêu cầu HTTP

POST https://cloudsearch.googleapis.com/v1/query/suggest

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 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Trường
requestOptions

object (RequestOptions)

Các tuỳ chọn yêu cầu, chẳng hạn như ứng dụng tìm kiếm và múi giờ của người dùng.
query

string

Truy vấn một phần có các đề xuất tự động hoàn thành sẽ hiển thị. Ví dụ: nếu cụm từ tìm kiếm là "sea" thì máy chủ có thể trả về "season", "search", "seagull" và cứ tiếp tục như vậy.
dataSourceRestrictions[]

object (DataSourceRestriction)

Các nguồn có thể dùng để đề xuất nội dung. Nếu không được chỉ định, nguồn dữ liệu sẽ được lấy từ ứng dụng tìm kiếm hiện tại.

LƯU Ý: Nội dung đề xuất chỉ được hỗ trợ cho các nguồn sau đây:

  • Nguồn dữ liệu của bên thứ ba
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Nội dung phản hồi

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:

Phản hồi của API đề xuất.

Biểu diễn dưới dạng JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Trường
suggestResults[]

object (SuggestResult)

Danh sách các đề xuất.

Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

SuggestResult

Một kết quả đề xuất.

Biểu diễn dưới dạng JSON 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
Trường
suggestedQuery

string

Cụm từ tìm kiếm đề xuất sẽ được dùng cho nội dung tìm kiếm khi người dùng nhấp vào cụm từ đề xuất
source

object (Source)

Nguồn của đề xuất.
Trường kết hợp suggestion. Chứa siêu dữ liệu bổ sung về truy vấn đề xuất. Nó cũng cho biết loại truy vấn được đề xuất. Ví dụ: nếu có Đề xuất người dùng, thì kết quả cho biết rằng truy vấn được đề xuất là đề xuất về người. suggestion chỉ có thể là một trong những trạng thái sau đây:
querySuggestion

object (QuerySuggestion)

Trường này sẽ xuất hiện nếu cụm từ tìm kiếm đề xuất hoàn thành từ/cụm từ.
peopleSuggestion

object (PeopleSuggestion)

Giá trị này xuất hiện khi nội dung đề xuất cho biết một người. Thư chứa nhiều thông tin hơn về người đó - như mã email, tên của họ, v.v.

QuerySuggestion

Hiện tại, trường này không chứa bất kỳ thông tin nào mà chỉ được dùng làm chỉ báo cho biết kết quả đề xuất là một cụm từ hoàn thành.

PeopleSuggestion

Trường này chứa thông tin về người được đề xuất.

Biểu diễn dưới dạng JSON 
{
  "person": {
    object (Person)
  }
}
Trường
person

object (Person)

Người được đề xuất. Tất cả các trường của đối tượng người có thể không được điền sẵn.