Method: query.sources.list

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

Uwaga: do wykonania tej operacji 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 zapytania, takie jak aplikacja wyszukiwania 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:

Odpowiedź dotycząca ź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 dotyczącym autoryzacji.

QuerySource

Lista źródeł, w których 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żna używać z operatorem „source”.
displayName

string

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

object (QueryOperator)

Lista wszystkich operatorów dostępnych w danym źródle.

QueryOperator

Definicja operatora, którego można użyć 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, który można użyć do wyodrębnienia właściwości za pomocą operatora mniejszości.
greaterThanOperatorName

string

Wskazuje nazwę operatora, którego można użyć do wyodrębnienia właściwości za pomocą operatora „większe niż”.
type

enum (QueryOperator.Type)

Typ operatora.
displayName

string

Wyświetlana nazwa operatora
isSortable

boolean

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

boolean

Czy tego operatora można użyć do uzyskania aspektów?
isReturnable

boolean

Czy usługa powiązana z tym aspektem będzie zwracana w ramach wyników wyszukiwania.
isRepeatable

boolean

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

boolean

Może wyświetlać sugestie dotyczące tego pola.
enumValues[]

string

Potencjalna lista wartości dla pola opeatror. To pole jest wypełniane tylko wtedy, gdy możemy bezpiecznie wymienić wszystkie możliwe wartości tego operatora.
objectType

string

Nazwa obiektu odpowiadającego operatorowi. To pole jest wypełniane tylko w przypadku operatorów związanych ze schematem, a nie w przypadku operatorów wspólnych.

QueryOperator.Type

Typ usługi, do której odwołuje się operator.

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