Mengautentikasi dan memberikan otorisasi sebagai pengguna Google Chat

Panduan ini menjelaskan cara menggunakan OAuth 2.0 dengan kredensial Google pengguna untuk mengakses Chat API. Mengautentikasi dan memberikan otorisasi dengan kredensial pengguna memungkinkan aplikasi Chat mengakses data pengguna dan melakukan operasi atas nama pengguna yang diautentikasi. Dengan melakukan autentikasi atas nama pengguna, aplikasi memiliki izin yang sama dengan pengguna tersebut dan dapat melakukan tindakan seolah-olah dilakukan oleh pengguna tersebut.

Setelah mengautentikasi dan memberikan otorisasi panggilan API dengan kredensial pengguna, aplikasi Chat dapat melakukan hal berikut:

  • Membuat ruang Chat.
  • Menambahkan pengguna ke ruang Chat dan percakapan grup.
  • Menggunakan data pengguna di API Workspace lainnya seperti berikut:

Saat aplikasi melakukan tindakan dengan autentikasi pengguna (seperti membuat ruang), Google Chat akan menampilkan pesan atribusi yang memberi tahu pengguna nama aplikasi yang melakukan tindakan untuk pengguna yang memberikan otorisasi.

Aplikasi Google Chat membuat ruang untuk pengguna.
Gambar 1. Pesan atribusi yang ditampilkan Google Chat saat aplikasi Chat membuat ruang atas nama pengguna.

Untuk mempelajari lebih lanjut kapan aplikasi Chat memerlukan autentikasi dan jenis autentikasi yang akan digunakan, lihat Jenis autentikasi yang diperlukan dalam ringkasan autentikasi dan otorisasi Chat API.

Mengautentikasi dan memberi otorisasi sebagai administrator Google Workspace

Bagian ini menjelaskan cara administrator ruang kerja Google Workspace mengelola aplikasi dan ruang Google Chat di seluruh organisasi mereka dengan autentikasi pengguna.

Mengautentikasi dan memberikan otorisasi menggunakan delegasi tingkat domain

Jika Anda adalah administrator domain, Anda dapat memberikan delegasi tingkat domain untuk mengizinkan akun layanan aplikasi mengakses data pengguna tanpa mewajibkan setiap pengguna memberikan izin. Setelah Anda mengonfigurasi delegasi tingkat domain, akun layanan dapat meniru identitas akun pengguna. Meskipun akun layanan digunakan untuk autentikasi, delegasi tingkat domain meniru identitas pengguna sehingga dianggap sebagai autentikasi pengguna. Setiap fungsi yang memerlukan autentikasi pengguna, Anda dapat menggunakan delegasi di seluruh domain.

Mengautentikasi dan memberikan otorisasi menggunakan hak istimewa administrator

Jika Anda adalah administrator domain atau administrator yang didelegasikan dengan hak istimewa administrator, Anda dapat mengautentikasi dan memberikan otorisasi panggilan ke Google Chat API dengan hak istimewa administrator dengan menetapkan kolom useAdminAccess dalam permintaan metode yang berlaku. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API.

Perhatikan bahwa saat aplikasi Google Chat melakukan tindakan dengan hak istimewa administrator, Chat tidak akan memberi tahu pengguna nama aplikasi Chat yang melakukan tindakan tersebut atau nama administrator yang memberikan otorisasi, tetapi hanya memberi tahu pengguna bahwa tindakan tersebut dilakukan oleh administrator organisasi mereka.

Prasyarat

Java

  • Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
  • Buat project Google Cloud.
  • Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
  • JDK 1.7 atau yang lebih baru
  • Alat pengelolaan paket Maven
  • Project Maven yang diinisialisasi. Untuk melakukan inisialisasi project baru, jalankan perintah berikut di antarmuka command line Anda: 
    mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

Python

Node.js

Apps Script

Langkah 1: Konfigurasikan layar izin OAuth, tentukan cakupan, dan daftarkan aplikasi Anda

Saat Anda menggunakan OAuth 2.0 untuk otorisasi, Google akan menampilkan layar izin kepada pengguna, termasuk ringkasan project Anda, kebijakannya, dan cakupan otorisasi yang diminta. Mengonfigurasi layar izin OAuth aplikasi akan menentukan apa yang ditampilkan Google kepada pengguna dan peninjau aplikasi, serta mendaftarkan aplikasi agar Anda dapat memublikasikannya nanti.

Semua aplikasi yang menggunakan OAuth 2.0 memerlukan konfigurasi layar izin, tetapi Anda hanya perlu mencantumkan cakupan untuk aplikasi yang digunakan oleh orang di luar organisasi Google Workspace Anda.

  1. Di konsol Google Cloud, buka Menu > APIs & Services > OAuth consent screen.

    Buka layar izin OAuth

  2. Pilih jenis pengguna untuk aplikasi Anda, lalu klik Buat.

  3. Isi formulir pendaftaran aplikasi, lalu klik Simpan dan Lanjutkan.

  4. Klik Add or Remove Scopes. Tambahkan dan verifikasi cakupan otorisasi yang diperlukan oleh aplikasi Anda, klik Update, lalu klik Save and Continue.

  5. Tinjau ringkasan pendaftaran aplikasi Anda. Klik Edit untuk melakukan perubahan, atau klik Kembali ke Dasbor.

Langkah 2: Buat kredensial client ID OAuth di konsol Google Cloud

Untuk mengautentikasi sebagai pengguna akhir dan mengakses data pengguna di aplikasi, Anda perlu membuat satu atau beberapa Client ID OAuth 2.0. Client ID digunakan untuk mengidentifikasi satu aplikasi ke server OAuth Google. Jika aplikasi Anda berjalan di beberapa platform—seperti Android, iOS, dan Web—Anda perlu membuat client ID terpisah untuk setiap platform.

Membuat kredensial client ID OAuth

Pilih jenis aplikasi untuk mendapatkan petunjuk spesifik tentang cara membuat client ID OAuth:

Aplikasi web

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Application type > Web application.
  4. Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Tambahkan URI resmi yang terkait dengan aplikasi Anda:
    • Aplikasi sisi klien (JavaScript)–Di bagian Asal JavaScript resmi, klik Tambahkan URI. Kemudian, masukkan URI yang akan digunakan untuk permintaan browser. Ini mengidentifikasi domain tempat aplikasi Anda dapat mengirim permintaan API ke server OAuth 2.0.
    • Aplikasi sisi server (Java, Python, dan lainnya)–Di bagian URI pengalihan yang diberi otorisasi, klik Tambahkan URI. Kemudian, masukkan URI endpoint tempat server OAuth 2.0 dapat mengirim respons.
  6. Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.

    Catat Client ID. Rahasia klien tidak digunakan untuk aplikasi Web.

  7. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian Client ID OAuth 2.0.

Android

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Application type > Android.
  4. Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Di kolom "Package name", masukkan nama paket dari file AndroidManifest.xml Anda.
  6. Di kolom "SHA-1 certificate fingerprint", masukkan sidik jari sertifikat SHA-1 yang dihasilkan.
  7. Klik Buat. Layar klien OAuth yang dibuat akan muncul, yang menampilkan Client ID baru Anda.
  8. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

iOS

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Jenis aplikasi > iOS.
  4. Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Di kolom "ID Paket", masukkan ID paket seperti yang tercantum dalam file Info.plist aplikasi.
  6. Opsional: Jika aplikasi Anda muncul di Apple App Store, masukkan ID App Store.
  7. Opsional: Di kolom "ID Tim", masukkan string unik 10 karakter yang dibuat oleh Apple dan ditetapkan untuk tim Anda.
  8. Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
  9. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Aplikasi Chrome

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Jenis aplikasi > Aplikasi Chrome.
  4. Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Di kolom "ID Aplikasi", masukkan string ID unik 32 karakter aplikasi Anda. Anda dapat menemukan nilai ID ini di URL Chrome Web Store aplikasi dan di Dasbor Developer Chrome Web Store.
  6. Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
  7. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Aplikasi desktop

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Jenis aplikasi > Aplikasi desktop.
  4. Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
  6. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian Client ID OAuth 2.0.

TV & Perangkat Input Terbatas

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Jenis aplikasi > TV & Perangkat Input Terbatas.
  4. Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
  6. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Universal Windows Platform (UWP)

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create Credentials > OAuth client ID.
  3. Klik Jenis aplikasi > Universal Windows Platform (UWP).
  4. Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
  5. Di kolom "ID Toko", masukkan nilai ID Microsoft Store unik 12 karakter aplikasi Anda. Anda dapat menemukan ID ini di URL Microsoft Store aplikasi Anda dan di Partner Center.
  6. Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
  7. Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Mendownload file JSON secret klien

File secret klien adalah representasi JSON kredensial ID klien OAuth yang dapat dirujuk oleh aplikasi Chat Anda saat menyediakan kredensial.

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Di bagian Client ID OAuth 2.0, klik client ID yang Anda buat.

  3. Klik Download JSON.

  4. Simpan file sebagai client_secrets.json.

Langkah 3: Instal library klien Google dan dependensi lainnya

Instal library klien Google dan dependensi lain yang diperlukan untuk project.

Java

Untuk menambahkan library klien Google dan dependensi lain yang diperlukan ke project Maven, edit file pom.xml di direktori project dan tambahkan dependensi berikut:

<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

Jika Anda belum menginstal library klien Google untuk Python, jalankan perintah berikut di antarmuka command line:

pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

Untuk menambahkan library klien Google dan dependensi lain yang diperlukan ke project Node.js, beralihlah ke direktori project dan jalankan perintah berikut di antarmuka command line:

npm install "@googleapis/chat" open server-destroy

Apps Script

Contoh ini menggunakan layanan Chat Lanjutan untuk memanggil Google Chat API. Untuk mengaktifkan layanan untuk project Apps Script Anda:

  1. Di sebelah kiri, klik Editor .
  2. Di sebelah kiri, di samping Layanan, klik Tambahkan layanan .
  3. Pilih Google Chat API.
  4. Di Versi, pilih v1.
  5. Klik Tambahkan.

Anda dapat menggunakan bahasa apa pun yang didukung oleh library klien kami.

Langkah 4: Tulis skrip yang memanggil Chat API

Memanggil API dengan otorisasi OAuth adalah proses multilangkah. Dalam aplikasi web atau desktop, prosesnya biasanya sebagai berikut:

  1. Aplikasi mengarahkan pengguna ke halaman otorisasi yang meminta akses ke data pengguna yang ditentukan oleh cakupan otorisasi. Aplikasi mengidentifikasi dirinya dengan kredensial client ID.
  2. Pengguna meninjau izin yang diminta oleh aplikasi dan menyetujui permintaan tersebut.
  3. Server autentikasi Google mengalihkan browser ke endpoint HTTP aplikasi beserta kode otorisasi.
  4. Aplikasi mengirimkan permintaan lain ke server otorisasi Google untuk menukar kode otorisasi dengan token akses.
  5. Aplikasi menggunakan token akses untuk memanggil API atas nama pengguna.

Untuk mempelajari proses otorisasi OAuth lebih lanjut, lihat Panduan Menggunakan OAuth 2.0 untuk Mengakses Google API.

Contoh kode berikut di Java, Python, dan Node.js menggunakan library klien untuk menjalankan alur otorisasi OAuth. Tindakan ini akan membuka server HTTP lokal untuk menerima kembali kode otorisasi dari server otorisasi, yang kemudian ditukar dengan token akses. Dalam contoh kode Apps Script, alur otorisasi ini ditangani oleh Apps Script.

Setelah menyelesaikan alur autentikasi, skrip akan melakukan autentikasi dengan Chat API menggunakan token akses pengguna, lalu membuat ruang.

Java

  1. Di direktori project, buka file src/main/java/com/google/chat/app/authsample/App.java.

  2. Ganti konten di App.java dengan kode berikut:

    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();
    }
}

  3. Buat subdirektori baru bernama resources dalam direktori project Anda.

  4. Salin file client_secrets.json ke subdirektori resources.

  5. Untuk mengonfigurasi Maven agar menyertakan file secret klien dalam paket project, edit file pom.xml di direktori project Anda dan tambahkan konfigurasi berikut ke bagian <build>:

    <build>
  <!-- ... existing configurations ... -->
  <resources>
    <resource>
      <directory>resources</directory>
    </resource>
  </resources>
</build>

  6. Untuk mengonfigurasi Maven agar menyertakan dependensi dalam paket project dan menjalankan class utama aplikasi, edit file pom.xml di direktori project dan tambahkan konfigurasi berikut ke bagian <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

  1. Simpan kode berikut dalam file bernama chat_space_create_named.py di direktori yang sama dengan yang menyimpan client_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

  1. Simpan kode berikut dalam file bernama chat_space_create_named.js di direktori yang sama dengan yang menyimpan project Node.js dan client_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);

Apps Script

  1. Di editor Apps Script, edit file appsscript.json dan tambahkan cakupan OAuth yang diperlukan untuk memanggil API:

      "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.create"
  ]

  2. Simpan kode berikut dalam file bernama ChatSpaceCreateNamed.gs di project Apps Script Anda:

    /**
 * 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);
  }
}

Langkah 5: Jalankan skrip contoh

Untuk menjalankan contoh, dari command line, buka direktori yang menyimpan file project Anda, lalu jalankan perintah berikut:

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

Apps Script

Buka file ChatSpaceCreateNamed.gs di Editor Apps Script, lalu klik Run.

Browser akan terbuka dan meminta Anda untuk login ke Akun Google Anda:

Login untuk memberikan otorisasi ke aplikasi Chat.

Gambar 2. Layar izin OAuth tempat Anda memilih akun yang akan mengautentikasi aplikasi.

Setelah Anda login, layar izin OAuth akan muncul dan meminta Anda memberikan izin ke aplikasi.

Setelah Anda memberikan izin, skrip akan memanggil Chat API, yang merespons dengan membuat ruang Chat dengan nama tampilan API-made. Konsol akan mencetak detail panggilan API. Untuk menemukan ruang, buka panel Ruang di Google Chat.

Memecahkan masalah contoh

Saat menjalankan chat_space_create_named.py, Anda mungkin menerima error yang bertuliskan:

Expected a JSON object with a single property for a "web" or "installed" application

Pesan error ini berarti file client_secrets.json yang Anda download dari konsol Google Cloud tidak dimulai dengan properti "web" atau "installed". Setelah melakukan autentikasi dengan file yang didownload, jika kode Anda tidak menyimpan token akses dalam file baru seperti token.json, token akses akan ditulis ke client_secrets.json, yang dapat menyebabkan error ini selama upaya otorisasi berikutnya.

Untuk mengatasi error ini, download file secret klien dari konsol Google Cloud lagi, lalu simpan file baru di tempat file saat ini.

  • Jika aplikasi Anda perlu terus menggunakan token pengguna di luar cakupan satu alur, aplikasi dapat menyimpan token untuk digunakan kembali nanti. Dalam hal ini, aplikasi Anda harus menangani token pengguna dengan aman dan menangani pencabutan dan masa berlaku token refresh. Untuk informasi selengkapnya, lihat Panduan Praktik Terbaik Penggunaan OAuth 2.0.

  • Pelajari fungsi lain Chat API dengan meninjau dokumentasi referensi Chat API.