Cloud Search API

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

Dienst: cloudsearch.googleapis.com

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

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
Prüft, ob ein Element für das angegebene 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 die 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 der 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 ACL, Metadaten und Inhalte von Item.
list GET /v1/indexing/{name=datasources/*}/items
Listet alle Item resources oder einen Teil davon auf.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Führt eine Abfrage für nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert einen Satz als reserviert, beginnend mit den Elementen mit dem ältesten Zeitstempel aus der höchsten Priorität ItemStatus.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Verschiebt ein Element zur späteren Abfrage und Aktualisierung in eine Warteschlange.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Hebt 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=**}
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 stellt die Suchmethode bereit, mit der die relevantesten Ergebnisse einer Nutzeranfrage zurückgegeben werden.
suggest POST /v1/query/suggest
Bietet Vorschläge zur automatischen 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 Search and Suggest APIs verwenden kann.

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 Statistiken zu indexierten Elementen ab, aggregiert über alle Datenquellen.
getQuery GET /v1/stats/query
Rufen Sie die Abfragestatistiken für den Kunden ab.
getSearchapplication GET /v1/stats/searchapplication
Statistiken zu Suchanwendungen für Kunden abrufen.
getSession GET /v1/stats/session
Rufen Sie die Anzahl der Suchsitzungen und den Prozentsatz der erfolgreichen Sitzungen mit einem Klick als Suchanfrage für den Kunden ab.
getUser GET /v1/stats/user
Rufen Sie die Nutzerstatistiken für den Kunden ab.

REST-Ressource: v1.stats.index.datasources

Methoden
get GET /v1/stats/index/{name=datasources/*}
Ruft indexierte Artikelstatistiken 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/*}
Rufen Sie die Anzahl der Suchsitzungen und den Prozentsatz erfolgreicher Sitzungen mit einer Klickabfragestatistik für die Suchanwendung ab.

REST-Ressource: v1.stats.user.searchapplications

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