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ı, doğrudan Query API isteklerini 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ının 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ılavuzunu inceleyin.

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

Kaynağın kısa adı veya takma adı. Bu değer, "source" (kaynak) ile kullanılabilir operatörümüzü kullanabilirsiniz.
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 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ü kullanarak özelliği izole etmek için kullanılabilecek operatör adını belirtir.
greaterThanOperatorName

string

Büyüktür operatörü kullanarak özelliği izole etmek 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 özellikle ilişkilendirilen özellik, arama sonuçlarının bir parçası olarak döndürülür mü?
isRepeatable

boolean

Bu mülk için birden fazla değer ayarlanıp ayarlanamayacağını gösterir.
isSuggestable

boolean

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

string

Operasyon alanı için olası değer listesi. Bu alan yalnızca bu operatörün tüm olası 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 genel operatörler için ayarlanmaz.

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