Method: query.sources.list

Zwraca listę źródeł, których użytkownik może używać na potrzeby interfejsów API query.search i Suggest.

Uwaga: do wykonania tego interfejsu API wymagane jest standardowe konto użytkownika. Konto usługi nie może bezpośrednio wykonywać żądań do interfejsu Query API. Aby używać konta usługi do wykonywania zapytań, skonfiguruj przekazywanie uprawnień w całej domenie Google Workspace.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
requestOptions

object (RequestOptions)

Opcje żądania, takie jak wyszukiwarka i strefa czasowa użytkownika.
pageToken

string

Liczba źródeł do zwrócenia w odpowiedzi.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Wyświetl odpowiedź z listą źródeł.

Zapis JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Pola
sources[]

object (QuerySource)
nextPageToken

string

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

QuerySource

Lista źródeł, które użytkownik może wyszukiwać za pomocą interfejsu Query API.

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

object (Source)

Nazwa źródła
shortName

string

Krótka nazwa lub alias źródła. Tej wartości możesz używać z operatorem „source”.
displayName

string

Wyświetlana nazwa źródła danych.
operators[]

object (QueryOperator)

Lista wszystkich operatorów mających zastosowanie w przypadku tego źródła.

QueryOperator

Definicja operatora, którego można używać w żądaniu query.search/query.suggest.

Zapis 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
}
Pola
operatorName

string

Nazwa operatora.
lessThanOperatorName

string

Wskazuje nazwę operatora, za pomocą którego można wyodrębnić właściwość za pomocą operatora „mniej niż”.
greaterThanOperatorName

string

Wskazuje nazwę operatora, za pomocą którego można izolować właściwość za pomocą operatora „większe niż”.
type

enum (QueryOperator.Type)

Typ operatora.
displayName

string

Wyświetlana nazwa operatora
isSortable

boolean

Tego operatora można używać do sortowania wyników.
isFacetable

boolean

Tego operatora można używać do pobierania aspektów.
isReturnable

boolean

Czy właściwość powiązana z tym aspektem zostanie zwrócona w wynikach wyszukiwania?
isRepeatable

boolean

Wskazuje, czy dla tej właściwości można ustawić wiele wartości.
isSuggestable

boolean

Może otrzymywać sugestie dotyczące tego pola.
enumValues[]

string

Potencjalnie lista wartości pola nadrzędnego. To pole jest wypełniane tylko wtedy, gdy możemy bezpiecznie wyliczyć wszystkie możliwe wartości tego operatora.
objectType

string

Nazwa obiektu odpowiadająca operatorowi. To pole jest wypełnione tylko w przypadku operatorów specyficznych dla schematu. Nie jest ono skonfigurowane w przypadku typowych operatorów.

QueryOperator.Type

Typ właściwości, do której odwołuje się operator.

Wartości w polu enum
UNKNOWN Nieprawidłowa wartość.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML