Layanan Chat Lanjutan

Layanan Chat Lanjutan memungkinkan Anda menggunakan Google Chat API di Google Apps Script. API ini memungkinkan skrip menemukan, membuat, dan mengubah ruang Chat, menambahkan atau menghapus anggota dari ruang, serta membaca atau memposting pesan dengan teks, kartu, lampiran, dan reaksi.

Prasyarat

Ini adalah layanan lanjutan yang harus Anda aktifkan sebelum digunakan.

Referensi

Untuk mengetahui informasi selengkapnya tentang layanan ini, lihat dokumentasi referensi Chat API. Seperti semua layanan lanjutan di Apps Script, layanan Chat menggunakan objek, metode, dan parameter yang sama dengan API publik.

Kode contoh

Contoh ini menunjukkan cara melakukan tindakan umum Google Chat API menggunakan layanan lanjutan.

Memposting pesan dengan kredensial pengguna

Contoh berikut menunjukkan cara memposting pesan ke ruang Chat atas nama pengguna.

  1. Tambahkan cakupan otorisasi chat.messages.create ke file appsscript.json project Apps Script:

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

  2. Tambahkan fungsi seperti ini ke kode project Apps Script:

    advanced/chat.gs
    /**
 * Posts a new message to the specified space on behalf of the user.
 * @param {string} spaceName The resource name of the space.
 */
function postMessageWithUserCredentials(spaceName) {
  try {
    const message = { text: "Hello world!" };
    Chat.Spaces.Messages.create(message, spaceName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to create message with error %s", err.message);
  }
}

Memposting pesan dengan kredensial aplikasi

Contoh berikut menunjukkan cara memposting pesan ke ruang Chat atas nama aplikasi. Menggunakan layanan Chat lanjutan dengan akun layanan tidak mengharuskan Anda menentukan cakupan otorisasi di appsscript.json. Untuk mengetahui detail tentang autentikasi dengan akun layanan, lihat Melakukan autentikasi sebagai aplikasi Google Chat.

advanced/chat.gs
/**
 * Posts a new message to the specified space on behalf of the app.
 * @param {string} spaceName The resource name of the space.
 */
function postMessageWithAppCredentials(spaceName) {
  try {
    // See https://developers.google.com/chat/api/guides/auth/service-accounts
    // for details on how to obtain a service account OAuth token.
    const appToken = getToken_();
    const message = { text: "Hello world!" };
    Chat.Spaces.Messages.create(
      message,
      spaceName,
      {},
      // Authenticate with the service account token.
      { Authorization: `Bearer ${appToken}` },
    );
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to create message with error %s", err.message);
  }
}

Mendapatkan ruang

Contoh berikut menunjukkan cara mendapatkan informasi tentang ruang Chat.

  1. Tambahkan cakupan otorisasi chat.spaces.readonly ke file appsscript.json project Apps Script:

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

  2. Tambahkan fungsi seperti ini ke kode project Apps Script:

    advanced/chat.gs
    /**
 * Gets information about a Chat space.
 * @param {string} spaceName The resource name of the space.
 */
function getSpace(spaceName) {
  try {
    const space = Chat.Spaces.get(spaceName);
    console.log("Space display name: %s", space.displayName);
    console.log("Space type: %s", space.spaceType);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to get space with error %s", err.message);
  }
}

Membuat ruang

Contoh berikut menunjukkan cara membuat ruang Chat.

  1. Tambahkan cakupan otorisasi chat.spaces.create ke file appsscript.json project Apps Script:

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

  2. Tambahkan fungsi seperti ini ke kode project Apps Script:

    advanced/chat.gs
    /**
 * Creates a new Chat space.
 */
function createSpace() {
  try {
    const space = { displayName: "New Space", spaceType: "SPACE" };
    Chat.Spaces.create(space);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to create space with error %s", err.message);
  }
}

Mencantumkan keanggotaan

Contoh berikut menunjukkan cara mencantumkan semua anggota ruang Chat.

  1. Tambahkan cakupan otorisasi chat.memberships.readonly ke file appsscript.json project Apps Script:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.memberships.readonly"
]

  2. Tambahkan fungsi seperti ini ke kode project Apps Script:

    advanced/chat.gs
    /**
 * Lists all the members of a Chat space.
 * @param {string} spaceName The resource name of the space.
 */
function listMemberships(spaceName) {
  let response;
  let pageToken = null;
  try {
    do {
      response = Chat.Spaces.Members.list(spaceName, {
        pageSize: 10,
        pageToken: pageToken,
      });
      if (!response.memberships || response.memberships.length === 0) {
        pageToken = response.nextPageToken;
        continue;
      }
      for (const membership of response.memberships) {
        console.log(
          "Member: %s, Role: %s",
          membership.member.displayName,
          membership.role,
        );
      }
      pageToken = response.nextPageToken;
    } while (pageToken);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
}

Memecahkan masalah

Jika Anda mengalami Error 400: invalid_scope dengan pesan error Some requested scopes cannot be shown, berarti Anda belum menentukan cakupan otorisasi apa pun di file appsscript.json project Apps Script. Pada umumnya, Apps Script otomatis menentukan cakupan yang diperlukan skrip, tetapi saat menggunakan layanan Chat lanjutan, Anda harus menambahkan cakupan otorisasi yang digunakan skrip secara manual ke file manifes project Apps Script. Lihat Menetapkan cakupan eksplisit.

Untuk mengatasi error, tambahkan cakupan otorisasi yang sesuai ke file appsscript.json project Apps Script sebagai bagian dari array oauthScopes. Misalnya, untuk memanggil spaces.messages.create metode, tambahkan hal berikut:

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

Batas dan pertimbangan

Layanan Chat Lanjutan tidak mendukung:

Untuk mendownload lampiran pesan atau memanggil metode pratinjau developer, gunakan UrlFetchApp sebagai gantinya.