Guia de início rápido do Java

Os tutoriais rápidos explicam como configurar e executar um app que chama uma API do Google Workspace.

Os guias de início rápido do Google Workspace usam as bibliotecas de cliente da API para processar alguns detalhes do fluxo de autenticação e autorização. Recomendamos que você use as bibliotecas de cliente para seus próprios apps. Este guia de início rápido usa uma abordagem de autenticação simplificada que é adequada para um ambiente de teste. Para um ambiente de produção, recomendamos que você aprenda sobre autenticação e autorização antes de escolher as credenciais de acesso adequadas para o app.

Crie um aplicativo de linha de comando Java que faça solicitações para a API Google Drive Activity.

Objetivos

  • Prepare o ambiente.
  • Configure a amostra.
  • Execute a amostra.

Pré-requisitos

  • Uma Conta do Google

Configurar o ambiente

Para concluir este guia de início rápido, configure seu ambiente.

Ativar a API

Antes de usar as APIs do Google, você precisa ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.

  • No console do Google Cloud, ative a API Google Drive Activity.

    Ativar a API

Se você estiver usando um novo projeto do Google Cloud para concluir este guia de início rápido, configure a tela de consentimento do OAuth e adicione a si mesmo como um usuário de teste. Se você já concluiu esta etapa para seu projeto do Cloud, pule para a próxima seção.

  1. No console do Google Cloud, acesse Menu > APIs e serviços > Tela de consentimento do OAuth.

    Acessar a tela de permissão OAuth

  2. Em Tipo de usuário, selecione Interno e clique em Criar.
  3. Preencha o formulário de registro do app e clique em Salvar e continuar.

  4. Por enquanto, você pode pular a adição de escopos e clicar em Salvar e continuar. No futuro, ao criar um app para uso fora da sua organização do Google Workspace, você precisará mudar o Tipo de usuário para Externo e, em seguida, adicionar os escopos de autorização necessários para o app.

  5. Analise o resumo do registro do app. Para fazer alterações, clique em Editar. Se o registro do app estiver correto, clique em Voltar ao painel.

Autorizar credenciais para um aplicativo para computador

Para autenticar usuários finais e acessar dados do usuário no app, crie um ou mais IDs do cliente OAuth 2.0. Um ID do cliente é usado para identificar um único app nos servidores OAuth do Google. Se o app for executado em várias plataformas, crie um ID do cliente separado para cada plataforma.
  1. No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.

    Ir para Credenciais

  2. Clique em Criar credenciais > ID do cliente OAuth.
  3. Clique em Tipo de aplicativo > App para computador.
  4. No campo Nome, digite um nome para a credencial. Esse nome só aparece no console do Google Cloud.
  5. Clique em Criar. A tela do cliente OAuth criado aparece, mostrando o novo ID e a chave secreta do cliente.
  6. Clique em OK. A credencial recém-criada aparece em IDs de cliente OAuth 2.0.
  7. Salve o arquivo JSON baixado como credentials.json e mova-o para o diretório de trabalho.

Preparar o espaço de trabalho

  1. No diretório de trabalho, crie uma nova estrutura de projeto:

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

  2. No diretório src/main/resources/, copie o arquivo credentials.json que você fez o download anteriormente.

  3. Abra o arquivo build.gradle padrão e substitua o conteúdo por este código:

    drive/activity-v2/quickstart/build.gradle
    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'
}

Configure a amostra

  1. No diretório src/main/java/, crie um novo arquivo Java com um nome que corresponda ao valor mainClassName no arquivo build.gradle.

  2. Inclua o seguinte código no novo arquivo Java:

    drive/activity-v2/quickstart/src/main/java/DriveActivityQuickstart.java
    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);
  }
}

Executar a amostra

  1. Execute o exemplo:

    gradle run
  1. Na primeira vez que você executar o exemplo, será necessário autorizar o acesso:
    1. Faça login na sua Conta do Google, caso ainda não tenha feito. Se você tiver feito login em várias contas, selecione uma para usar na autorização.
    2. Clique em Aceitar.

    O aplicativo Java é executado e chama a API Google Drive Activity.

    As informações de autorização são armazenadas no sistema de arquivos. Por isso, na próxima vez que você executar o código de exemplo, não será necessário fazer a autorização.

Próximas etapas