Cloud Search API

Cloud Search zapewnia funkcje wyszukiwania w chmurze w przypadku danych Google Workspace. Interfejs Cloud Search API umożliwia indeksowanie danych innych niż Google Workspace w Cloud Search.

Usługa: cloudsearch.googleapis.com

Do wywołania tej usługi zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli aplikacja musi wywoływać tę usługę przy użyciu własnych bibliotek, podczas tworzenia żądań interfejsu API należy używać poniższych informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i sposób ich używania. 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 udostępniać 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 odnoszą się do niego:

  • 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 adres viewUrl dokładnie pasuje do adresu URL podanego w żądaniu.

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

Metody
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Wyświetla wszystkie niezmapowane tożsamości w przypadku konkretnego produktu.

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

Metody
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Wypisuje nazwy elementów powiązanych z niezmapowaną tożsamością.

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

Metody
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Wypisuje niezamapowane 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
Usuwanie schematu źródła danych.
getSchema GET /v1/indexing/{name=datasources/*}/schema
Pobiera schemat źródła danych.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
Zaktualizuj schemat źródła danych.

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

Metody
delete DELETE /v1/indexing/{name=datasources/*/items/*}
Usuń Item resource dla określonej nazwy zasobu.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Usuwanie wszystkich elementów z kolejki.
get GET /v1/indexing/{name=datasources/*/items/*}
Pobiera Item resource według nazwy produktu.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Zaktualizuje Item listę kontroli dostępu, metadane i treści.
list GET /v1/indexing/{name=datasources/*}/items
Wyświetla wszystkie lub podzbiór obiektów Item resources.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Wyszukuje 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
Przesyła element do kolejki w celu późniejszego pobierania i aktualizowania.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Odblokowuje wszystkie elementy z kolejki, dzięki czemu wszystkie mogą być dostępne do odczytu.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Tworzy sesję przesyłania do przesyłania treści produktu.

Zasób REST: v1.media

Metody
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Przesyła multimediów na potrzeby indeksowania.

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
debugSearch POST /v1/query:debugSearch
Zwraca informacje debugowania dla Cloud Search Query API, który udostępnia metodę wyszukiwania.
removeActivity POST /v1/query:removeActivity
Zapewnia funkcję usuwania zarejestrowanej aktywności użytkownika.
search POST /v1/query/search
Interfejs Cloud Search Query API udostępnia metodę wyszukiwania, która zwraca najbardziej trafne wyniki dla zapytania użytkownika.
suggest POST /v1/query/suggest
Podaje sugestie autouzupeł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 przypadku interfejsów Search API i Suggest API.

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/*}
Usuwanie źródła danych.
get GET /v1/settings/{name=datasources/*}
Pobiera źródło danych.
list GET /v1/settings/datasources
Wypisuje źródła danych.
patch PATCH /v1/settings/{source.name=datasources/*}
Zaktualizuj źródło danych.
update PUT /v1/settings/{source.name=datasources/*}
Zaktualizuj źródło danych.

Zasób REST: v1.settings.searchapplications

Metody
create POST /v1/settings/searchapplications
Tworzy wyszukiwarkę.
delete DELETE /v1/settings/{name=searchapplications/*}
Usuwanie wyszukiwarki.
get GET /v1/settings/{name=searchapplications/*}
Pobiera wskazaną aplikację wyszukiwania.
list GET /v1/settings/searchapplications
Wyświetla listę wszystkich aplikacji wyszukiwania.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
Zaktualizuj wyszukiwarkę.
reset POST /v1/settings/{name=searchapplications/*}:reset
Zresetuj ustawienia aplikacji wyszukiwania do domyślnych.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Zaktualizuj wyszukiwarkę.

Zasób REST: v1.stats

Metody
getIndex GET /v1/stats/index
Pobiera statystyki zindeksowanych produktów zagregowane we wszystkich źródłach danych.
getQuery GET /v1/stats/query
Uzyskaj statystyki zapytań dotyczące klienta.
getSearchapplication GET /v1/stats/searchapplication
Uzyskaj statystyki dotyczące wyszukiwarki dla klienta.
getSession GET /v1/stats/session
Uzyskaj liczbę sesji wyszukiwania i odsetek udanych sesji z wynikiem kliknięcia statystyk zapytania dla klienta.
getUser GET /v1/stats/user
Uzyskaj statystyki dotyczące użytkowników 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/*}
Pobierz statystyki zapytań dotyczące aplikacji wyszukiwania.

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

Metody
get GET /v1/stats/session/{name=searchapplications/*}
Uzyskaj liczbę sesji wyszukiwania i odsetek udanych sesji z zapytaniami z kliknięciem w przypadku aplikacji wyszukiwania.

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

Metody
get GET /v1/stats/user/{name=searchapplications/*}
Pobierz statystyki dotyczące użytkowników aplikacji wyszukiwania.