Method: query.sources.list

Trả về danh sách các nguồn mà người dùng có thể sử dụng cho các API query.search và Đề xuất.

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 của Google Workspace.

Yêu cầu HTTP

GET https://cloudsearch.googleapis.com/v1/query/sources

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Các tham số
requestOptions

object (RequestOptions)

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.
pageToken

string

Số nguồn để trả về trong phản hồi.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

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ác nguồn danh sách.

Biểu diễn dưới dạng JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Các trường
sources[]

object (QuerySource)
nextPageToken

string

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.

QuerySource

Danh sách các nguồn mà người dùng có thể tìm kiếm bằng query API (API truy vấn).

Biểu diễn dưới dạng JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Các trường
source

object (Source)

Tên của nguồn
shortName

string

Tên ngắn hoặc biệt hiệu của nguồn. Bạn có thể dùng giá trị này với toán tử "source".
displayName

string

Tên hiển thị của nguồn dữ liệu.
operators[]

object (QueryOperator)

Danh sách tất cả toán tử có thể áp dụng cho nguồn này.

QueryOperator

Định nghĩa về toán tử có thể dùng trong yêu cầu query.search/query.suggest.

Biểu diễn dưới dạng JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
Các trường
operatorName

string

Tên của toán tử.
lessThanOperatorName

string

Cho biết tên toán tử có thể dùng để tách biệt thuộc tính bằng toán tử nhỏ hơn.
greaterThanOperatorName

string

Cho biết tên toán tử có thể dùng để tách biệt thuộc tính bằng toán tử lớn hơn.
type

enum (QueryOperator.Type)

Loại toán tử.
displayName

string

Tên hiển thị của toán tử
isSortable

boolean

Có thể dùng toán tử này để sắp xếp kết quả không?
isFacetable

boolean

Có thể sử dụng toán tử này để nhận các thuộc tính không.
isReturnable

boolean

Thuộc tính liên kết với thuộc tính này có được trả về như một phần của kết quả tìm kiếm không.
isRepeatable

boolean

Cho biết liệu bạn có thể đặt nhiều giá trị cho tài sản này hay không.
isSuggestable

boolean

Có thể nhận nội dung đề xuất cho trường này.
enumValues[]

string

Danh sách giá trị có thể cho trường mở. Trường này chỉ được điền khi chúng ta có thể liệt kê tất cả giá trị có thể có của toán tử này một cách an toàn.
objectType

string

Tên của đối tượng tương ứng với toán tử. Trường này chỉ được điền cho các toán tử theo giản đồ cụ thể và không được đặt cho các toán tử phổ biến.

QueryOperator.Type

Loại thuộc tính do toán tử giới thiệu.

Enum
UNKNOWN Giá trị không hợp lệ.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML