Method: query.suggest

Cung cấp các đề 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 tài khoản dịch vụ thực hiện truy vấn, hãy thiết lập tính năng uỷ quyền trên toàn miền 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

Một phần cụm từ tìm kiếm mà các đề xuất tự động hoàn thành sẽ xuất hiện. Ví dụ: nếu truy vấn là "biển", thì máy chủ có thể trả về "mùa", "tìm kiếm", "chim mòng biển", v.v.
dataSourceRestrictions[]

object (DataSourceRestriction)

Nguồn để sử dụng cho nội dung đề xuất. Nếu không 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 Ý: Tính năng đề xuất chỉ được hỗ trợ cho các nguồn sau:

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

Nội dung phản hồi

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

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 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Trường
suggestResults[]

object (SuggestResult)

Danh sách đề xuất.

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/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 được đề xuất sẽ được dùng để 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 hợp hợp nhất suggestion. Chứa siêu dữ liệu bổ sung về cụm từ tìm kiếm được đề xuất. Mã này cũng cho biết loại cụm từ tìm kiếm được đề xuất. Ví dụ: nếu có PeopleSuggestion, thì điều này cho biết rằng suggested_query là một đề xuất về người. suggestion chỉ có thể là một trong những giá trị sau:
querySuggestion

object (QuerySuggestion)

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

object (PeopleSuggestion)

Thẻ này xuất hiện khi đề xuất cho biết một người. Trang này chứa thêm thông tin về người đó, chẳng hạn như tên, mã email, v.v.

QuerySuggestion

Loại này không có trường nào.

Hiện tại, trường này không chứa nội dung nào và 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 chỉ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. Không phải trường nào của đối tượng người cũng được điền sẵn.