Cloud Search API

Cloud Search udostępnia działające w chmurze funkcje wyszukiwania danych Google Workspace. Interfejs Cloud Search API umożliwia indeksowanie danych spoza Google Workspace w Cloud Search.

Usługa: cloudsearch.googleapis.com

Do wywoływania tej usługi zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli do wywoływania tej usługi aplikacja musi używać Twoich własnych bibliotek, podczas tworzenia żądań do interfejsu API użyj podanych niżej informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i ich używanie. Służy do tworzenia bibliotek klienta, wtyczek IDE i innych narzędzi, które współdziałają z interfejsami API Google. Jedna usługa może dostarczać wiele dokumentów opisujących. Ta usługa dostarcza następujący dokument opisujący interfejs API:

Punkt końcowy usługi

Punkt końcowy usługi to podstawowy adres URL, który określa adres sieciowy usługi interfejsu API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy i wszystkie poniższe identyfikatory URI są względne wobec tego punktu końcowego:

  • https://cloudsearch.googleapis.com

Zasób REST: v1

Metody
initializeCustomer
(POST /v1:initializeCustomer) Włącza obsługę third party w Google Cloud Search.

Zasób REST: v1.debug.datasources.items

Metody
checkAccess
(POST /v1/debug/{name=datasources/*/items/*}:checkAccess) Sprawdza, czy element jest dostępny dla określonego podmiotu zabezpieczeń.
searchByViewUrl
(POST /v1/debug/{name=datasources/*}/items:searchByViewUrl) Pobiera element, którego parametr viewUrl dokładnie odpowiada adresowi URL podanym w żądaniu.

Zasób REST: v1.debug.datasources.items.unmappedids

Metody
list
(GET /v1/debug/{parent=datasources/*/items/*}/unmappedids) Podaj wszystkie niezmapowane tożsamości związane z określonym elementem.

Zasób REST: v1.debug.identitysources.items

Metody
listForunmappedidentity
(GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity) Wyświetla listę nazw elementów powiązanych z niezmapowaną tożsamością.

Zasób REST: v1.debug.identitysources.unmappedids

Metody
list
(GET /v1/debug/{parent=identitysources/*}/unmappedids) Wyświetla niezmapowane tożsamości użytkowników dla źródła tożsamości.

Zasób REST: v1.indexing.datasources

Metody
deleteSchema
(DELETE /v1/indexing/{name=datasources/*}/schema) Usuwa schemat źródła danych.
getSchema
(GET /v1/indexing/{name=datasources/*}/schema) Pobiera schemat źródła danych.
updateSchema
(PUT /v1/indexing/{name=datasources/*}/schema) Aktualizuje schemat źródła danych.

Zasób REST: v1.indexing.datasources.items

Metody
delete
(DELETE /v1/indexing/{name=datasources/*/items/*}) Usuwa Item resource dla określonej nazwy zasobu.
deleteQueueItems
(POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems) Usuwa wszystkie elementy w kolejce.
get
(GET /v1/indexing/{name=datasources/*/items/*}) Pobiera wartość Item resource według nazwy elementu.
index
(POST /v1/indexing/{item.name=datasources/*/items/*}:index) Aktualizuje listę kontroli dostępu, metadane i treści Item.
list
(GET /v1/indexing/{name=datasources/*}/items) Wyświetla wszystkie elementy lub ich podzbiór Item resources.
poll
(POST /v1/indexing/{name=datasources/*}/items:poll) Sonduje o niezarezerwowane elementy z kolejki indeksowania i oznacza zestaw jako zarezerwowany, zaczynając od elementów o najstarszej sygnaturze czasowej o najwyższym priorytecie (ItemStatus).
push
(POST /v1/indexing/{item.name=datasources/*/items/*}:push) Przenosi element do kolejki na potrzeby późniejszego odpytywania i aktualizowania.
unreserve
(POST /v1/indexing/{name=datasources/*}/items:unreserve) Anuluje rezerwowanie wszystkich elementów z kolejki, przez co wszystkie mogą być badane.
upload
(POST /v1/indexing/{name=datasources/*/items/*}:upload) Tworzy sesję przesyłania, podczas której można przesłać zawartość produktu.

Zasób REST: v1.media

Metody
upload
(POST /v1/media/{resourceName=**})
POST /upload/v1/media/{resourceName=**} Przesyła pliki multimedialne do zindeksowania.

Zasób REST: v1.operations

Metody
get
(GET /v1/{name=operations/**}) Pobiera najnowszy stan długo trwającej operacji.

Zasób REST: v1.query

Metody
search
(POST /v1/query/search) Interfejs Cloud Search Query API udostępnia metodę wyszukiwania, która zwraca najtrafniejsze wyniki zapytania użytkownika.
suggest
(POST /v1/query/suggest) Udostępnia sugestie dotyczące automatycznego uzupełniania zapytania.

Zasób REST: v1.query.sources

Metody
list
(GET /v1/query/sources) Zwraca listę źródeł, których użytkownik może używać w interfejsach API wyszukiwania i sugestii.

Zasób REST: v1.settings

Metody
getCustomer
(GET /v1/settings/customer) Pobierz ustawienia klienta.
updateCustomer
(PATCH /v1/settings/customer) Zaktualizuj ustawienia klienta.

Zasób REST: v1.settings.datasources

Metody
create
(POST /v1/settings/datasources) Tworzy źródło danych.
delete
(DELETE /v1/settings/{name=datasources/*}) Usuwa źródło danych.
get
(GET /v1/settings/{name=datasources/*}) Pobiera źródło danych.
list
(GET /v1/settings/datasources) Wyświetla listę źródeł danych.
patch
(PATCH /v1/settings/{source.name=datasources/*}) Aktualizuje źródło danych.
update
(PUT /v1/settings/{source.name=datasources/*}) Aktualizuje źródło danych.

Zasób REST: v1.settings.searchapplications

Metody
create
(POST /v1/settings/searchapplications) Tworzy wyszukiwarkę.
delete
(DELETE /v1/settings/{name=searchapplications/*}) Usuwa wyszukiwarkę.
get
(GET /v1/settings/{name=searchapplications/*}) Pobiera określoną wyszukiwarkę.
list
(GET /v1/settings/searchapplications) Wyświetla listę wszystkich wyszukiwarek.
patch
(PATCH /v1/settings/{searchApplication.name=searchapplications/*}) Aktualizuje wyszukiwarkę.
reset
(POST /v1/settings/{name=searchapplications/*}:reset) Resetuje wyszukiwarkę do ustawień domyślnych.
update
(PUT /v1/settings/{searchApplication.name=searchapplications/*}) Aktualizuje wyszukiwarkę.

Zasób REST: v1.stats

Metody
getIndex
(GET /v1/stats/index) Pobiera statystyki zindeksowanych produktów agregowane ze wszystkich źródeł danych.
getQuery
(GET /v1/stats/query) Pobieranie statystyk zapytań dotyczących klienta.
getSearchapplication
(GET /v1/stats/searchapplication) Pobierz statystyki wyszukiwarki dla klienta.
getSession
(GET /v1/stats/session) Poznaj liczbę sesji wyszukiwania, odsetek sesji zakończonych powodzeniem ze statystykami zapytań dla klienta.
getUser
(GET /v1/stats/user) Pobieranie statystyk użytkowników dotyczących klienta.

Zasób REST: v1.stats.index.datasources

Metody
get
(GET /v1/stats/index/{name=datasources/*}) Pobiera statystyki zindeksowanych elementów dla pojedynczego źródła danych.

Zasób REST: v1.stats.query.searchapplications

Metody
get
(GET /v1/stats/query/{name=searchapplications/*}) Pobieranie statystyk zapytań dla wyszukiwarki.

Zasób REST: v1.stats.session.searchapplications

Metody
get
(GET /v1/stats/session/{name=searchapplications/*}) Poznaj liczbę sesji wyszukiwania, czyli odsetek udanych sesji ze statystykami zapytań dotyczących wyszukiwarki.

Zasób REST: v1.stats.user.searchapplications

Metody
get
(GET /v1/stats/user/{name=searchapplications/*}) Pobieranie statystyk użytkowników wyszukiwarki.