Zugriff auf die Google Cloud Search API konfigurieren
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Bevor Sie die Google Cloud Search API entweder direkt oder über ein SDK verwenden können, müssen Sie den Zugriff darauf konfigurieren. In diesem Dokument werden die Schritte beschrieben, die für die Verwendung der Google Cloud Search API REST API erforderlich sind.
1. API-Projekt erstellen
Bevor Sie die API aktivieren können, müssen Sie zuerst ein Google Cloud-Projekt erstellen. Dieses Projekt bildet die Grundlage für das Erstellen, Aktivieren und Nutzen aller Google Cloud-Dienste, einschließlich des Verwaltens von APIs, des Aktivierens der Abrechnung, des Hinzufügens und Entfernens von Mitarbeitern und des Verwaltens von Berechtigungen.
Klicken Sie oben auf der Seite rechts neben „Google Cloud Console“ auf arrow_drop_down. Ein Dialogfeld mit den aktuellen Projekten wird angezeigt.
Klicken Sie auf NEUES PROJEKT. Das Fenster „Neues Projekt“ wird angezeigt.
Geben Sie im Feld Projektname einen Projektnamen ein.
Optional: Klicken Sie auf Bearbeiten, um die Projekt-ID zu bearbeiten. Die Projekt-ID kann nach dem Erstellen des Projekts nicht mehr geändert werden. Wählen Sie also eine ID aus, die während der gesamten Dauer des Projekts den Anforderungen entspricht.
Klicken Sie auf DURCHSUCHEN, um die Standorte für das Projekt aufzurufen.
Klicken Sie auf einen Speicherort für Ihr Projekt und dann auf Auswählen.
Klicken Sie auf Erstellen. Sie werden zur Seite „Dashboard“ weitergeleitet. Das Projekt wird innerhalb weniger Minuten erstellt.
Aktivieren Sie die Google Cloud Search API und erstellen Sie ein Dienstkonto, um Anmeldedaten zu erhalten.
Sorgen Sie dafür, dass Sie sich auch wirklich im richtigen Projekt befinden. Klicken Sie dazu rechts neben dem Banner der Google Cloud Console auf das Symbol arrow_drop_down und wählen Sie das neu erstellte aus.
Klicken Sie auf APIS UND DIENSTE AKTIVIEREN. Die Seite „Willkommen bei der API-Bibliothek“ wird angezeigt.
Klicken Sie in der Google Cloud Console im linken Navigationsmenü auf Anmeldedaten. Die Seite „Anmeldedaten“ wird angezeigt.
Wählen Sie in der Drop-down-Liste Anmeldedaten erstellen die Option Dienstkonto aus. Die Seite „Dienstkonto erstellen“ wird angezeigt.
Geben Sie im Feld Name des Dienstkontos einen Namen ein.
Optional: Bearbeiten Sie die ID des Dienstkontos.
Klicken Sie auf Erstellen. Der Bildschirm „Dienstkontoberechtigungen“ wird angezeigt.
Klicken Sie auf Weiter. Der Bildschirm „Nutzern Zugriff auf dieses Dienstkonto erteilen“ wird angezeigt.
Klicken Sie auf SCHLÜSSEL ERSTELLEN und dann auf Fertig. Das Dialogfeld „Privater Schlüssel auf Ihrem Computer gespeichert“ wird angezeigt und eine Kopie des privaten Schlüssels wird auf Ihren Computer heruntergeladen.
Wählen Sie in der Google Cloud Console oben auf der Seite das erstellte Projekt aus.
Klicken Sie links neben dem Banner der Google Cloud Console auf das Navigationsmenü.
Klicken Sie auf IAM & Verwaltung > Dienstkonten.
In der Liste finden Sie die erstellte E-Mail-Adresse unter „Dienstkonto-ID“. Notieren Sie sie. Mit ihr kann das von Ihnen konfigurierte Dienstkonto identifiziert werden. Außerdem wird sie verwendet, wenn Cloud Search eine Datenquelle hinzugefügt werden soll.
5. Unterstützung von Drittanbietern initialisieren
Bevor Sie andere Cloud Search APIs aufrufen können, müssen Sie die Unterstützung von Drittanbietern für Google Cloud Search initialisieren.
So initialisieren Sie die Unterstützung von Drittanbietern für Cloud Search:
Ihr Projekt für die Cloud Search Platform enthält Anmeldedaten für ein Dienstkonto.
Für die Initialisierung der Unterstützung von Drittanbietern müssen Sie allerdings Anmeldedaten für die Webanwendung erstellen. Eine entsprechende Anleitung finden Sie unter Anmeldedaten erstellen.
Nach Abschluss dieses Schritts sollten Sie eine Client-ID und eine Clientschlüsseldatei haben.
Klicken Sie auf „Settings“ (Einstellungen) und setzen Sie ein Häkchen bei User your own auth credentials (Eigene Anmeldedaten verwenden).
Geben Sie die Client-ID und den Clientschlüssel aus Schritt 1 ein.
Klicken Sie auf Schließen.
Geben Sie im Feld „Scopes“ (Bereiche) https://www.googleapis.com/auth/cloud_search.settings ein und klicken Sie auf Authorize (Autorisieren). Im OAuth 2-Playground wird ein Autorisierungscode zurückgegeben.
Klicken Sie auf Autorisierungscode für Tokens austauschen. Ein Token wird zurückgegeben.
Initialisieren Sie die Unterstützung von Drittanbietern für Cloud Search mit folgendem curl-Befehl. Ersetzen Sie [YOUR_ACCESS_TOKEN] durch das Token aus Schritt 2.
Bei Bedarf können Sie die folgenden Schritte ausführen:
Wenn Sie beabsichtigen, Google Cloud Search mit einem Datenrepository zu verwenden, das nicht zu Google gehört, z. B. mit Microsoft® SharePoint®, müssen Sie eine Datenquelle erstellen. Weitere Informationen dazu erhalten Sie im Hilfeartikel Datenquelle für die Suche hinzufügen.
Sobald Sie die Datenquelle eingerichtet haben, können Sie ein Schema erstellen und registrieren, um zu bestimmen, wie die Repository-Daten von Google Cloud Search dargestellt werden sollen.
[null,null,["Zuletzt aktualisiert: 2025-08-29 (UTC)."],[],[],null,["# Configure access to the Google Cloud Search API\n\nYou must configure access to the Google Cloud Search API before you can\nuse this API either directly or through an SDK. This document\ncovers the steps required to use the Google Cloud Search API REST API.\n\n1. Create an API project\n------------------------\n\nTo enable the API, you must first create an Google Cloud project. This\nproject forms the basis for creating, enabling, and using all Google Cloud\nservices, including managing APIs, enabling billing, adding and\nremoving collaborators, and managing permissions.\n\n1. Open the [Google Cloud console](https://console.cloud.google.com/apis/dashboard).\n\n2. At the top of the page, click\n arrow_drop_down\n to the right of \"Google Cloud Console.\" A dialog listing current projects\n appears.\n\n3. Click **NEW PROJECT**. The \"New Project\" screen appears.\n\n4. Enter a project name in the **Project Name** field.\n\n5. (optional) Click **Edit** to edit the Project ID. The project ID can't be\n changed after the project is created, so choose an\n ID that meets your needs for the lifetime of the project.\n\n6. To browse locations for the project, click **BROWSE**.\n\n7. Click on a location for your project and click **Select**.\n\n8. Click **Create**. The console navigates to the Dashboard page. The project\n is created within a few minutes.\n\nFor further information on creating and managing projects, refer to\n[Creating and Managing Projects](https://support.google.com/cloud#topic=6158848).\n\n2. Enable the API\n-----------------\n\nYou need to enable the Google Cloud Search API and create a service account to\nobtain credentials.\n\n1. To ensure you are on the newly created project, click the arrow_drop_down icon to the right of the Google Cloud console banner and select your newly-created project.\n2. Click **ENABLE APIS AND SERVICES**. The \"Welcome to API Library\" page appears.\n3. Navigate to the [Google Cloud Search API](https://console.cloud.google.com/apis/api/cloudsearch.googleapis.com).\n4. Click **Enable**. The \"Overview\" page appears.\n\nFor further information on enabling and disabling APIs, refer to\n[Manage APIs in the Google Cloud console](https://support.google.com/cloud/answer/6326510)\n| **Note:** Different Cloud Search APIs require different accounts to execute (admin, service, and user). For further information, refer to the [reference documentation](/workspace/cloud-search/docs/reference) for the method you want to call.\n\n3. Create service account credentials\n-------------------------------------\n\n1. In the [Google Cloud console](https://console.cloud.google.com/apis/library), click **Credentials** in the left navigation. The Credential page appears.\n2. From the **Create credentials** drop-down list, select **Service account**. The \"Create service account\" page appears.\n3. Enter a name in the **Service account name** field.\n4. (optional) Edit the service account ID.\n5. Click **Create**. A \"Service account permissions\" screen appears.\n6. Click **Continue**. A \"Grant users access to this service account\" screen appears.\n7. Click **CREATE KEY** and click **Done**. A \"Private key saved to your computer\" dialog appears and a copy of the private key downloads to your computer.\n8. Click **Close**.\n\nFor further information on service accounts, refer to\n[Service accounts, web applications, and installed applications](https://support.google.com/cloud/answer/6158849#serviceaccounts)\n\n4. Identify email address\n-------------------------\n\n1. From the [Google Cloud console](https://console.cloud.google.com/apis/dashboard), select the project you created at the top of the page.\n2. Click the Navigation menu to the left of the Google Cloud console banner.\n3. Click **IAM and Admin** \\\u003e **Service accounts**.\n4. In the list, under \"Service account ID,\" make note of the generated email address that identifies the service account you configured. This email address is used when adding a data source to Cloud Search.\n\n5. Initialize third-party support\n---------------------------------\n\nBefore you can call any other Cloud Search APIs, you must initialize third-party\nsupport for Google Cloud Search.\n| **Note:** If you successfully executed the Cloud Search tutorial, you have already initialized third-party support for Cloud Search and can skip this step.\n\nTo initialize third-party support for Cloud Search:\n\n1. Your Cloud Search platform project contains service account credentials.\n However, for the sake of initializing third-party support, you must create web\n application credentials. For instructions on how to create web application\n credentials, refer to\n [Create credentials](/workspace/guides/create-credentials).\n Upon completing this step, you should have a client ID and client secret file.\n\n2. Use\n [Google's OAuth 2 playground](https://developers.google.com/oauthplayground/)\n to obtain an access token:\n\n 1. Click settings and check **User your own auth credentials**.\n 2. Enter the client ID and client secret from step 1.\n 3. Click **Close**.\n 4. In the scopes field, type `https://www.googleapis.com/auth/cloud_search.settings` and click **Authorize**. The OAuth 2 playground returns an authorization code.\n 5. Click **Exchange authorization code for tokens**. A token is returned.\n3. To initialize third-party support for Cloud Search, use the following curl\n command. Be sure to substitute `[YOUR_ACCESS_TOKEN]` with the token obtained in\n step 2.\n\n curl --request POST \\\n 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data '{}' \\\n --compressed\n\n If successful, the response body contains an instance of\n [`operation`](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation). For\n example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n }\n\n If unsuccessful, contact Cloud Search support.\n4. Use [operations.get](/workspace/cloud-search/docs/reference/rest/v1/operations/get) to verify that\n third-party support is initialized:\n\n curl \\\n 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=\n [YOUR_API_KEY]' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --compressed\n\n When the third-party initialization is complete, it contains the\n field `done` set to `true`. For example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n done: true\n }\n\nNext Steps\n----------\n\nHere are few next steps you might take:\n\n1. If you plan on using Google Cloud Search with a non-Google data repository,\n such as Microsoft® SharePoint®, you\n must create a data source. For instructions on\n adding a data source, refer to\n [Add a data source to search](https://support.google.com/a/answer/7056471).\n\n2. Once you set up your data source, you can\n [create and register schema](/workspace/cloud-search/docs/guides/schema-guide) to identify\n how Google Cloud Search should represent the data in the repository."]]
