Z tego przewodnika dowiesz się, jak używać protokołu OAuth 2.0 z danymi logowania Google użytkowników, aby uzyskać dostęp do interfejsu Chat API. Uwierzytelnianie i autoryzacja za pomocą danych logowania użytkownika umożliwia aplikacjom Google Chat dostęp do danych użytkownika i wykonywanie operacji w imieniu uwierzytelnionego użytkownika. Aplikacja uwierzytelniająca się w imieniu użytkownika, ma takie same uprawnienia jak ten użytkownik i może wykonywać czynności tak samo jak ten użytkownik.
Po uwierzytelnieniu i autoryzowaniu wywołania interfejsu API z danymi logowania użytkownika aplikacje Google Chat mogą:
- tworzyć pokoi czatu,
- dodawać użytkowników do pokoi czatu i rozmów grupowych;
- Dane użytkowników możesz wykonywać w innych interfejsach API Workspace, takich jak:
- Tworzenie wydarzeń w Kalendarzu Google.
- Logować elementy w Arkuszach Google.
- Wyślij e-maila, korzystając z Gmaila.
Gdy aplikacja wykonuje działanie polegające na uwierzytelnianiu użytkownika (np. tworzy pokój), Google Chat wyświetla komunikat o uznaniu autorstwa. Zawiera on nazwę aplikacji, która wykonała działanie w imieniu użytkownika, który ją autoryzował.
Aby dowiedzieć się więcej o tym, kiedy aplikacje Google Chat wymagają uwierzytelniania i jakiego rodzaju uwierzytelniania należy używać, przeczytaj artykuł Typy wymaganego uwierzytelniania w omówieniu uwierzytelniania i autoryzacji interfejsu Chat API.
Uwierzytelnianie i autoryzacja za pomocą przekazywania dostępu w całej domenie
Jeśli jesteś administratorem domeny, możesz przyznać przekazywanie uprawnień w całej domenie, by autoryzować dostęp konta usługi aplikacji do danych użytkowników bez konieczności wyrażenia zgody przez każdego użytkownika. Gdy skonfigurujesz przekazywanie dostępu w całej domenie, konto usługi może przyjąć tożsamość konta użytkownika. Mimo że konto usługi jest używane do uwierzytelniania, przekazywanie dostępu w całej domenie pełni rolę użytkownika i dlatego jest uznawane za uwierzytelnianie użytkownika. W przypadku każdej funkcji, która wymaga uwierzytelniania użytkownika, możesz używać przekazywania dostępu w całej domenie.
Uwierzytelnianie i autoryzacja przy użyciu uprawnień administratora
Jeśli jesteś administratorem domeny lub administratorem delegowanym z uprawnieniami administratora, możesz uwierzytelniać i autoryzować wywołania interfejsu Google Chat API z uprawnieniami administratora, ustawiając pole use_admin_access
w żądaniach odpowiednich metod. Więcej informacji znajdziesz w dokumentacji API.
Pamiętaj, że gdy aplikacja Google Chat wykona działanie z uprawnieniami administratora, Google Chat nie będzie podawać użytkownikom nazwy aplikacji do obsługi czatu, która je wykonała, ani nazwy administratora, który ją autoryzował. Informować użytkowników tylko o tym, że czynność została wykonana przez administratora organizacji.
Wymagania wstępne
Aby uruchomić przykład w tym przewodniku, musisz spełnić te wymagania wstępne:
- Konto Google Workspace z dostępem do Google Chat.
- Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Chat API. Informacje o tym, jak utworzyć projekt i włączyć interfejs API, znajdziesz w artykule Tworzenie projektu i włączanie interfejsu API.
- aplikację do obsługi czatu skonfigurowaną na stronie konfiguracji Chat API w konsoli Google Cloud; Aby utworzyć i skonfigurować aplikację Google Chat, zapoznaj się z artykułem o tworzeniu aplikacji Google Chat za pomocą Cloud Functions.
Dodatkowo musisz spełnić te wymagania wstępne w zależności od języka:
Java
- JDK 1.7 lub nowsza
- Narzędzie do zarządzania pakietami Maven
Zainicjowany projekt Maven. Aby zainicjować nowy projekt, uruchom to polecenie w interfejsie wiersza poleceń:
mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false
Python
- Python w wersji 3.6 lub nowszej
- Narzędzie do zarządzania pakietami pip
Node.js
Google Apps Script
- Projekt Apps Script połączony z projektem Google Cloud. Aby zainicjować projekt Apps Script, zobacz krótkie wprowadzenie do aplikacji Google Apps Script Chat.
Krok 1. Skonfiguruj ekran zgody OAuth, określ zakresy i zarejestruj aplikację
Gdy do autoryzacji używasz protokołu OAuth 2.0, Google wyświetla użytkownikowi ekran zgody zawierający podsumowanie projektu, jego zasad i żądanych zakresów autoryzacji. Skonfigurowanie ekranu zgody OAuth aplikacji określa, co Google wyświetla użytkownikom i osobom sprawdzającym, oraz rejestruje aplikację, aby można było ją później opublikować.
Wszystkie aplikacje korzystające z protokołu OAuth 2.0 wymagają konfiguracji ekranu zgody, ale wystarczy wyświetlić zakresy dla aplikacji używanych przez osoby spoza organizacji Google Workspace.
W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Ekran zgody OAuth.
Wybierz typ użytkownika aplikacji, a następnie kliknij Utwórz.
Wypełnij formularz rejestracji aplikacji, a potem kliknij Zapisz i kontynuuj.
Kliknij Dodaj lub usuń zakresy. Dodaj i zweryfikuj zakresy autoryzacji wymagane przez aplikację, kliknij Aktualizuj, a następnie Zapisz i kontynuuj.
Przejrzyj podsumowanie rejestracji aplikacji. Kliknij Edytuj, by wprowadzić zmiany, lub Powrót do panelu.
Krok 2. Utwórz w konsoli Google Cloud dane logowania na identyfikator klienta OAuth
Aby uwierzytelnić się jako użytkownik i uzyskać dostęp do jego danych w aplikacji, musisz utworzyć co najmniej 1 identyfikator klienta OAuth 2.0. Identyfikator klienta służy do identyfikowania pojedynczej aplikacji na serwerach OAuth Google. Jeśli Twoja aplikacja działa na wielu platformach, np. na Androidzie, iOS i w przeglądarce, musisz utworzyć oddzielny identyfikator klienta dla każdej z nich.
Utwórz dane uwierzytelniające identyfikatora klienta OAuth
Wybierz typ aplikacji, aby uzyskać szczegółowe instrukcje tworzenia identyfikatora klienta OAuth:
Aplikacja internetowa
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Aplikacja internetowa.
- W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- Dodaj autoryzowane identyfikatory URI powiązane z aplikacją:
- Aplikacje po stronie klienta (JavaScript) – w sekcji Autoryzowane źródła JavaScript kliknij Dodaj identyfikator URI. Następnie wpisz identyfikator URI, którego chcesz używać w przypadku żądań przeglądarki. Identyfikuje domeny, z których aplikacja może wysyłać żądania interfejsu API do serwera OAuth 2.0.
- Aplikacje po stronie serwera (Java, Python i inne) – w sekcji Autoryzowane identyfikatory URI przekierowania kliknij Dodaj identyfikator URI. Następnie wpisz identyfikator URI punktu końcowego, do którego serwer OAuth 2.0 może wysyłać odpowiedzi.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
Zapisz identyfikator klienta. Tajne klucze klienta nie są używane w aplikacjach internetowych.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.
Android
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Android.
- W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- W polu „Nazwa pakietu” wpisz nazwę pakietu z pliku
AndroidManifest.xml
. - W polu „Odcisk cyfrowy certyfikatu SHA-1” wpisz wygenerowany odcisk cyfrowy certyfikatu SHA-1.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.
iOS
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > iOS.
- W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- W polu „Identyfikator pakietu” wpisz identyfikator pakietu podany w pliku
Info.plist
aplikacji. - Opcjonalnie: jeśli Twoja aplikacja jest dostępna w Apple App Store, wpisz identyfikator App Store.
- Opcjonalnie: w polu „Identyfikator zespołu” wpisz unikalny 10-znakowy ciąg wygenerowany przez Apple i przypisany do Twojego zespołu.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.
Aplikacja Chrome
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Aplikacja Chrome.
- W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- W polu „Identyfikator aplikacji” wpisz unikalny 32-znakowy identyfikator aplikacji. Wartość tego identyfikatora znajdziesz w adresie URL aplikacji w Chrome Web Store oraz w panelu dewelopera Chrome Web Store.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.
Aplikacja komputerowa
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Aplikacja komputerowa.
- W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.
Telewizory i ograniczone urządzenia wejściowe
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Telewizory i ograniczone urządzenia wejściowe.
- W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.
Universal Windows Platform (UWP)
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Platforma uniwersalna Windows (UWP).
- W polu „Nazwa” wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- W polu „Identyfikator sklepu” wpisz niepowtarzalną, 12-znakową wartość identyfikatora Microsoft Store dla swojej aplikacji. Znajdziesz go w adresie URL Twojej aplikacji w Microsoft Store oraz w Centrum Partnerów.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klienta OAuth 2.0”.
Pobierz plik JSON z tajnym kluczem klienta
Plik z tajnymi kluczami klienta to reprezentacja w formacie JSON danych logowania identyfikatora klienta OAuth, do których aplikacja Google Chat może się odwoływać podczas podawania danych logowania.
W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
W sekcji Identyfikatory klienta OAuth 2.0 kliknij utworzony identyfikator klienta.
Kliknij Pobierz JSON.
Zapisz plik jako
client_secrets.json
.
Krok 3. Zainstaluj bibliotekę klienta Google i inne zależności
Zainstaluj bibliotekę klienta Google i inne zależności wymagane przez projekt.
Java
Aby dodać do projektu Maven biblioteki klienta Google i inne wymagane zależności, zmodyfikuj plik pom.xml
w katalogu projektu i dodaj te zależności:
<dependencies>
<!-- ... existing dependencies ... -->
<dependency>
<groupId>com.google.apis</groupId>
<artifactId>google-api-services-chat</artifactId>
<version>v1-rev20230905-2.0.0</version>
</dependency>
<dependency>
<groupId>com.google.auth</groupId>
<artifactId>google-auth-library-oauth2-http</artifactId>
<version>1.19.0</version>
</dependency>
<dependency>
<groupId>com.google.oauth-client</groupId>
<artifactId>google-oauth-client-jetty</artifactId>
<version>1.34.1</version>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.10.1</version>
</dependency>
</dependencies>
Python
Jeśli nie masz jeszcze zainstalowanych bibliotek klienta Google dla języka Python, uruchom to polecenie w interfejsie wiersza poleceń:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
Node.js
Aby dodać do projektu Node.js biblioteki klienta Google i inne wymagane zależności, przejdź do katalogu projektu i uruchom to polecenie w interfejsie wiersza poleceń:
npm install "@googleapis/chat" open server-destroy
Google Apps Script
W tym przykładzie użyto zaawansowanej usługi Google Chat do wywołania interfejsu Google Chat API. Aby włączyć usługę w projekcie Apps Script:
- Po lewej stronie kliknij Edytor .
- Po lewej stronie obok opcji Usługi kliknij Dodaj usługę .
- Wybierz Google Chat API.
- W sekcji Wersja wybierz v1.
- Kliknij Dodaj.
Możesz używać dowolnego języka obsługiwanego przez nasze biblioteki klienta.
Krok 4. Napisz skrypt, który wywołuje interfejs Chat API
Wywoływanie interfejsu API z autoryzacją OAuth jest procesem wieloetapowym. W aplikacjach internetowych i komputerowych proces ten wygląda zwykle tak:
- Aplikacja kieruje użytkownika na stronę autoryzacji, która prosi o dostęp do danych użytkownika określonych przez zakresy autoryzacji. Aplikacja identyfikuje się za pomocą danych logowania z identyfikatorem klienta.
- Użytkownik sprawdza uprawnienia, o które prosi aplikacja i zatwierdza prośbę.
- Serwer uwierzytelniania Google przekierowuje przeglądarkę do punktu końcowego HTTP aplikacji razem z kodem autoryzacji.
- Aplikacja wysyła kolejne żądanie do serwera autoryzacji Google, aby wymienić kod autoryzacji na token dostępu.
- Aplikacja używa tokena dostępu do wywoływania interfejsu API w imieniu użytkownika.
Więcej informacji o procesie autoryzacji OAuth znajdziesz w artykule Korzystanie z protokołu OAuth 2.0 w celu uzyskania dostępu do przewodnika po interfejsach API Google.
Umieszczone poniżej przykładowe fragmenty kodu w Javie, Pythonie i Node.js wykorzystują bibliotekę klienta do wykonania procesu autoryzacji OAuth. Otwiera lokalny serwer HTTP, gdzie odbiera z powrotem kod autoryzacji, który następnie wymienia się tokenem dostępu. W przykładowym kodzie Apps Script ten proces autoryzacji jest obsługiwany przez Apps Script.
Po zakończeniu procesu uwierzytelniania skrypt uwierzytelnia się w interfejsie Chat API przy użyciu tokena dostępu użytkownika, a następnie tworzy pokój.
Java
- Otwórz plik
src/main/java/com/google/chat/app/authsample/App.java
w katalogu projektu. Zastąp zawartość pola
App.java
tym kodem:package com.google.chat.app.authsample; 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.chat.v1.HangoutsChat; import com.google.api.services.chat.v1.model.Space; import java.io.InputStreamReader; import java.util.Collection; import java.util.Collections; /** * Authenticates with Chat API via user credentials, then creates a Chat space. */ public class App { // Application OAuth credentials. private static final String KEYS_RESOURCE_URI = "/client_secrets.json"; // Define your app's authorization scopes. private static final Collection<String> SCOPES = Collections.singleton("https://www.googleapis.com/auth/chat.spaces.create"); // Directory to store user credentials. private static final java.io.File DATA_STORE_DIR = new java.io.File(System.getProperty("user.home"), ".store/auth-sample-app"); // Global instance of the JSON factory. private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance(); // Global instance of the HTTP transport. private static HttpTransport httpTransport; // Global instance of the DataStoreFactory. The best practice is to make it a single // globally shared instance across your application. private static FileDataStoreFactory dataStoreFactory; public static void main( String[] args ) { try { // Run app. httpTransport = GoogleNetHttpTransport.newTrustedTransport(); dataStoreFactory = new FileDataStoreFactory(DATA_STORE_DIR); Credential userCredential = authorize(); Space response = App.createChatSpace(userCredential); // Print details about the created space. System.out.println(response); } catch (Exception e) { e.printStackTrace(); } } /** * Authorizes the installed application to access user's protected data. */ private static Credential authorize() throws Exception { // Load client secrets. GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(App.class.getResourceAsStream("/client_secrets.json"))); // Set up authorization code flow. GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder( httpTransport, JSON_FACTORY, clientSecrets, SCOPES) .setDataStoreFactory(dataStoreFactory) .build(); // Authorize. return new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user"); } /** * Creates a Chat space. */ private static Space createChatSpace(Credential userCredential) throws Exception { // Build the Chat API client and authenticate with the user account. HangoutsChat chatService = new HangoutsChat.Builder( httpTransport, JSON_FACTORY, userCredential) .setApplicationName("auth-sample-app") .build(); // Create a Chat space. Space space = new Space() // To create a named space, set spaceType to SPACE. .setSpaceType("SPACE") // The user-visible name of the space. .setDisplayName("API-made"); return chatService.spaces().create(space).execute(); } }
Utwórz nowy podkatalog o nazwie
resources
w katalogu projektu.Skopiuj plik
client_secrets.json
do podkataloguresources
.Aby skonfigurować narzędzie Maven do uwzględnienia pliku z tajnymi kluczami klienta w pakiecie projektu, edytuj plik
pom.xml
w katalogu projektu i dodaj tę konfigurację w sekcji<build>
:<build> <!-- ... existing configurations ... --> <resources> <resource> <directory>resources</directory> </resource> </resources> </build>
Aby skonfigurować narzędzie Maven tak, aby uwzględniało zależności w pakiecie projektu i uruchamiało klasę główną aplikacji, edytuj plik
pom.xml
w katalogu projektu i dodaj tę konfigurację w sekcji<plugins>
:<plugins> <!-- ... existing configurations ... --> <plugin> <artifactId>maven-assembly-plugin</artifactId> <configuration> <archive> <manifest> <mainClass>com.google.chat.app.authsample.App</mainClass> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> </plugin> </plugins>
Python
Zapisz ten kod w pliku o nazwie
chat_space_create_named.py
, który znajduje się w tym samym katalogu, w którym znajduje się plikclient_secrets.json
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.spaces.create"] def main(): ''' Authenticates with Chat API via user credentials, then creates a Chat space. ''' flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. service = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = service.spaces().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
Node.js
Zapisz ten kod w pliku o nazwie
chat_space_create_named.js
w tym samym katalogu, w którym znajduje się projekt Node.js iclient_secrets.json
:const fs = require('fs'); const path = require('path'); const http = require('http'); const url = require('url'); const destroyer = require('server-destroy'); const chat = require('@googleapis/chat'); // Application OAuth credentials. const keys = require('./client_secrets.json').installed; // Define your app's authorization scopes. // When modifying these scopes, delete the file token.json, if it exists. const scopes = ["https://www.googleapis.com/auth/chat.spaces.create"]; // Create a new OAuth2 client with the configured keys. const oauth2Client = new chat.auth.OAuth2( keys.client_id, keys.client_secret, 'http://localhost:3000' ); /** * Opens an HTTP server to accept the OAuth callback. * In this simple example, the only request to our webserver is to /?code=<code>. */ async function authenticate(scopes) { const opn = (await import('open')).default; return new Promise((resolve, reject) => { // Generate the URL for authorization. const authorizeUrl = oauth2Client.generateAuthUrl({ access_type: 'offline', scope: scopes.join(' '), }); // Start the HTTP server to listen for the callback. const server = http .createServer(async (req, res) => { try { const qs = new url.URL(req.url, 'http://localhost:3000').searchParams; res.end('Authentication successful! Please return to the console.'); server.destroy(); const { tokens } = await oauth2Client.getToken(qs.get('code')); oauth2Client.credentials = tokens; resolve(oauth2Client); } catch (e) { reject(e); } }) .listen(3000, () => { // Open the browser to the authorize URL to start the workflow. opn(authorizeUrl, { wait: false }).then(cp => cp.unref()); }); destroyer(server); }); } /** * Authenticates with Chat API via user credentials, then creates a Chat space. */ async function createSpace() { // Create the Chat API client and authenticate with the authorized user. const chatClient = await chat.chat({ version: 'v1', auth: oauth2Client }); // Call the Chat API to create a space. const result = await chatClient.spaces.create({ // Details about the space to create. requestBody: { // To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', // The user-visible name of the space. 'displayName': 'API-made' } }); return result; } // Authenticate the user, execute the function, // then print details about the created space. authenticate(scopes) .then(createSpace) .then(console.log);
Google Apps Script
W edytorze Apps Script zmodyfikuj plik
appsscript.json
i dodaj zakres OAuth niezbędny do wywołania interfejsu API:"oauthScopes": [ "https://www.googleapis.com/auth/chat.spaces.create" ]
Zapisz ten kod w pliku o nazwie
ChatSpaceCreateNamed.gs
w projekcie Apps Script:/** * Authenticates with Chat API via user credentials, then creates a * Chat space. */ function createSpace() { try { // Details about the space to create. // To create a named space, set spaceType to SPACE. // The user-visible name of the space is displayName. const space = {'displayName': 'API-made', 'spaceType': 'SPACE'}; // Call Chat API with user credentials to create the space. const result = Chat.Spaces.create(space); // Log details about the created space. console.log(result); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create space with error %s', err.message); } }
Krok 5. Uruchom przykładowy skrypt
Aby uruchomić przykład, w wierszu poleceń przejdź do katalogu, w którym znajdują się pliki projektu, a potem wykonaj to polecenie:
Java
mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar
Python
python3 chat_space_create_named.py
Node.js
node chat_space_create_named.js
Google Apps Script
Otwórz plik ChatSpaceCreateNamed.gs
w edytorze Apps Script i kliknij Uruchom.
Otworzy się przeglądarka i poprosi o zalogowanie się na konto Google:
Po zalogowaniu się pojawi się ekran zgody OAuth z prośbą o przyznanie aplikacji uprawnień.
Po przyznaniu uprawnień skrypt wywołuje interfejs Chat API, który odpowiada, tworząc pokój czatu o wyświetlanej nazwie API-made
. Konsola wyświetli szczegóły wywołania interfejsu API. Aby znaleźć pokój, otwórz panel Pokoje w Google Chat.
Rozwiązywanie problemów z przykładem
Podczas uruchamiania kodu chat_space_create_named.py
może pojawić się błąd o następującej treści:
Expected a JSON object with a single property for a "web" or "installed" application
Ten komunikat o błędzie oznacza, że plik client_secrets.json
pobrany z konsoli Google Cloud nie zaczyna się od właściwości "web"
lub "installed"
. Jeśli po uwierzytelnieniu w pobranym pliku token dostępu nie zapisze go w nowym pliku, takim jak token.json
, token dostępu zostanie zapisany w client_secrets.json
, co może powodować ten błąd przy kolejnych próbach autoryzacji.
Aby naprawić ten błąd, jeszcze raz pobierz z konsoli Google Cloud plik z tajnym kluczem klienta i zapisz nowy plik w miejscu bieżącego.
Powiązane artykuły
Jeśli aplikacja musi nadal używać tokenów użytkowników poza zakresem pojedynczego procesu, może przechowywać te tokeny, aby wykorzystać je później. W takim przypadku aplikacja musi bezpiecznie obsługiwać tokeny użytkowników oraz obsługiwać unieważnianie i wygaśnięcie tokena odświeżania. Więcej informacji znajdziesz w przewodniku po sprawdzonych metodach korzystania z OAuth 2.0.
Aby dowiedzieć się, co jeszcze może robić Chat API, zapoznaj się z dokumentacją interfejsu Chat API.