In den Kurzanleitungen wird erklärt, wie Sie eine App einrichten und ausführen, die eine Google Workspace API
In Google Workspace-Kurzanleitungen werden die API-Clientbibliotheken Details zum Authentifizierungs- und Autorisierungsvorgang. Wir empfehlen, Clientbibliotheken für Ihre eigenen Apps verwenden. In dieser Kurzanleitung wird ein vereinfachten Authentifizierungsansatz, der für Tests geeignet ist, zu verbessern. Für eine Produktionsumgebung empfehlen wir, sich über Authentifizierung und Autorisierung vorher Anmeldedaten auswählen die für Ihre App geeignet sind.
Eine Java-Befehlszeilenanwendung erstellen, die Anfragen an die Google Notizen API sendet
Zielsetzungen
- die Umgebung einrichten
- Richten Sie das Beispiel ein.
- Führen Sie das Beispiel aus.
Vorbereitung
- Java 1.8 oder höher.
- Gradle 7.0 oder höher.
- Ein Google Cloud-Projekt
- Ein Google-Konto, für das Google Notizen aktiviert ist.
Umgebung einrichten
Richten Sie Ihre Umgebung ein, um diese Kurzanleitung abzuschließen.
API aktivieren
Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.Aktivieren Sie in der Google Cloud Console die Google Notizen API.
Dienstkonto erstellen
Ein Dienstkonto ist eine spezielle Art von Konto, das von einer Anwendung verwendet wird, als eine Person. Sie können ein Dienstkonto verwenden, um auf Daten zuzugreifen oder Aktionen auszuführen oder auf Daten im Namen von Google Workspace zuzugreifen, oder Cloud Identity-Nutzer. Weitere Informationen finden Sie unter Details zu Dienstkonten.Google Cloud Console
- Öffnen Sie in der Google Cloud Console das Menü > IAM und Verwaltung > Dienstkonten. .
- Klicken Sie auf Dienstkonto erstellen.
- Geben Sie die Dienstkontodetails ein und klicken Sie dann auf Erstellen und fortfahren.
- Optional: Weisen Sie Ihrem Dienstkonto Rollen zu, um Zugriff auf die Ressourcen Ihres Google Cloud-Projekts zu gewähren. Weitere Informationen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.
- Klicken Sie auf Weiter.
- Optional: Geben Sie Nutzer oder Gruppen ein, die Aktionen mit diesem Dienstkonto verwalten und ausführen können. Weitere Informationen finden Sie unter Identitätswechsel für Dienstkonten verwalten.
- Klicken Sie auf Fertig. Notieren Sie sich die E-Mail-Adresse für das Dienstkonto.
gcloud-CLI
- Erstellen Sie das Dienstkonto:
gcloud iam service-accounts create
SERVICE_ACCOUNT_NAME
\ --display-name="SERVICE_ACCOUNT_NAME
" - Optional: Weisen Sie Ihrem Dienstkonto Rollen zu, um Zugriff auf die Ressourcen Ihres Google Cloud-Projekts zu gewähren. Weitere Informationen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.
Anmeldedaten für ein Dienstkonto erstellen
Sie benötigen Anmeldedaten in Form eines öffentlichen/privaten Schlüsselpaars. Diese Anmeldedaten werden von Ihrem Code verwendet, um Dienstkontoaktionen in für Ihre App. <ph type="x-smartling-placeholder">- </ph>
- Öffnen Sie in der Google Cloud Console das Menü > IAM und Verwaltung > Dienstkonten. .
- Wählen Sie Ihr Dienstkonto aus.
- Klicken Sie auf Schlüssel > Schlüssel hinzufügen > Neuen Schlüssel erstellen.
- Wählen Sie JSON aus und klicken Sie dann auf Erstellen.
Ihr neues öffentliches/privates Schlüsselpaar wird generiert und auf Ihr als neue Datei gespeichert. Speichern Sie die heruntergeladene JSON-Datei als
credentials.json
in Ihrem Arbeitsverzeichnis. Diese Datei ist die einzige Kopie dieses Schlüssels. Informationen zum Speichern um Ihren Schlüssel sicher aufzubewahren, finden Sie unter Dienstkontoschlüssel verwalten - Klicken Sie auf Schließen.
Domainweite Delegierung für ein Dienstkonto einrichten
Wenn Sie APIs im Namen von Nutzern in einer Google Workspace-Organisation aufrufen möchten, muss Ihrem Dienstkonto domainweite Befugnisse in in der Google Workspace-Admin-Konsole über ein Super Admin-Konto. Weitere Informationen finden Sie unter Domainweite Berechtigungen an ein Dienstkonto delegieren- Öffnen Sie in der Google Cloud Console das Menü > IAM und Verwaltung > Dienstkonten. .
- Wählen Sie Ihr Dienstkonto aus.
- Klicken Sie auf Erweiterte Einstellungen anzeigen.
- Unter „Domainweite Delegierung“ Ermitteln Sie die Client-ID Ihres Dienstkontos. Klicken Sie auf „Copy “ (Kopieren), um den Wert der Client-ID in die Zwischenablage zu kopieren.
Wenn Sie Super Admin-Zugriff auf das entsprechende Google Workspace-Konto haben, klicken Sie auf Rufen Sie die Google Workspace-Admin-Konsole auf und melden Sie sich dann als Super Admin an. und führen Sie die folgenden Schritte aus.
Wenn Sie keinen Super Admin-Zugriff auf das entsprechende Google Workspace-Konto haben, wenden Sie sich an einen Super Admin für dieses Konto und senden Sie ihm die Client-ID Ihres Dienstkontos. und eine Liste der OAuth-Bereiche, damit sie die folgenden Schritte in der Admin-Konsole ausführen können.
- Öffnen Sie in der Admin-Konsole das Dreistrich-Menü > Sicherheit > Zugriffs- und Datenkontrolle > API-Steuerung. .
- Klicken Sie auf Domainweite Delegierung verwalten.
- Klicken Sie auf Neu hinzufügen.
- Klicken Sie im Feld „Client-ID“ fügen Sie die zuvor kopierte Client-ID ein.
- Im Abschnitt „OAuth-Bereiche“ eine durch Kommas getrennte Liste der Bereiche ein, die für Ihre Anwendung erforderlich sind. Dies sind dieselben Bereiche, die Sie bei der Konfiguration des OAuth-Zustimmungsbildschirms definiert haben.
- Klicken Sie auf Autorisieren.
Arbeitsbereich vorbereiten
Erstellen Sie in Ihrem Arbeitsverzeichnis eine neue Projektstruktur:
gradle init --type basic mkdir -p src/main/java src/main/resources
Kopieren Sie die Datei
credentials.json
in das Verzeichnissrc/main/resources/
. die Sie zuvor heruntergeladen haben.Öffnen Sie die Standarddatei
build.gradle
und ersetzen Sie ihren Inhalt durch die folgenden Code:apply plugin: 'java' apply plugin: 'application' mainClassName = 'KeepQuickstart' sourceCompatibility = 1.8 targetCompatibility = 1.8 version = '1.0' sourceCompatibility = 1.8 repositories { mavenCentral() } dependencies { implementation 'com.google.api-client:google-api-client:1.23.0' implementation 'com.google.oauth-client:google-oauth-client-jetty:1.23.0' implementation 'com.google.apis:google-api-services-keep:v1-rev20210528-1.31.0' }
Beispielanwendung einrichten
Erstellen Sie im Verzeichnis
src/main/java/
eine neue Java-Datei mit einem Namen, entspricht demmainClassName
-Wert in Ihrerbuild.gradle
-Datei.Fügen Sie den folgenden Code in Ihre neue Java-Datei ein:
import com.google.api.client.auth.oauth2.Credential; import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp; import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver; import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow; import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets; import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport; import com.google.api.client.http.javanet.NetHttpTransport; import com.google.api.client.json.JsonFactory; import com.google.api.client.json.gson.GsonFactory; import com.google.api.client.util.store.FileDataStoreFactory; import com.google.api.services.keep.v1.Keep; import com.google.api.services.keep.v1.model.Note; import com.google.api.services.keep.v1.model.Section; import com.google.api.services.keep.v1.model.TextContent; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.security.GeneralSecurityException; import java.util.Collections; import java.util.List; public class KeepQuickstart { private static final String APPLICATION_NAME = "Google Keep API Java Quickstart"; private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance(); /** * Global instance of the scopes required by this quickstart. If modifying these scopes, delete * your previously saved tokens/ folder. */ private static final List<String> KEEP_SCOPES = Collections.singletonList("https://www.googleapis.com/auth/keep"); private static final String CREDENTIALS_FILE_PATH = "/credentials.json"; /** * Creates an authorized Credential object. * * @param HTTP_TRANSPORT The network HTTP Transport. * @return An authorized Credential object. * @throws IOException */ private static Credential getOAuthCredentials(final NetHttpTransport HTTP_TRANSPORT) throws IOException { // Load client secrets. InputStream in = KeepQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH); if (in == null) { throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH); } GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in)); // Build flow and trigger user authorization request. GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder( HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, KEEP_SCOPES) .setDataStoreFactory(new FileDataStoreFactory(new java.io.File("tokens"))) .setAccessType("offline") .build(); LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build(); return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user"); } public static void main(String... args) throws IOException, GeneralSecurityException { // Build a new authorized API client service. final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport(); Keep service = new Keep.Builder(HTTP_TRANSPORT, JSON_FACTORY, getOAuthCredentials(HTTP_TRANSPORT)) .setApplicationName(APPLICATION_NAME) .build(); Section noteBody = new Section().setText(new TextContent().setText("Finish preparations by tomorrow!")); Note newNote = new Note().setTitle("Customer call next week").setBody(noteBody); // Creates a new text note. service.notes().create(newNote).execute(); } }
Beispiel ausführen
Führen Sie das Beispiel aus:
gradle run
-
Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:
<ph type="x-smartling-placeholder">
- </ph>
- Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, melden Sie sich an, wenn Sie dazu aufgefordert werden. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie ein Konto für die Autorisierung aus.
- Klicken Sie auf Akzeptieren.
Ihre Java-Anwendung wird ausgeführt und ruft die Google Notizen API auf.
Autorisierungsinformationen werden im Dateisystem gespeichert. Wenn Sie das Beispiel das nächste Mal ausführen, Code eingeben, werden Sie nicht zur Autorisierung aufgefordert.
Nächste Schritte
- Fehlerbehebung bei Authentifizierungs- und Autorisierungsproblemen
- Referenzdokumentation zur Google Notizen API
- Dokumentation zum Google APIs-Client für Java
- Javadoc-Dokumentation zur Google Notizen API