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

Zalecamy wywołanie tej usługi przy użyciu 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 określony podmiot zabezpieczeń ma dostęp do elementu.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Pobiera element, którego adres viewUrl dokładnie odpowiada adresowi URL podanemu w żądaniu.

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

Metody
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Wyświetla listę wszystkich nieprzypisanych tożsamości dla konkretnego produktu.

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

Metody
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Zawiera nazwy elementów powiązanych z niezmapowanym identyfikatorem.

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

Metody
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Wyświetla listę niezmapowanych tożsamości użytkowników w przypadku ź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 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
Aktualizuje Item listę kontroli dostępu, metadane i treści.
list GET /v1/indexing/{name=datasources/*}/items
Wyświetla wszystkie lub wybrane elementy Item resources.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Sprawdza w kolejce indeksowania elementy bez rezerwacji i oznacza zestaw jako zarezerwowany, zaczynając od elementów z najstarszym znacznikiem czasu o najwyższym priorytecieItemStatus.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Umieszcza element w kolejce, aby można go było później sprawdzić i zaktualizować.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Cofa rezerwację wszystkich elementów z kolejki, dzięki czemu wszystkie mogą być odpytywane.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Tworzy sesję przesyłania do przesyłania treści dotyczących produktu.

Zasób REST: v1.media

Metody
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Przesyła multimedia do 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
removeActivity POST /v1/query:removeActivity
Umożliwia usunięcie 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 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 interfejsach Search API i Suggest API.

Zasób REST: v1.settings

Metody
getCustomer GET /v1/settings/customer
Pobieranie ustawień klienta.
updateCustomer PATCH /v1/settings/customer
Aktualizowanie ustawień 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
Przywraca domyślne ustawienia aplikacji do wyszukiwania.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Aktualizuje wyszukiwarkę.

Zasób REST: v1.stats

Metody
getIndex GET /v1/stats/index
Pobiera statystyki indeksowanych elementów zagregowane we wszystkich źródłach danych.
getQuery GET /v1/stats/query
Pobieranie statystyk zapytań dotyczących klienta.
getSearchapplication GET /v1/stats/searchapplication
Pobieranie statystyk aplikacji wyszukiwania dla klienta.
getSession GET /v1/stats/session
Uzyskaj liczbę sesji wyszukiwania, odsetek udanych sesji z zapytaniem o kliknięcie i statystyki zapytań dotyczące klienta.
getUser GET /v1/stats/user
Pobierz statystyki 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 jednego ź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 do wyszukiwania.

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

Metody
get GET /v1/stats/session/{name=searchapplications/*}
Uzyskaj liczbę sesji wyszukiwania, odsetek udanych sesji z zapytaniem kliknięcia w przypadku aplikacji do wyszukiwania.

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

Metody
get GET /v1/stats/user/{name=searchapplications/*}
Pobierz statystyki użytkowników wyszukiwarki.