Enterprise Knowledge Graph API einrichten

Diese Anleitung enthält alle erforderlichen Einrichtungsschritte für die Verwendung von Enterprise Knowledge Graph.

Google Cloud Console

Die Google Cloud console ist eine Web-UI zur Bereitstellung, Konfiguration, Verwaltung und Überwachung von Systemen, die Google Cloud -Produkte verwenden. Sie verwenden die Google Cloud Console, um Enterprise Knowledge Graph-Ressourcen einzurichten und zu verwalten.

Projekt erstellen

Wenn Sie Dienste von Google Cloudnutzen möchten, müssen Sie ein Projekt erstellen.

In Projekten sind alle Ihre Ressourcen von Google Cloud organisiert. Ein Projekt besteht aus den folgenden Komponenten:

• einer Gruppe von Mitarbeitern
• aktivierten APIs und anderen Ressourcen
• Monitoring-Tools
• Zahlungsinformationen
• Authentifizierungs- und Zugriffssteuerungen

Sie können ein Projekt oder mehrere Projekte erstellen. Sie können mit Ihren Projekten Ihre Google Cloud -Ressourcen in einer Ressourcenhierarchie organisieren. Weitere Informationen zu Projekten finden Sie in der Dokumentation zu Resource Manager.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

API aktivieren

Sie müssen die Enterprise Knowledge Graph API für Ihr Projekt aktivieren. Weitere Informationen zur Aktivierung von APIs finden Sie in der Dokumentation zu Service Usage.

Enable the Enterprise Knowledge Graph API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Authentifizierung einrichten

Jede Client-Anwendung, die die API verwendet, muss authentifiziert sein und Zugriff auf die angeforderten Ressourcen haben. In diesem Abschnitt werden wichtige Konzepte der Authentifizierung erklärt und Schritte für die Einrichtung beschrieben. Weitere Informationen finden Sie in der Authentifizierungsübersicht.

Informationen zu Dienstkonten

Für die Authentifizierung gibt es mehrere Möglichkeiten. Wir empfehlen jedoch, für die Authentifizierung und die Zugriffssteuerung Dienstkonten zu verwenden. Die Anmeldedaten für ein Dienstkonto werden für Anwendungen vergeben, nicht für Endnutzer. Projekte haben ihre Dienstkonten. Sie können viele Dienstkonten für ein Projekt erstellen. Weitere Informationen finden Sie unter Dienstkonten.

Informationen zu Rollen

Wenn Sie eine API aufrufen, muss die aufrufende Identität (alle anwendbaren Personen, Entitäten oder Prozesse und ihre definierten Attribute) die entsprechenden Berechtigungen haben. Google Cloud Sie können Berechtigungen gewähren, indem Sie einem Dienstkonto Rollen zuweisen. Weitere Informationen finden Sie in der Dokumentation zur Identitäts- und Zugriffsverwaltung (IAM).

Zum Testen der Enterprise Knowledge Graph API können Sie die Rolle Projekt > Inhaber in den folgenden Schritten verwenden. Die Rolle Projekt > Inhaber gewährt dem Dienstkonto vollständige Berechtigung für Ressourcen in Ihrem Projekt. Wenn für Ihr Dienstkonto keine vollständigen Berechtigungen erforderlich sind, geben Sie mit der Google Cloud Console eine restriktivere Rolle an. Eine Liste der Berechtigungen und Rollen für Enterprise Knowledge Graph finden Sie unter Enterprise Knowledge Graph-Berechtigungen und Enterprise Knowledge Graph-Rollen. Informationen zum Verwalten von Berechtigungen mithilfe von IAM-Rollen finden Sie unter Dienstkonten Rollen zuweisen.

Informationen zu Dienstkontoschlüsseln

Dienstkonten sind mit einem oder mehreren öffentlichen oder privaten Schlüsselpaaren verknüpft. Wenn Sie ein neues Schlüsselpaar erstellen, laden Sie den privaten Schlüssel herunter. Die Google Cloud-CLI verwendet beim Aufrufen der API Ihren privaten Schlüssel, um Anmeldedaten zu generieren.

Hinweis :Dienstkontoschlüssel stellen ein Sicherheitsrisiko dar, wenn sie nicht ordnungsgemäß verwaltet werden. Sie sollten nach Möglichkeit eine sicherere Alternative zu Dienstkontoschlüsseln auswählen. Wenn Sie sich mit einem Dienstkontoschlüssel authentifizieren müssen, sind Sie für die Sicherheit des privaten Schlüssels und für andere Vorgänge verantwortlich, die unter Best Practices für die Verwaltung von Dienstkontoschlüsseln beschrieben werden. Wenn Sie keinen Dienstkontoschlüssel erstellen können, ist das Erstellen von Dienstkontoschlüsseln für Ihre Organisation möglicherweise deaktiviert. Weitere Informationen finden Sie unter Standardmäßig sichere Organisationsressourcen verwalten.

Wenn Sie den Dienstkontoschlüssel von einer externen Quelle erhalten haben, müssen Sie ihn vor der Verwendung validieren. Weitere Informationen finden Sie unter Sicherheitsanforderungen für Anmeldedaten aus externen Quellen.

Dienstkonto erstellen und Datei mit dem privaten Schlüssel herunterladen

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the Project > Owner role to the service account.

   To grant the role, find the Select a role list, then select Project > Owner.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
7. Click Continue.

8. Click Done to finish creating the service account.

   Do not close your browser window. You will use it in the next step.

Create a service account key:

1. In the Google Cloud console, click the email address for the service account that you created.
2. Click Keys.
3. Click Add key, and then click Create new key.
4. Click Create. A JSON key file is downloaded to your computer.
5. Click Close.

Schlüsseldatei des Dienstkontos in Ihrer Umgebung verwenden

Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. This variable applies only to your current shell session. If you want the variable to apply to future shell sessions, set the variable in your shell startup file, for example in the ~/.bashrc or ~/.profile file.

Linux oder macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

For PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

For command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Replace KEY_PATH with the path of the JSON file that contains your credentials.