Cloud Search API

Cloud Search bietet cloudbasierte Suchfunktionen für Google Workspace-Daten. Mit der Cloud Search API können Daten, die nicht zu Google Workspace gehören, in Cloud Search indexiert werden.

Dienst: cloudsearch.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, verwenden Sie die folgenden Informationen, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet das folgende Discovery-Dokument:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://cloudsearch.googleapis.com

REST-Ressource: v1

Methoden
initializeCustomer POST /v1:initializeCustomer
Aktiviert die Unterstützung von third party in Google Cloud Search.

REST-Ressource: v1.debug.datasources.items

Methoden
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
Prüft, ob auf einen Artikel über den angegebenen Principal zugegriffen werden kann.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Ruft das Element ab, dessen „viewUrl“ genau mit der in der Anfrage angegebenen URL übereinstimmt.

REST-Ressource: v1.debug.datasources.items.unmappedids

Methoden
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Listet alle nicht zugeordneten Identitäten für einen bestimmten Artikel auf.

REST-Ressource: v1.debug.identitysources.items

Methoden
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Listet die Namen der Elemente auf, die mit einer nicht zugeordneten Identität verknüpft sind.

REST-Ressource: v1.debug.identitysources.unmappedids

Methoden
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Listet nicht zugeordnete Nutzeridentitäten für eine Identitätsquelle auf.

REST-Ressource: v1.indexing.datasources

Methoden
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
Löscht das Schema einer Datenquelle.
getSchema GET /v1/indexing/{name=datasources/*}/schema
Ruft das Schema einer Datenquelle ab.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
Aktualisiert das Schema einer Datenquelle.

REST-Ressource: v1.indexing.datasources.items

Methoden
delete DELETE /v1/indexing/{name=datasources/*/items/*}
Löscht Item resource für den angegebenen Ressourcennamen.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Löscht alle Elemente in einer Warteschlange.
get GET /v1/indexing/{name=datasources/*/items/*}
Ruft Item resource nach Artikelnamen ab.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Aktualisiert die Item ACL, die Metadaten und den Inhalt.
list GET /v1/indexing/{name=datasources/*}/items
Listet alle oder einen Teil von Item resources auf.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Prüft, ob nicht reservierte Elemente in der Indexierungswarteschlange vorhanden sind, und kennzeichnet einen Satz als reserviert, beginnend mit den Elementen mit dem ältesten Zeitstempel der höchsten Priorität ItemStatus.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Fügt ein Element einer Warteschlange hinzu, um es später abzufragen und zu aktualisieren.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Hebelt die Reservierung aller Elemente in einer Warteschlange auf, sodass sie alle abgefragt werden können.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Erstellt eine Uploadsitzung zum Hochladen von Artikelinhalten.

REST-Ressource: v1.media

Methoden
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Medien zur Indexierung hochlädt.

REST-Ressource: v1.operations

Methoden
get GET /v1/{name=operations/**}
Ruft den letzten Status eines lang andauernden Vorgangs ab.

REST-Ressource: v1.query

Methoden
search POST /v1/query/search
Die Cloud Search Query API bietet die Suchmethode, die die relevantesten Ergebnisse aus einer Nutzerabfrage zurückgibt.
suggest POST /v1/query/suggest
Bietet Vorschläge für die automatische Vervollständigung der Abfrage.

REST-Ressource: v1.query.sources

Methoden
list GET /v1/query/sources
Liste der Quellen zurückgeben, die Nutzer für die Search und Suggest APIs verwenden können.

REST-Ressource: v1.settings

Methoden
getCustomer GET /v1/settings/customer
Kundeneinstellungen abrufen.
updateCustomer PATCH /v1/settings/customer
Kundeneinstellungen aktualisieren.

REST-Ressource: v1.settings.datasources

Methoden
create POST /v1/settings/datasources
Erstellt eine Datenquelle.
delete DELETE /v1/settings/{name=datasources/*}
Löscht eine Datenquelle.
get GET /v1/settings/{name=datasources/*}
Ruft eine Datenquelle ab.
list GET /v1/settings/datasources
Listet Datenquellen auf.
patch PATCH /v1/settings/{source.name=datasources/*}
Aktualisiert eine Datenquelle.
update PUT /v1/settings/{source.name=datasources/*}
Aktualisiert eine Datenquelle.

REST-Ressource: v1.settings.searchapplications

Methoden
create POST /v1/settings/searchapplications
Erstellt eine Suchanwendung.
delete DELETE /v1/settings/{name=searchapplications/*}
Löscht eine Suchanwendung.
get GET /v1/settings/{name=searchapplications/*}
Ruft die angegebene Suchanwendung ab.
list GET /v1/settings/searchapplications
Listet alle Suchanwendungen auf.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
Aktualisiert eine Suchanwendung.
reset POST /v1/settings/{name=searchapplications/*}:reset
Setzt eine Suchanwendung auf die Standardeinstellungen zurück.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Aktualisiert eine Suchanwendung.

REST-Ressource: v1.stats

Methoden
getIndex GET /v1/stats/index
Statistiken zu indexierten Elementen, die über alle Datenquellen hinweg aggregiert werden.
getQuery GET /v1/stats/query
Abfragestatistiken für den Kunden abrufen.
getSearchapplication GET /v1/stats/searchapplication
Statistiken für Suchanwendungen für Kunden abrufen.
getSession GET /v1/stats/session
Anzahl der Suchsitzungen und Prozentsatz der erfolgreichen Sitzungen mit Klicks für den Kunden abrufen.
getUser GET /v1/stats/user
Nutzerstatistiken für den Kunden abrufen.

REST-Ressource: v1.stats.index.datasources

Methoden
get GET /v1/stats/index/{name=datasources/*}
Ruft Statistiken zu indexierten Elementen für eine einzelne Datenquelle ab.

REST-Ressource: v1.stats.query.searchapplications

Methoden
get GET /v1/stats/query/{name=searchapplications/*}
Abfragestatistiken für die Suchanwendung abrufen.

REST-Ressource: v1.stats.session.searchapplications

Methoden
get GET /v1/stats/session/{name=searchapplications/*}
Anzahl der Suchsitzungen und Prozentsatz der erfolgreichen Sitzungen mit Klickabfragestatistiken für die Suchanwendung abrufen.

REST-Ressource: v1.stats.user.searchapplications

Methoden
get GET /v1/stats/user/{name=searchapplications/*}
Nutzerstatistiken für die Suchanwendung abrufen.