Cloud Search API

Cloud Search bietet cloudbasierte Suchfunktionen für Google Workspace-Daten. Die Cloud Search API ermöglicht die Indexierung von Nicht-Google Workspace-Daten in Cloud Search.

Dienst: cloudsearch.googleapis.com

Wir empfehlen, die von Google bereitgestellten Clientbibliotheken zu verwenden, um diesen Dienst aufzurufen. Wenn Ihre Anwendung zum Aufrufen dieses Dienstes Ihre eigenen Bibliotheken verwenden muss, verwenden Sie die folgenden Informationen, wenn Sie die API-Anfragen stellen.

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 third party-Unterstützung in Google Cloud Search.

REST-Ressource: v1.debug.datasources.items

Methoden
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
Überprüft, ob ein Element für ein bestimmtes Hauptkonto 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
Listet alle nicht zugeordneten Identitäten für ein bestimmtes Element auf.

REST-Ressource: v1.debug.identitysources.items

Methoden
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Listet Namen von Elementen auf, die einer nicht zugeordneten Identität zugeordnet 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 Elementnamens 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 einen Teil von Item resources auf.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Führt eine Abfrage für nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert eine Gruppe als reserviert. Wir beginnen mit den Elementen, die den ältesten Zeitstempel der ItemStatus mit der höchsten Priorität haben.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
schiebt ein Element zur späteren Abfrage und Aktualisierung in eine Warteschlange.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Hebt die Reservierung aller Elemente aus einer Warteschlange auf, sodass sie alle abgefragt werden können.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Erstellt eine Uploadsitzung zum Hochladen von Inhaltselementen.

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 lang andauernden Vorgangs ab.

REST-Ressource: v1.query

Methoden
search POST /v1/query/search
Die Cloud Search Query API bietet die Suchmethode, bei der die relevantesten Ergebnisse zu einer Nutzerabfrage zurückgegeben werden.
suggest POST /v1/query/suggest
Bietet Vorschläge zum automatischen Vervollständigen der Abfrage.

REST-Ressource: v1.query.sources

Methoden
list GET /v1/query/sources
Gibt eine Liste der Quellen zurück, die Nutzer für die Search API und die Google Suggest API 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
Ruft die indexierten Elementstatistiken für alle Datenquellen zusammengefasst ab.
getQuery GET /v1/stats/query
Abfragestatistiken des Kunden abrufen.
getSearchapplication GET /v1/stats/searchapplication
Rufen Sie Statistiken zu Suchanwendungen für den Kunden ab.
getSession GET /v1/stats/session
Ermittle die Anzahl der Suchsitzungen und den Prozentsatz der erfolgreichen Sitzungen mit einer Klickabfragestatistik für den Kunden.
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 indexierte Elementstatistiken für eine einzelne Datenquelle ab.

REST-Ressource: v1.stats.query.searchapplications

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

REST-Ressource: v1.stats.session.searchapplications

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

REST-Ressource: v1.stats.user.searchapplications

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