Method: query.search

API truy vấn Cloud Search cung cấp phương thức tìm kiếm, phương thức này sẽ trả về kết quả phù hợp nhất từ một cụm từ tìm kiếm của người dùng. Kết quả có thể đến từ các ứng dụng của Google Workspace, chẳng hạn như Gmail hoặc Google Drive, hoặc có thể đến từ dữ liệu mà bạn đã lập chỉ mục từ một bên thứ ba.

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/search

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,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
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

Chuỗi truy vấn thô. Xem các toán tử tìm kiếm được hỗ trợ trong phần Dùng toán tử để thu hẹp phạm vi tìm kiếm
pageSize

integer

Số lượng kết quả tìm kiếm tối đa được trả về trong một trang. Giá trị hợp lệ nằm trong khoảng từ 1 đến 100. Giá trị mặc định là 10. Giá trị tối thiểu là 50 khi bạn yêu cầu kết quả vượt quá 2000.
start

integer

Chỉ mục bắt đầu của kết quả.
dataSourceRestrictions[]

object (DataSourceRestriction)

Các nguồn cần dùng để truy vấn. Nếu không chỉ định, tất cả nguồn dữ liệu từ ứng dụng tìm kiếm hiện tại sẽ được sử dụng.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Các lựa chọn để sắp xếp kết quả tìm kiếm
queryInterpretationOptions

object (QueryInterpretationOptions)

tuỳ chọn để diễn giải truy vấn của người dùng.
contextAttributes[]

object (ContextAttribute)

Thuộc tính ngữ cảnh cho yêu cầu sẽ được dùng để điều chỉnh thứ hạng của kết quả tìm kiếm. Số lượng phần tử tối đa là 10.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của SearchResponse.

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.