Java-Kurzanleitung

In Kurzanleitungen wird beschrieben, wie Sie eine Anwendung einrichten und ausführen, die eine Google Workspace API aufruft.

In Google Workspace-Kurzanleitungen werden die Details der Authentifizierung und Autorisierung mithilfe der API-Clientbibliotheken verarbeitet. Wir empfehlen, für Ihre eigenen Anwendungen die Clientbibliotheken zu verwenden. Bevor Sie die Beispielanwendung ausführen können, müssen Sie für jede Kurzanleitung die Authentifizierung und Autorisierung aktivieren. Wenn Sie mit der Authentifizierung und Autorisierung für Google Workspace APIs nicht vertraut sind, lesen Sie die Übersicht über die Authentifizierung und Autorisierung.

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

  • Ein Google-Konto mit Google Notizen.

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.

    API aktivieren

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 auf Daten zuzugreifen oder Aktionen des Robot-Kontos auszuführen oder um im Namen von Google Workspace- oder Cloud Identity-Nutzern auf Daten zuzugreifen. Weitere Informationen finden Sie unter Details zu Dienstkonten.
  1. Rufen Sie in der Google Cloud Console das Menü > IAM & Verwaltung > Dienstkonten auf.

    Zur Seite „Dienstkonten“

  2. Klicken Sie auf Dienstkonto erstellen.
  3. Geben Sie die Details zum Dienstkonto ein und klicken Sie dann auf Erstellen und fortfahren.
  4. 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.
  5. Klicken Sie auf Weiter.
  6. 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.
  7. Klicken Sie auf Fertig.

Anmeldedaten für ein Dienstkonto erstellen

Sie benötigen Anmeldedaten in Form eines Paars aus öffentlichem und privatem Schlüssel. Diese Anmeldedaten werden von Ihrem Code verwendet, um Dienstkontoaktionen in Ihrer Anwendung zu autorisieren.
  1. Rufen Sie in der Google Cloud Console das Menü > IAM & Verwaltung > Dienstkonten auf.

    Zur Seite „Dienstkonten“

  2. Wählen Sie Ihr Dienstkonto aus.
  3. Klicken Sie auf Schlüssel > Schlüssel hinzufügen > Neuen Schlüssel erstellen.
  4. Wählen Sie JSON aus und klicken Sie dann auf Erstellen.

    Das neue Paar aus öffentlichem und privatem Schlüssel wird generiert und als neue Datei auf Ihren Computer heruntergeladen. Diese Datei ist die einzige Kopie dieses Schlüssels. Informationen zum sicheren Speichern von Schlüsseln finden Sie unter Dienstkontoschlüssel verwalten.

  5. Klicken Sie auf Schließen.

Domainweite Delegierung für ein Dienstkonto einrichten

Zum Aufrufen von APIs im Namen von Nutzern in einer Google Workspace-Organisation muss Ihrem Dienstkonto in der Google Workspace-Admin-Konsole eine domainweite Delegierung von Befugnissen über ein Super Admin-Konto gewährt werden. Weitere Informationen finden Sie unter Domainweite Autorität an ein Dienstkonto delegieren.
  1. Rufen Sie in der Google Cloud Console das Menü > IAM & Verwaltung > Dienstkonten auf.

    Zur Seite „Dienstkonten“

  2. Wählen Sie Ihr Dienstkonto aus.
  3. Klicken Sie auf Erweiterte Einstellungen anzeigen.
  4. Suchen Sie unter „Domainweite Delegierung“ 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 entsprechende Google Workspace-Konto haben, klicken Sie auf Google Workspace-Admin-Konsole anzeigen, melden Sie sich mit einem Super Admin-Nutzerkonto an und führen Sie die folgenden Schritte aus.

Wenn Sie keinen Poweruser-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 und die Liste der OAuth-Umfänge Ihres Dienstkontos, damit er die folgenden Schritte in der Admin-Konsole ausführen kann.

  1. Gehen Sie in der Admin-Konsole zu „Menü“ > Sicherheit > Zugriffs- und Datenkontrolle > API-Steuerelemente.

    API-Steuerelemente aufrufen

  2. Klicken Sie auf Domainweite Delegierung verwalten.
  3. Klicken Sie auf Neu hinzufügen.
  4. Fügen Sie in das Feld „Client-ID“ die Client-ID ein, die Sie in Schritt 5 kopiert haben.
  5. Geben Sie im Feld „OAuth-Bereiche“ eine durch Kommas getrennte Liste der Bereiche ein, die für Ihre Anwendung erforderlich sind. Dies sind dieselben Bereiche, die Sie beim Konfigurieren des OAuth-Zustimmungsbildschirms definiert haben.
  6. Klicken Sie auf Authorize (Autorisieren).

Arbeitsbereich vorbereiten

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine neue Projektstruktur:

    gradle init --type basic
    mkdir -p src/main/java src/main/resources 
    
  2. Kopieren Sie im Verzeichnis src/main/resources/ die Datei credentials.json, die Sie zuvor heruntergeladen haben.

  3. Ö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

  1. Erstellen Sie im Verzeichnis src/main/java/ eine neue Java-Datei mit einem Namen, der dem Wert von mainClassName in der Datei build.gradle entspricht.

  2. Fügen Sie den folgenden Code in die neue Java-Datei ein:

    {% include "keep/api/_localvars.html" %}
    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

  1. Führen Sie das Beispiel aus:

    gradle run
    
  2. Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:

    1. Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, werden Sie dazu aufgefordert. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie ein Konto für die Autorisierung aus.
    2. Klicken Sie auf Akzeptieren.

    Autorisierungsinformationen werden im Dateisystem gespeichert, sodass Sie beim nächsten Ausführen des Beispielcodes nicht zur Autorisierung aufgefordert werden.

Sie haben Ihre erste Java-Anwendung erstellt, die Anfragen an die Google Notizen API sendet.

Nächste Schritte