In den Kurzanleitungen wird erläutert, wie Sie eine App einrichten und ausführen, die eine Google Workspace API aufruft.
In den Google Workspace-Schnellstarts werden die API-Clientbibliotheken verwendet, um einige Details des Authentifizierungs- und Autorisierungsablaufs zu verarbeiten. Wir empfehlen die Verwendung der Clientbibliotheken für Ihre eigenen Apps. In dieser Kurzanleitung wird ein vereinfachter Authentifizierungsansatz verwendet, der für eine Testumgebung geeignet ist. Für eine Produktionsumgebung empfehlen wir, sich mit Authentifizierung und Autorisierung vertraut zu machen, bevor Sie die Zugriffsdaten auswählen, die für Ihre App geeignet sind.
Erstellen Sie eine Java-Befehlszeilenanwendung, die Anfragen an die Google Notizen API sendet.
Lernziele
- 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, in dem 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 Keep API.
Dienstkonto erstellen
Ein Dienstkonto ist eine spezielle Art von Konto, das von einer Anwendung und nicht von einer Person verwendet wird. Sie können ein Dienstkonto verwenden, um über das Roboterkonto auf Daten zuzugreifen oder Aktionen auszuführen, oder um im Namen von Google Workspace- oder Cloud Identity-Nutzern auf Daten zuzugreifen. Weitere Informationen finden Sie unter Details zu Dienstkonten.Google Cloud Console
- Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > Dienstkonten. und dann auf IAM und Verwaltung
- Klicken Sie auf Dienstkonto erstellen.
- Geben Sie die Details zum Dienstkonto 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 dieses Dienstkonto verwalten und Aktionen damit 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 des Dienstkontos.
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 Ihrer App zu autorisieren.- Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > Dienstkonten. und dann auf IAM und Verwaltung
- 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 auf Erstellen.
Ihr neues öffentliches/privates Schlüsselpaar wird generiert und als neue Datei auf Ihren Computer heruntergeladen. Speichern Sie die heruntergeladene JSON-Datei als
credentials.json
in Ihrem Arbeitsverzeichnis. Diese Datei ist die einzige Kopie dieses Schlüssels. Informationen zum sicheren Speichern des Schlüssels finden Sie unter Dienstkontoschlüssel verwalten. - Klicken Sie auf Schließen.
Domainweite Delegierung für ein Dienstkonto einrichten
Damit APIs im Namen von Nutzern in einer Google Workspace-Organisation aufgerufen werden können, muss Ihrem Dienstkonto in der Admin-Konsole von einem Super Admin-Konto die domainweite Delegierung von Berechtigungen gewährt werden. Weitere Informationen finden Sie unter Domainweite Befugnisse an ein Dienstkonto delegieren.- Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > Dienstkonten. und dann auf IAM und Verwaltung
- Wählen Sie Ihr Dienstkonto aus.
- Klicken Sie auf Erweiterte Einstellungen anzeigen.
- Suchen Sie unter „Domainweite Delegation“ nach der „Client-ID“ Ihres Dienstkontos. Klicken Sie auf „Kopieren“ , um den Client-ID-Wert in die Zwischenablage zu kopieren.
Wenn Sie Super Admin-Zugriff auf das betreffende Google Workspace-Konto haben, klicken Sie auf Google Workspace Admin-Konsole ansehen, melden Sie sich mit einem Super Admin-Nutzerkonto an und fahren Sie mit diesen Schritten fort.
Wenn Sie keinen Super Admin-Zugriff auf das betreffende 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 die Liste der OAuth-Bereiche, damit er die folgenden Schritte in der Admin-Konsole ausführen kann.
- Ö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.
- Fügen Sie in das Feld „Client-ID“ die zuvor kopierte Client-ID ein.
- Geben Sie im Feld „OAuth-Bereiche“ eine durch Kommas getrennte Liste der für Ihre Anwendung erforderlichen Bereiche ein. Dies sind dieselben Berechtigungen, die Sie beim Konfigurieren des OAuth-Zustimmungsbildschirms festgelegt 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
, die Sie zuvor heruntergeladen haben, in das Verzeichnissrc/main/resources/
.Öffnen Sie die Standarddatei
build.gradle
und ersetzen Sie den Inhalt durch den 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, der demmainClassName
-Wert in der Dateibuild.gradle
entspricht.Fügen Sie der neuen Java-Datei den folgenden Code hinzu:
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
Beispiel ausführen:
gradle run
-
Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:
- 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 Keep API auf.
Autorisierungsinformationen werden im Dateisystem gespeichert. Wenn Sie den Beispielcode das nächste Mal ausführen, werden Sie nicht zur Autorisierung aufgefordert.
Nächste Schritte
- Fehlerbehebung bei Authentifizierungs- und Autorisierungsproblemen
- Referenzdokumentation zur Google Keep API
- Dokumentation zum Google APIs Client für Java
- Javadoc-Dokumentation zur Google Keep API