- Yêu cầu HTTP
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- QuerySource
- QueryOperator (Toán tử truy vấn)
- QueryOperator.Type
- Hãy làm thử!
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 |
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 |
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 ( |
Các trường | |
---|---|
sources[] |
|
nextPageToken |
|
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 ( |
Các trường | |
---|---|
source |
Tên của nguồn |
shortName |
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 |
Tên hiển thị của nguồn dữ liệu. |
operators[] |
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 ( |
Các trường | |
---|---|
operatorName |
Tên của toán tử. |
lessThanOperatorName |
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 |
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 |
Loại toán tử. |
displayName |
Tên hiển thị của toán tử |
isSortable |
Có thể dùng toán tử này để sắp xếp kết quả không? |
isFacetable |
Có thể sử dụng toán tử này để nhận các thuộc tính không. |
isReturnable |
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 |
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 |
Có thể nhận nội dung đề xuất cho trường này. |
enumValues[] |
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 |
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 |