Method: query.sources.list

Kullanıcının query.search ve Suggest API'leri için kullanabileceği kaynakların listesini döndürür.

Not: Bu API'nin yürütülmesi için standart bir son kullanıcı hesabı gerekir. Bir hizmet hesabı, Query API isteklerini doğrudan gerçekleştiremez. Sorgu gerçekleştirmek amacıyla bir hizmet hesabı kullanmak için Google Workspace alanı genelinde yetki verme ayarlarını yapın.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
requestOptions

object (RequestOptions)

Arama uygulaması ve kullanıcı saat dilimi gibi istek seçenekleri.
pageToken

string

Yanıtta döndürülecek kaynak sayısı.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Kaynakları listele yanıtı.

JSON gösterimi 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Alanlar
sources[]

object (QuerySource)
nextPageToken

string

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.

QuerySource

Kullanıcının sorgu API'sini kullanarak arama yapabileceği kaynakların listesi.

JSON gösterimi 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Alanlar
source

object (Source)

Kaynağın adı
shortName

string

Kaynak için kısa ad veya takma ad. Bu değer, "source" operatörüyle kullanılabilir.
displayName

string

Veri kaynağının görünen adı.
operators[]

object (QueryOperator)

Bu kaynak için geçerli olan tüm operatörlerin listesi.

QueryOperator

query.search/query.suggest isteğinde kullanılabilecek bir operatörün tanımı.

JSON gösterimi 
{
  "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
}
Alanlar
operatorName

string

Operatörün adı.
lessThanOperatorName

string

Küçüktür operatörünü kullanarak özelliği ayırmak için kullanılabilecek operatör adını belirtir.
greaterThanOperatorName

string

"Büyüktür" operatörünü kullanarak özelliği ayırmak için kullanılabilecek operatör adını belirtir.
type

enum (QueryOperator.Type)

Operatörün türü.
displayName

string

Operatörün görünen adı
isSortable

boolean

Bu operatör, sonuçları sıralamak için kullanılabilir.
isFacetable

boolean

Bu operatör, özellikleri almak için kullanılabilir.
isReturnable

boolean

Bu özellik ile ilişkilendirilen özellik, arama sonuçlarının bir parçası olarak döndürülür.
isRepeatable

boolean

Bu özellik için birden fazla değer ayarlanıp ayarlanamayacağını belirtir.
isSuggestable

boolean

Bu alan için öneriler alabilir.
enumValues[]

string

İşlem alanı için olası değer listesi. Bu alan yalnızca bu operatörün olası tüm değerlerini güvenli bir şekilde numaralandırabildiğimizde doldurulur.
objectType

string

Operatöre karşılık gelen nesnenin adı. Bu alan yalnızca şemaya özel operatörler için doldurulur ve yaygın operatörler için ayarlanmamıştır.

QueryOperator.Type

Operatör tarafından yönlendirilen mülkün türü.

Sıralamalar
UNKNOWN Geçersiz değer.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML