דף זה תורגם על ידי Cloud Translation API.

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

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

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

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

מטרות

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

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

חשבון Google.

הגדרת הסביבה

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

הפעלת ה-API

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

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

הפעלת ה-API

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

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

במסוף Google Cloud, נכנסים לתפריט > APIs & Services > מסך ההסכמה של OAuth.
מעבר למסך ההסכמה של OAuth
בהגדרה סוג משתמש, בוחרים באפשרות פנימי ולוחצים על יצירה.
ממלאים את טופס ההרשמה לאפליקציה ולוחצים על שמירה והמשך.
בינתיים, אפשר לדלג על הוספת היקפים וללחוץ על שמירה והמשך. בעתיד, כשיוצרים אפליקציה לשימוש מחוץ לארגון ב-Google Workspace, צריך לשנות את סוג המשתמש לחיצוני ואז להוסיף את היקפי ההרשאות שנדרשים לאפליקציה.
לבדוק את הסיכום של רישום האפליקציה. כדי לבצע שינויים, לוחצים על עריכה. אם הרישום של האפליקציה נראה בסדר, לוחצים על Back to Dashboard (חזרה למרכז השליטה).

אישור פרטי כניסה לאפליקציה בשולחן העבודה

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

במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
כניסה לדף Credentials
לוחצים על יצירת פרטי כניסה > מזהה לקוח OAuth.
לוחצים על סוג האפליקציה > אפליקציה למחשב.
בשדה שם, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
לוחצים על יצירה. מופיע המסך של לקוח OAuth שנוצר, ומוצגים בו מזהה הלקוח וסוד הלקוח החדשים.
לוחצים על אישור. פרטי הכניסה החדשים שנוצרו מופיעים בקטע מזהי לקוח ב-OAuth 2.0.
שומרים את קובץ ה-JSON שהורדתם בתור credentials.json ומעבירים אותו לספריית העבודה.

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

בספריית העבודה, יוצרים מבנה פרויקט חדש:
```
gradle init --type basic
mkdir -p src/main/java src/main/resources 
```
בספרייה src/main/resources/, מעתיקים את הקובץ credentials.json שהורדתם בעבר.
פותחים את קובץ ברירת המחדל 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'
}
```

הגדרת הדוגמה

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

כוללים את הקוד הבא בקובץ ה-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);
  }
}

הרצת הדוגמה

מריצים את הדוגמה:
```
gradle run
```

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

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