מדריך למתחילים ב-Java

יצירת אפליקציה של שורת פקודה ב-Java ששולחת בקשות ל-Google Drive Activity API.

במדריכים אחרים למתחילים מוסבר איך להגדיר ולהריץ אפליקציה שקוראת ל-Google Workspace API. במדריך הנוכחי נשתמש בגישה פשוטה לאימות, שמתאימה לסביבת בדיקה. בסביבת ייצור, אנחנו ממליצים לכם לקרוא על אימות והרשאה לפני שאתם בוחרים את פרטי הגישה שמתאימים לאפליקציה שלכם.

במדריך הזה אנחנו משתמשים ב-API המומלץ של ספריות הלקוח ב-Google Workspace כדי לטפל בחלק מהפרטים של תהליך האימות וההרשאה.

מטרות

• מגדירים את הסביבה.
• מגדירים את הדוגמה.
• מריצים את הדוגמה.

דרישות מוקדמות

• ‫Java מגרסה 11 ואילך.
• ‫Gradle 7.0 ואילך.
• פרויקט ב-Google Cloud.

• חשבון Google.

הגדרת הסביבה

כדי לסיים את המדריך למתחילים הזה, אתם צריכים להגדיר את הסביבה.

מפעילים את ה-API

לפני שאתם משתמשים בממשקי Google API, אם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.

• במסוף Google Cloud, מפעילים את Google Drive Activity API.

  להפעלת ה-API

מגדירים את מסך ההסכמה של OAuth

אם אתם משתמשים במדריך הזה בפרויקט חדש ב-Google Cloud, אתם צריכים להגדיר את מסך ההסכמה ל-OAuth. אם כבר ביצעתם את השלב הזה בפרויקט שלכם ב-Cloud, אתם יכולים לדלג לקטע הבא.

1. במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Branding.

   מעבר לדף Branding

2. אם כבר הגדרתם את Google Auth platform, אתם יכולים לקבוע את ההגדרות הבאות של מסך ההסכמה ל-OAuth בקטעים Branding,‏ Audience וData Access. אם מופיעה ההודעה Google Auth platform not configured yet, לוחצים על Get Started:
1. בקטע App Information בשדה App name, מזינים שם לאפליקציה.
2. בקטע User support email, בוחרים כתובת אימייל לתמיכה שאליה משתמשים יפנו אם יש להם שאלות לגבי ההסכמה שלהם.
3. לוחצים על Next.
4. בקטע Audience, לוחצים על Internal.
5. לוחצים על Next.
6. בקטע Contact Information, מזינים כתובת אימייל שאליה אפשר לשלוח התראות על שינויים בפרויקט.
7. לוחצים על Next.
8. בקטע Finish, קוראים את המדיניות של Google בנושא נתוני משתמשים בשירותי API. אם אתם מסכימים, מסמנים את התיבה I agree to the Google API Services: User Data Policy.
9. לוחצים על Continue.
10. לוחצים על Create.
3. כרגע אתם יכולים לדלג על הוספת היקפי הרשאות. בעתיד, כשתיצרו אפליקציה לשימוש מחוץ לארגון שלכם ב-Google Workspace, תצטרכו לשנות את סוג המשתמש ל-External. לאחר מכן מוסיפים את היקפי ההרשאות שהאפליקציה דורשת. למידע נוסף, אפשר לעיין במדריך המלא בנושא הגדרת הסכמה ל-OAuth.

מאשרים את פרטי הכניסה של האפליקציה למחשב

כדי לאמת משתמשי קצה ולגשת לנתוני משתמשים באפליקציה, צריך ליצור מזהה לקוח אחד או יותר ב-OAuth 2.0. מזהה הלקוח משמש לזיהוי של אפליקציה אחת בשרתי OAuth של Google. אם האפליקציה פועלת בכמה פלטפורמות, צריך ליצור מזהה לקוח נפרד לכל פלטפורמה.

1. במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Clients.

   כניסה לדף Clients

2. לוחצים על Create Client.
3. לוחצים על Application type‏ > Desktop app.
4. בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
5. לוחצים על Create.

   פרטי הכניסה החדשים שנוצרו מופיעים בקטע OAuth 2.0 Client IDs.

6. שומרים את קובץ ה-JSON שהורדתם בשם credentials.json ומעבירים את הקובץ לספריית העבודה.

הכנת סביבת העבודה

1. בספריית העבודה, יוצרים מבנה פרויקט חדש:

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. בספרייה src/main/resources/, מעתיקים את הקובץ credentials.json שהורדתם קודם.

3. פותחים את קובץ ברירת המחדל build.gradle ומחליפים את התוכן שלו בקוד הבא:

   drive/activity-v2/quickstart/build.gradle

   הצגת הקוד ב-GitHub
   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'DriveActivityQuickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:2.0.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
       implementation 'com.google.apis:google-api-services-driveactivity:v2-rev20220926-2.0.0'
   }

מגדירים את הדוגמה

1. בספרייה src/main/java/, יוצרים קובץ Java חדש עם שם שזהה לערך mainClassName בקובץ build.gradle.

2. מוסיפים את הקוד הבא לקובץ ה-Java החדש:

   drive/activity-v2/quickstart/src/main/java/DriveActivityQuickstart.java

   הצגת הקוד ב-GitHub
   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.HttpTransport;
   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.driveactivity.v2.DriveActivityScopes;
   import com.google.api.services.driveactivity.v2.model.*;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.util.AbstractMap;
   import java.util.Arrays;
   import java.util.Iterator;
   import java.util.List;
   import java.util.stream.Collectors;
   
   public class DriveActivityQuickstart {
     /**
      * Application name.
      */
     private static final String APPLICATION_NAME = "Drive Activity API Java Quickstart";
   
     /**
      * Directory to store authorization tokens for this application.
      */
     private static final java.io.File DATA_STORE_DIR = new java.io.File("tokens");
     /**
      * Global instance of the JSON factory.
      */
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
     /**
      * Global instance of the scopes required by this quickstart.
      *
      * <p>If modifying these scopes, delete your previously saved tokens/ folder.
      */
     private static final List<String> SCOPES =
         Arrays.asList(DriveActivityScopes.DRIVE_ACTIVITY_READONLY);
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
     /**
      * Global instance of the {@link FileDataStoreFactory}.
      */
     private static FileDataStoreFactory DATA_STORE_FACTORY;
     /**
      * Global instance of the HTTP transport.
      */
     private static HttpTransport HTTP_TRANSPORT;
   
     static {
       try {
         HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
         DATA_STORE_FACTORY = new FileDataStoreFactory(DATA_STORE_DIR);
       } catch (Throwable t) {
         t.printStackTrace();
         System.exit(1);
       }
     }
   
     /**
      * Creates an authorized Credential object.
      *
      * @return an authorized Credential object.
      * @throws IOException
      */
     public static Credential authorize() throws IOException {
       // Load client secrets.
       InputStream in = DriveActivityQuickstart.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, SCOPES)
               .setDataStoreFactory(DATA_STORE_FACTORY)
               .setAccessType("offline")
               .build();
       Credential credential =
           new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver())
               .authorize("user");
       System.out.println("Credentials saved to " + DATA_STORE_DIR.getAbsolutePath());
       return credential;
     }
   
     /**
      * Build and return an authorized Drive Activity client service.
      *
      * @return an authorized DriveActivity client service
      * @throws IOException
      */
     public static com.google.api.services.driveactivity.v2.DriveActivity getDriveActivityService()
         throws IOException {
       Credential credential = authorize();
       com.google.api.services.driveactivity.v2.DriveActivity service =
           new com.google.api.services.driveactivity.v2.DriveActivity.Builder(
               HTTP_TRANSPORT, JSON_FACTORY, credential)
               .setApplicationName(APPLICATION_NAME)
               .build();
       return service;
     }
   
     public static void main(String[] args) throws IOException {
       // Build a new authorized API client service.
       com.google.api.services.driveactivity.v2.DriveActivity service = getDriveActivityService();
   
       // Print the recent activity in your Google Drive.
       QueryDriveActivityResponse result =
           service.activity().query(new QueryDriveActivityRequest().setPageSize(10)).execute();
       List<DriveActivity> activities = result.getActivities();
       if (activities == null || activities.size() == 0) {
         System.out.println("No activity.");
       } else {
         System.out.println("Recent activity:");
         for (DriveActivity activity : activities) {
           String time = getTimeInfo(activity);
           String action = getActionInfo(activity.getPrimaryActionDetail());
           List<String> actors =
               activity.getActors().stream()
                   .map(DriveActivityQuickstart::getActorInfo)
                   .collect(Collectors.toList());
           List<String> targets =
               activity.getTargets().stream()
                   .map(DriveActivityQuickstart::getTargetInfo)
                   .collect(Collectors.toList());
           System.out.printf(
               "%s: %s, %s, %s\n", time, truncated(actors), action, truncated(targets));
         }
       }
     }
   
     /**
      * Returns a string representation of the first elements in a list.
      */
     private static String truncated(List<String> array) {
       return truncatedTo(array, 2);
     }
   
     /**
      * Returns a string representation of the first elements in a list.
      */
     private static String truncatedTo(List<String> array, int limit) {
       String contents = array.stream().limit(limit).collect(Collectors.joining(", "));
       String more = array.size() > limit ? ", ..." : "";
       return "[" + contents + more + "]";
     }
   
     /**
      * Returns the name of a set property in an object, or else "unknown".
      */
     private static <T> String getOneOf(AbstractMap<String, T> obj) {
       Iterator<String> iterator = obj.keySet().iterator();
       return iterator.hasNext() ? iterator.next() : "unknown";
     }
   
     /**
      * Returns a time associated with an activity.
      */
     private static String getTimeInfo(DriveActivity activity) {
       if (activity.getTimestamp() != null) {
         return activity.getTimestamp();
       }
       if (activity.getTimeRange() != null) {
         return activity.getTimeRange().getEndTime();
       }
       return "unknown";
     }
   
     /**
      * Returns the type of action.
      */
     private static String getActionInfo(ActionDetail actionDetail) {
       return getOneOf(actionDetail);
     }
   
     /**
      * Returns user information, or the type of user if not a known user.
      */
     private static String getUserInfo(User user) {
       if (user.getKnownUser() != null) {
         KnownUser knownUser = user.getKnownUser();
         Boolean isMe = knownUser.getIsCurrentUser();
         return (isMe != null && isMe) ? "people/me" : knownUser.getPersonName();
       }
       return getOneOf(user);
     }
   
     /**
      * Returns actor information, or the type of actor if not a user.
      */
     private static String getActorInfo(Actor actor) {
       if (actor.getUser() != null) {
         return getUserInfo(actor.getUser());
       }
       return getOneOf(actor);
     }
   
     /**
      * Returns the type of a target and an associated title.
      */
     private static String getTargetInfo(Target target) {
       if (target.getDriveItem() != null) {
         return "driveItem:\"" + target.getDriveItem().getTitle() + "\"";
       }
       if (target.getDrive() != null) {
         return "drive:\"" + target.getDrive().getTitle() + "\"";
       }
       if (target.getFileComment() != null) {
         DriveItem parent = target.getFileComment().getParent();
         if (parent != null) {
           return "fileComment:\"" + parent.getTitle() + "\"";
         }
         return "fileComment:unknown";
       }
       return getOneOf(target);
     }
   }

מריצים את הדוגמה

1. מריצים את הדוגמה:

   gradle run
   

2. בפעם הראשונה שמריצים את הדוגמה, מוצגת בקשה לאישור הגישה:
   1. אם עדיין לא נכנסתם לחשבון Google, תתבקשו להיכנס אליו. אם נכנסתם לכמה חשבונות, בחרו חשבון אחד שבו תרצו להשתמש לצורך הרשאה.
   2. לוחצים על Accept.

   אפליקציית Java פועלת ושולחת קריאה אל Google Drive Activity API.

   פרטי ההרשאה מאוחסנים במערכת הקבצים, כך שבפעם הבאה שתריצו את הקוד לדוגמה לא תתבקשו להעניק הרשאה.

השלבים הבאים

• התנסות עם ממשקי Google Workspace API ב-API Explorer
• פתרון בעיות באימות ובהרשאות
• מאמרי העזרה של Drive Activity API
• מאמרי העזרה של Google APIs Client for Java
• תיעוד Javadoc של Google Drive Activity API