Krótkie wprowadzenie do Node.js

Przewodniki szybkiego startu wyjaśniają, jak skonfigurować i uruchamiać aplikację, która wywołuje interfejs Google Workspace API.

Krótkie wprowadzenie do Google Workspace wykorzystuje biblioteki klienta API do obsługi niektórych szczegóły procesu uwierzytelniania i autoryzacji. Zalecamy używasz bibliotek klienta we własnych aplikacjach. W tym krótkim wprowadzeniu użyto uproszczone metody uwierzytelniania odpowiednie do testowania dla środowiska. W przypadku środowiska produkcyjnego zalecamy zapoznanie się z informacjami na temat uwierzytelniania i autoryzacji, zanim wybierzesz odpowiednie dla swojej aplikacji poświadczenia dostępu.

utworzyć aplikację wiersza poleceń Node.js, która wysyła żądania do Interfejs API Google Chat.

Cele

• skonfigurować środowisko,
• Zainstaluj bibliotekę klienta.
• Skonfiguruj próbkę.
• Uruchom przykład.

Wymagania wstępne

Aby wykonać ten samouczek, musisz spełnić te wymagania wstępne:

• Node.js i npm są zainstalowane.
• projekt Google Cloud,

• Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.

Konfigurowanie środowiska

Aby rozpocząć krótkie wprowadzenie, skonfiguruj środowisko.

Włącz API

Zanim zaczniesz używać interfejsów API Google, musisz je włączyć w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.

• W konsoli Google Cloud włącz interfejs Google Chat API.

  Włączanie interfejsu API

Konfigurowanie ekranu zgody OAuth

Jeśli do wykonania tego samouczka używasz nowego projektu Google Cloud, skonfiguruj ekran akceptacji OAuth i dodaj siebie jako użytkownika testowego. Jeśli masz już konto Google ten krok został wykonany w Twoim projekcie Cloud, przejdź do następnej sekcji.

1. W konsoli Google Cloud otwórz menu . > Interfejsy API i Usługi > Ekran zgody OAuth.

   Otwórz ekran zgody OAuth

2. Jako Typ użytkownika wybierz Wewnętrzny i kliknij Utwórz.
3. Wypełnij formularz rejestracji aplikacji, a potem kliknij Zapisz i kontynuuj.

4. Możesz pominąć dodawanie zakresów i kliknąć Zapisz i kontynuuj. Gdy w przyszłości będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny, a następnie dodać zakresy autoryzacji wymagane przez aplikację.

5. Przejrzyj podsumowanie rejestracji aplikacji. Aby wprowadzić zmiany, kliknij Edytuj. Jeśli rejestracja aplikacji wygląda dobrze, kliknij Powrót do panelu.

Autoryzacja danych logowania w aplikacji komputerowej

Aby uwierzytelniać użytkowników i dostępować do ich danych w aplikacji, musisz utworzyć co najmniej 1 identyfikator klienta OAuth 2.0. Identyfikator klienta służy do identyfikowania z jedną aplikacją na serwery OAuth Google. Jeśli Twoja aplikacja działa na kilku platformach, musisz utworzyć osobny identyfikator klienta dla każdej z nich.

Uwaga: ten przewodnik należy uruchomić lokalnie i z dostępem do przeglądarki. Nie działa ona, jeśli jest uruchamiana na zdalnym terminalu, takim jak Cloud Shell, lub przez SSH.

1. W konsoli Google Cloud kliknij Menu  > Interfejsy API i usługi > Dane logowania.

   Przejdź do danych logowania

2. Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
3. Kliknij Typ aplikacji > Aplikacja na komputer.
4. W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
5. Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
6. Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.
7. Zapisz pobrany plik JSON jako credentials.json i przenieś plik do katalogu roboczego.

Konfigurowanie aplikacji Google Chat

Aby wywołać interfejs Google Chat API, musisz skonfigurować aplikacji Google Chat. W przypadku wszelkich żądań zapisu Google Chat atrybut aplikacji Google Chat w interfejsie za pomocą atrybutu poniższe informacje.

1. W konsoli Google Cloud otwórz stronę Konfiguracja interfejsu API Chat:

   Otwórz stronę konfiguracji Chat API

2. W sekcji Informacje o aplikacji podaj te dane:

   1. W polu Nazwa aplikacji wpisz Chat API quickstart app.
   2. W polu URL awatara wpisz https://developers.google.com/chat/images/quickstart-app-avatar.png
   3. W polu Opis wpisz Quickstart for calling the Chat API.

3. W sekcji Funkcje interaktywne kliknij przełącznik Włącz funkcje interaktywne, aby wyłączyć funkcje interaktywne w aplikacji Google Chat.

4. Kliknij Zapisz.

Instalowanie biblioteki klienta

• Zainstaluj biblioteki przy użyciu npm:

  npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save
  

Konfigurowanie próbki

1. W katalogu roboczym utwórz plik o nazwie index.js.

2. Wklej do pliku ten kod:

   chat/quickstart/index.js

   Wyświetl w GitHubie

   const fs = require('fs').promises;
   const path = require('path');
   const process = require('process');
   const {authenticate} = require('@google-cloud/local-auth');
   const {ChatServiceClient} = require('@google-apps/chat');
   const {auth} = require('google-auth-library');
   
   // If modifying these scopes, delete token.json.
   const SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];
   
   // The file token.json stores the user's access and refresh tokens, and is
   // created automatically when the authorization flow completes for the first
   // time.
   const TOKEN_PATH = path.join(process.cwd(), 'token.json');
   const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');
   
   /**
    * Reads previously authorized credentials from the save file.
    *
    * @return {Promise<OAuth2Client|null>}
    */
   async function loadSavedCredentialsIfExist() {
     try {
       const content = await fs.readFile(TOKEN_PATH);
       const credentials = JSON.parse(content);
       return auth.fromJSON(credentials);
     } catch (err) {
       console.log(err);
       return null;
     }
   }
   
   /**
    * Serializes credentials to a file compatible with GoogleAuth.fromJSON.
    *
    * @param {OAuth2Client} client
    * @return {Promise<void>}
    */
   async function saveCredentials(client) {
     const content = await fs.readFile(CREDENTIALS_PATH);
     const keys = JSON.parse(content);
     const key = keys.installed || keys.web;
     const payload = JSON.stringify({
       type: 'authorized_user',
       client_id: key.client_id,
       client_secret: key.client_secret,
       refresh_token: client.credentials.refresh_token,
     });
     await fs.writeFile(TOKEN_PATH, payload);
   }
   
   /**
    * Load or request or authorization to call APIs.
    *
    * @return {Promise<OAuth2Client>}
    */
   async function authorize() {
     let client = await loadSavedCredentialsIfExist();
     if (client) {
       return client;
     }
     client = await authenticate({
       scopes: SCOPES,
       keyfilePath: CREDENTIALS_PATH,
     });
     if (client.credentials) {
       await saveCredentials(client);
     }
     return client;
   }
   
   /**
    * Lists spaces with user credential.
    * @param {OAuth2Client} authClient An authorized OAuth2 client.
    */
   async function listSpaces(authClient) {
     // Create a client
     const chatClient = new ChatServiceClient({
       authClient: authClient,
       scopes: SCOPES,
     });
   
     // Initialize request argument(s)
     const request = {
       // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
       filter: 'space_type = "SPACE"'
     };
   
     // Make the request
     const pageResult = chatClient.listSpacesAsync(request);
   
     // Handle the response. Iterating over pageResult will yield results and
     // resolve additional pages automatically.
     for await (const response of pageResult) {
       console.log(response);
     }
   }
   
   authorize().then(listSpaces).catch(console.error);
   

Uruchamianie przykładu

1. W katalogu roboczym uruchom przykładowy kod:

   node .
   

2. Przy pierwszym uruchomieniu przykładu pojawi się prośba o autoryzację dostępu:
   1. Jeśli wyświetli się prośba o zalogowanie się na konto Google, zaloguj się. Jeśli używasz wielu kont, wybierz jedno konto do autoryzacji.
   2. Kliknij Accept (Zaakceptuj).

   Twoja aplikacja Nodejs uruchamia się i wywołuje interfejs Google Chat API.

   Informacje autoryzacyjne są przechowywane w systemie plików, więc następnym razem, gdy uruchomisz przykładowy kod, nie pojawi się prośba o autoryzację.

Dalsze kroki

• Klient Google Chat API w GitHubie