Cloud Search API

Cloud Search bietet cloudbasierte Suchfunktionen für Google Workspace-Daten. Mit der Cloud Search API können Nicht-Google Workspace-Daten 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, sollten Sie die folgenden Informationen verwenden, 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. Dieser Dienst stellt folgendes Discovery-Dokument bereit:

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 ein Element für den angegebenen Principal zugänglich ist.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Ruft das Element ab, dessen „viewUrl“ genau mit der URL in der Anfrage übereinstimmt.

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

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

REST-Ressource: v1.debug.identitysources.items

Methoden
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Listet Namen von Elementen 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 anhand des Artikelnamens ab.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Aktualisiert Item ACL, Metadaten und Inhalte.
list GET /v1/indexing/{name=datasources/*}/items
Listet alle oder eine Teilmenge von Item resources auf.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Ruft nicht reservierte Elemente aus der Indexierungswarteschlange ab und markiert eine Gruppe als reserviert. Dabei werden Elemente mit dem ältesten Zeitstempel aus dem ItemStatus mit der höchsten Priorität berücksichtigt.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Fügt ein Element in eine Warteschlange ein, um es später abzurufen und zu aktualisieren.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Alle Elemente in einer Warteschlange werden freigegeben, 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=**}
Lädt Medien zur Indexierung hoch.

REST-Ressource: v1.operations

Methoden
get GET /v1/{name=operations/**}
Ruft den letzten Status eines Vorgangs mit langer Ausführungszeit ab.

REST-Ressource: v1.query

Methoden
removeActivity POST /v1/query:removeActivity
Bietet Funktionen zum Entfernen protokollierter Aktivitäten für einen Nutzer.
search POST /v1/query/search
Die Cloud Search Query API bietet die Methode „search“, die die relevantesten Ergebnisse einer Nutzeranfrage 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
Gibt eine Liste der Quellen zurück, die der Nutzer für die Search- und Suggest-APIs verwenden kann.

REST-Ressource: v1.settings

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

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
Hier werden alle Suchanwendungen aufgeführt.
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
Ruft Statistiken zu indexierten Elementen ab, die über alle Datenquellen hinweg aggregiert werden.
getQuery GET /v1/stats/query
Abfragestatistiken für den Kunden abrufen.
getSearchapplication GET /v1/stats/searchapplication
Suchanwendungsstatistiken für Kunden abrufen.
getSession GET /v1/stats/session
Anzahl der Suchsitzungen und Prozentsatz der erfolgreichen Sitzungen mit Klickabfragestatistiken für den Kunden abrufen.
getUser GET /v1/stats/user
Ruft die Nutzerstatistiken für den Kunden ab.

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/*}
Ruft die Nutzerstatistiken für die Suchanwendung ab.