Краткое руководство по Java

В кратких руководствах объясняется, как настроить и запустить приложение, вызывающее API Google Workspace.

В кратких руководствах по Google Workspace клиентские библиотеки API используются для обработки некоторых деталей процесса аутентификации и авторизации. Мы рекомендуем вам использовать клиентские библиотеки для ваших собственных приложений. В этом кратком руководстве используется упрощенный подход к аутентификации, подходящий для среды тестирования. В производственной среде мы рекомендуем изучить аутентификацию и авторизацию, прежде чем выбирать учетные данные доступа , подходящие для вашего приложения.

Создайте приложение командной строки Java, которое отправляет запросы к API Google Chat.

Цели

• Настройте свою среду.
• Настройте образец.
• Запустите образец.

Предварительные условия

• Java 1.8 или выше.
• Gradle 7.0 или выше .
• Проект Google Cloud .

• Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .

Настройте свою среду

Чтобы завершить это краткое руководство, настройте свою среду.

Включить API

Прежде чем использовать API Google, вам необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.

• В консоли Google Cloud включите API Google Chat.

  Включить API

Настройка экрана согласия OAuth

Если вы используете новый проект Google Cloud для выполнения этого краткого руководства, настройте экран согласия OAuth и добавьте себя в качестве тестового пользователя. Если вы уже выполнили этот шаг для своего облачного проекта, перейдите к следующему разделу.

1. В консоли Google Cloud выберите menu > API и службы > Экран согласия OAuth .

   Перейдите на экран согласия OAuth.

2. В качестве типа пользователя выберите «Внутренний» , затем нажмите « Создать» .
3. Заполните форму регистрации приложения, затем нажмите «Сохранить и продолжить» .

4. На данный момент вы можете пропустить добавление областей и нажать «Сохранить и продолжить» . В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вам необходимо изменить тип пользователя на Внешний , а затем добавить области авторизации, необходимые вашему приложению.

5. Просмотрите сводку регистрации приложения. Чтобы внести изменения, нажмите «Изменить» . Если регистрация приложения выглядит нормально, нажмите «Вернуться на панель управления» .

Авторизация учетных данных для настольного приложения

Чтобы аутентифицировать конечных пользователей и получить доступ к пользовательским данным в вашем приложении, вам необходимо создать один или несколько идентификаторов клиентов OAuth 2.0. Идентификатор клиента используется для идентификации одного приложения на серверах Google OAuth. Если ваше приложение работает на нескольких платформах, вам необходимо создать отдельный идентификатор клиента для каждой платформы.

1. В консоли Google Cloud выберите menu > API и службы > Учетные данные .

   Перейти к учетным данным

2. Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
3. Нажмите Тип приложения > Приложение для ПК .
4. В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
5. Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
6. Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
7. Сохраните загруженный файл JSON как credentials.json и переместите его в свой рабочий каталог.

Настройте приложение Google Chat

Чтобы вызвать API Google Chat, необходимо настроить приложение Google Chat. Для любых запросов на запись Google Chat атрибутирует приложение Google Chat в пользовательском интерфейсе, используя следующую информацию.

1. В консоли Google Cloud перейдите на страницу конфигурации Chat API:

   Перейдите на страницу конфигурации API чата.

2. В разделе «Информация о приложении» введите следующую информацию:

   1. В поле «Имя приложения» введите Chat API quickstart app .
   2. В поле URL-адрес аватара введите https://developers.google.com/chat/images/quickstart-app-avatar.png .
   3. В поле «Описание» введите Quickstart for calling the Chat API .

3. В разделе «Интерактивные функции » установите переключатель « Включить интерактивные функции» в положение «Выкл.», чтобы отключить интерактивные функции для приложения Chat.

4. Нажмите Сохранить .

Подготовьте рабочее место

1. В своем рабочем каталоге создайте новую структуру проекта:

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

2. В каталоге src/main/resources/ скопируйте ранее скачанный файл credentials.json .

3. Откройте файл build.gradle по умолчанию и замените его содержимое следующим кодом:

   чат/быстрый старт/build.gradle

   Посмотреть на GitHub

   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'ChatQuickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.auth:google-auth-library-oauth2-http:1.23.0'
       implementation 'com.google.api-client:google-api-client:1.33.0'
       implementation 'com.google.api.grpc:proto-google-cloud-chat-v1:0.8.0'
       implementation 'com.google.api:gax:2.48.1'
       implementation 'com.google.cloud:google-cloud-chat:0.1.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
   }
   

Настройка образца

1. В каталоге src/main/java/ создайте новый файл Java с именем, соответствующим значению mainClassName в вашем файле build.gradle .

2. Включите следующий код в новый файл Java:

   чат/quickstart/src/main/java/ChatQuickstart.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.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.gax.core.FixedCredentialsProvider;
   import com.google.auth.Credentials;
   import com.google.auth.oauth2.AccessToken;
   import com.google.auth.oauth2.UserCredentials;
   import com.google.chat.v1.ChatServiceClient;
   import com.google.chat.v1.ChatServiceSettings;
   import com.google.chat.v1.ListSpacesRequest;
   import com.google.chat.v1.Space;
   import com.google.protobuf.util.JsonFormat;
   import java.io.File;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.util.Collections;
   import java.util.Date;
   import java.util.List;
   
   /* class to demonstrate use of Google Chat API spaces list API */
   public class ChatQuickstart {
     /** Directory to store authorization tokens for this application. */
     private static final String TOKENS_DIRECTORY_PATH = "tokens";
   
     /**
      * Global instance of the scopes required by this quickstart. If modifying these scopes, delete
      * your previously saved tokens/ folder.
      */
     private static final List<String> SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/chat.spaces.readonly");
   
     /** Global instance of the JSON factory. */
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
   
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Run the OAuth2 flow for local/installed app.
      *
      * @return An authorized Credential object.
      * @throws IOException If the credentials.json file cannot be found.
      */
     private static Credentials getCredentials() throws Exception {
       // Load client secrets.
       InputStream credentialsFileInputStream =
           ChatQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (credentialsFileInputStream == null) {
         throw new FileNotFoundException("Credentials file resource not found.");
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(credentialsFileInputStream));
   
       // Set up authorization code flow.
       GoogleAuthorizationCodeFlow flow =
           new GoogleAuthorizationCodeFlow.Builder(
                   GoogleNetHttpTransport.newTrustedTransport(), JSON_FACTORY, clientSecrets, SCOPES)
               // Set these two options to generate refresh token alongside access token.
               .setDataStoreFactory(new FileDataStoreFactory(new File(TOKENS_DIRECTORY_PATH)))
               .setAccessType("offline")
               .build();
   
       // Authorize.
       Credential credential =
           new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
   
       // Build and return an authorized Credential object
       AccessToken accessToken =
           new AccessToken(
               credential.getAccessToken(),
               new Date(
                   // put the actual expiry date of access token here
                   System.currentTimeMillis()));
       return UserCredentials.newBuilder()
           .setAccessToken(accessToken)
           .setRefreshToken(credential.getRefreshToken())
           .setClientId(clientSecrets.getInstalled().getClientId())
           .setClientSecret(clientSecrets.getInstalled().getClientSecret())
           .build();
     }
   
     public static void main(String... args) throws Exception {
       // Override default service settings to supply user credentials.
       Credentials credentials = getCredentials();
   
       // Create the ChatServiceSettings with the credentials
       ChatServiceSettings chatServiceSettings =
           ChatServiceSettings.newBuilder()
               .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
               .build();
   
       try (ChatServiceClient chatServiceClient = ChatServiceClient.create(chatServiceSettings)) {
         ListSpacesRequest request =
             ListSpacesRequest.newBuilder()
                 // Filter spaces by space type (SPACE or GROUP_CHAT or
                 // DIRECT_MESSAGE).
                 .setFilter("spaceType = \"SPACE\"")
                 .build();
   
         // Iterate over results and resolve additional pages automatically.
         for (Space response : chatServiceClient.listSpaces(request).iterateAll()) {
           System.out.println(JsonFormat.printer().print(response));
         }
       }
     }
   }

Запустите образец

1. Запустите образец:

   gradle run
   

2. При первом запуске примера вам будет предложено авторизовать доступ:
   1. Если вы еще не вошли в свою учетную запись Google, войдите в систему, когда будет предложено. Если вы вошли в несколько учетных записей, выберите одну учетную запись, которая будет использоваться для авторизации.
   2. Нажмите Принять .

   Ваше Java-приложение запускается и вызывает API Google Chat.

   Информация об авторизации хранится в файловой системе, поэтому при следующем запуске примера кода вам не будет предложено авторизоваться.

Следующие шаги

• Документация Javadoc по API Google Chat