Method: query.sources.list

Menampilkan daftar sumber yang dapat digunakan pengguna untuk API query.search dan Suggest.

Catatan: API ini memerlukan akun pengguna akhir standar agar dapat dijalankan. Akun layanan tidak dapat melakukan permintaan Query API secara langsung. Untuk menggunakan akun layanan guna menjalankan kueri, siapkan delegasi otoritas seluruh domain Google Workspace.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
requestOptions

object (RequestOptions)

Opsi permintaan, seperti aplikasi penelusuran dan zona waktu pengguna.
pageToken

string

Jumlah sumber yang akan ditampilkan dalam respons.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons daftar sumber.

Representasi JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Kolom
sources[]

object (QuerySource)
nextPageToken

string

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Untuk informasi selengkapnya, lihat Panduan otorisasi.

QuerySource

Daftar sumber yang dapat ditelusuri pengguna menggunakan API kueri.

Representasi JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Kolom
source

object (Source)

Nama sumber
shortName

string

Nama pendek atau alias untuk sumber. Nilai ini dapat digunakan dengan operator 'source'.
displayName

string

Nama tampilan sumber data.
operators[]

object (QueryOperator)

Daftar semua operator yang berlaku untuk sumber ini.

QueryOperator

Definisi operator yang dapat digunakan dalam permintaan query.search/query.suggestions.

Representasi 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
}
Kolom
operatorName

string

Nama operator.
lessThanOperatorName

string

Menunjukkan nama operator yang dapat digunakan untuk mengisolasi properti menggunakan operator kurang-dari.
greaterThanOperatorName

string

Menunjukkan nama operator yang dapat digunakan untuk mengisolasi properti menggunakan operator lebih besar dari.
type

enum (QueryOperator.Type)

Jenis operator.
displayName

string

Nama tampilan operator
isSortable

boolean

Dapatkah operator ini digunakan untuk mengurutkan hasil.
isFacetable

boolean

Dapatkah operator ini digunakan untuk mendapatkan faset.
isReturnable

boolean

Apakah properti yang terkait dengan faset ini akan ditampilkan sebagai bagian dari hasil penelusuran.
isRepeatable

boolean

Menunjukkan apakah beberapa nilai dapat ditetapkan untuk properti ini.
isSuggestable

boolean

Bisa mendapatkan saran untuk kolom ini.
enumValues[]

string

Daftar nilai potensial untuk kolom opeatror. Kolom ini hanya diisi jika kami dapat menghitung semua kemungkinan nilai dari operator ini dengan aman.
objectType

string

Nama objek yang sesuai dengan operator. Kolom ini hanya diisi untuk operator khusus skema, dan tidak disetel untuk operator umum.

QueryOperator.Type

Jenis properti yang dirujuk oleh operator.

Enum
UNKNOWN Nilai tidak valid.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML