Method: query.search

Interfejs Cloud Search query API udostępnia metodę wyszukiwania, która zwraca najbardziej trafne wyniki dla zapytania użytkownika. Wyniki mogą pochodzić z aplikacji Google Workspace, takich jak Gmail czy Dysk Google, lub z danych zindeksowanych przez Ciebie z zewnętrznych źródeł.

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

Żądanie HTTP

POST https://cloudsearch.googleapis.com/v1/query/search

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Pola
requestOptions

object (RequestOptions)

opcje żądania, takie jak aplikacja wyszukiwania i strefa czasowa użytkownika;
query

string

Nieprzetworzony ciąg zapytania. Informacje o obsługiwanych operatorach wyszukiwania znajdziesz w artykule Zawężanie wyszukiwania za pomocą operatorów.
pageSize

integer

Maksymalna liczba wyników wyszukiwania zwracanych na jednej stronie. Prawidłowe wartości to od 1 do 100 (obustronnie domknięte). Wartością domyślną jest 10. Minimalna wartość to 50, jeśli żądane są wyniki poza zakresem 2000.
start

integer

Początkowy indeks wyników.
dataSourceRestrictions[]

object (DataSourceRestriction)

Źródła danych, których chcesz używać do wykonywania zapytań. Jeśli nie zostaną określone, zostaną użyte wszystkie źródła danych z bieżącej aplikacji wyszukiwania.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

opcje sortowania wyników wyszukiwania;
queryInterpretationOptions

object (QueryInterpretationOptions)

opcje interpretowania zapytania użytkownika.
contextAttributes[]

object (ContextAttribute)

atrybuty kontekstu zapytania, które zostaną użyte do dostosowania rankingu wyników wyszukiwania. Maksymalna liczba elementów to 10.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SearchResponse.

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.