Membuat ruang Google Chat dan menambahkan anggota

Panduan ini menjelaskan cara menggunakan metode setUp() pada resource Space Google Chat API untuk membuat ruang Chat, dan menambahkan anggota ke ruang tersebut.

Resource Space merepresentasikan tempat di mana orang dan aplikasi Chat dapat mengirim pesan, berbagi file, dan berkolaborasi. Ada beberapa jenis ruang:

• Pesan langsung (DM) adalah percakapan antara dua pengguna atau pengguna dan aplikasi Chat.
• Chat grup adalah percakapan antara tiga pengguna atau lebih dan aplikasi Chat.
• Ruang bernama adalah tempat berkelanjutan tempat orang mengirim pesan, berbagi file, dan berkolaborasi.

Anda dapat menggunakan metode setUp() untuk melakukan salah satu hal berikut:

• Buat ruang bernama dengan anggota awal.
• Buat pesan langsung (DM) antara dua orang.
• Menyiapkan pesan grup di antara beberapa orang.

Saat menyiapkan ruang, pertimbangkan hal berikut:

• Pengguna yang melakukan panggilan (terautentikasi) akan otomatis ditambahkan ke ruang, sehingga Anda tidak perlu menentukan keanggotaan pengguna dalam permintaan.
• Saat membuat pesan langsung (DM), jika ada DM antara dua pengguna, maka DM tersebut akan ditampilkan. Jika tidak, DM akan dibuat.
• Saat membuat chat grup, jika tidak ada keanggotaan yang diberikan dalam permintaan yang berhasil ditambahkan ke chat grup (misalnya, masalah izin), maka chat grup kosong (hanya menyertakan pengguna yang memanggil) dapat dibuat.
• Anda tidak dapat menyiapkan ruang dengan balasan berangkai atau menambahkan orang di luar organisasi Google Workspace Anda.
• Keanggotaan duplikat (termasuk pengguna yang memanggil) yang diberikan dalam permintaan akan difilter, bukan menyebabkan error permintaan.
• Saat administrator Google Workspace menginstal aplikasi Chat untuk seluruh organisasi Google Workspace, Google Chat akan membuat DM antara aplikasi Chat yang diinstal dan setiap pengguna di organisasi, sehingga tidak perlu menyiapkan DM secara terprogram. Sebagai gantinya, list spaces untuk menampilkan semua DM atau find a direct message untuk mendapatkan detail tentang DM tertentu.

Prasyarat

Menyiapkan ruang

Untuk menyiapkan ruang, teruskan hal berikut dalam permintaan Anda:

• Tentukan cakupan otorisasi chat.spaces.create atau chat.spaces.
• Panggil metode SetUpSpace().
• Teruskan space sebagai instance Space dengan semua kolom yang diperlukan seperti displayName atau spaceType.
• Teruskan memberships sebagai array instance Membership. Untuk setiap instance:
  • Tentukan users/{user} untuk menambahkan pengguna manusia sebagai anggota ruang, dengan {user} adalah {person_id} untuk person dari People API, atau ID user di Directory API. Misalnya, jika orang di People API resourceName adalah people/123456789, Anda dapat menambahkan pengguna ke ruang dengan menyertakan keanggotaan dengan users/123456789 sebagai member.name.
  • Tentukan groups/{group} untuk menambahkan grup sebagai anggota ruang, dengan {group} adalah ID grup yang ingin Anda buat keanggotaannya. ID grup dapat diambil menggunakan Cloud Identity API. Misalnya, jika Cloud Identity API menampilkan grup dengan nama groups/123456789, tetapkan membership.groupMember.name ke groups/123456789. Google Grup tidak dapat ditambahkan ke chat grup atau DM, tetapi hanya ke ruang bernama.

Untuk membuat DM antara pengguna yang memanggil dan pengguna manusia lain, tentukan keanggotaan pengguna manusia dalam permintaan Anda.

Untuk membuat DM antara pengguna yang memanggil dan aplikasi yang memanggil, tetapkan space.singleUserBotDm ke true dan jangan tentukan keanggotaan apa pun. Anda hanya dapat menggunakan metode ini untuk menyiapkan DM dengan aplikasi yang melakukan panggilan. Untuk menambahkan aplikasi yang melakukan panggilan sebagai anggota ruang atau DM yang sudah ada antara dua pengguna manusia, lihat membuat keanggotaan.

Contoh berikut membuat ruang bernama dan membuat satu keanggotaan ke ruang untuk dua pengguna manusia (pengguna yang diautentikasi dan satu pengguna lainnya).

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.spaces.create',
];

// This sample shows how to set up a named space with one initial member
// with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    space: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME',
    },
    memberships: [
      {
        member: {
          // Replace USER_NAME here.
          name: 'users/USER_NAME',
          type: 'HUMAN',
        },
      },
    ],
  };

  // Make the request
  const response = await chatClient.setUpSpace(request);

  // Handle the response
  console.log(response);
}

await main();

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

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

def set_up_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.SetUpSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        },
        memberships = [{
            "member": {
                # Replace USER_NAME here.
                "name": 'users/USER_NAME',
                "type_": 'HUMAN'
            }
        }]
    )

    # Make the request
    response = client.set_up_space(request)

    # Handle the response
    print(response)

set_up_space_with_user_cred()

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SetUpSpaceRequest;
import com.google.chat.v1.Space;
import com.google.chat.v1.User;

// This sample shows how to set up a named space with one initial member with
// user credential.
public class SetUpSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces.create";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      SetUpSpaceRequest.Builder request = SetUpSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"))
        .addAllMemberships(ImmutableList.of(Membership.newBuilder()
          .setMember(User.newBuilder()
            // Replace USER_NAME here.
            .setName("users/USER_NAME")
            .setType(User.Type.HUMAN)).build()));
      Space response = chatServiceClient.setUpSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

/**
 * This sample shows how to set up a named space with one initial member with
 * user credential.
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function setUpSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };
  const memberships = [{
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  }];

  // Make the request
  const response = Chat.Spaces.setup({ space: space, memberships: memberships });

  // Handle the response
  console.log(response);
}

Untuk menjalankan contoh, ganti berikut ini:

• DISPLAY_NAME: nama tampilan ruang baru.
• USER_NAME: ID pengguna lain yang akan disertakan keanggotaannya.

Untuk membuka ruang, gunakan ID resource ruang untuk membuat URL ruang. Anda bisa mendapatkan ID resource dari ruang name di isi respons Google Chat. Misalnya, jika name ruang Anda adalah spaces/1234567, Anda dapat membuka ruang menggunakan URL berikut: https://mail.google.com/chat/u/0/#chat/space/1234567.

Topik terkait

• Buat ruang.
• Mendapatkan detail tentang ruang.
• Mencantumkan ruang.
• Memperbarui ruang.
• Menghapus ruang.
• Menemukan ruang pesan langsung.
• Membuat ruang dapat ditemukan oleh pengguna tertentu.