Method: query.sources.list

Trả về danh sách các nguồn mà người dùng có thể sử dụng cho API Tìm kiếm 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 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

Thông số
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.
pageToken

string

Số lượng nguồn sẽ 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

Phản hồi danh sách nguồn.

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 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
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 nguồn mà người dùng có thể tìm kiếm bằng API truy vấn.

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

object (Source)

Tên nguồn
shortName

string

Tên ngắn hoặc bí danh cho nguồn. Bạn có thể sử dụng giá trị này với toán tử "nguồn".
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ử áp dụng cho nguồn này.

QueryOperator

Định nghĩa về toán tử có thể được sử dụng trong yêu cầu Tìm kiếm/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
}
Trường
operatorName

string

Tên của nhà mạng.
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 riêng 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 nhà mạng
isSortable

boolean

Có thể sử 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 để lấy các mặt không?
isReturnable

boolean

Tài sản được liên kết với phương diện này có được trả về trong kết quả tìm kiếm không.
isRepeatable

boolean

Cho biết liệu có thể đặt nhiều giá trị cho thuộc tính này hay không.
isSuggestable

boolean

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

string

Danh sách các giá trị tiềm năng cho trường toán tử. Trường này chỉ được điền khi chúng ta có thể liệt kê an toàn tất cả các giá trị có thể có của toán tử này.
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ử dành riêng cho giản đồ và không được đặt cho các toán tử phổ biến.

QueryOperator.Type

Loại thuộc tính mà toán tử tham chiếu đến.

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