Membuat daftar anggota dalam ruang

Panduan ini menjelaskan cara menggunakan metode list pada resource Membership Google Chat API untuk mencantumkan anggota dalam ruang sebagai daftar keanggotaan yang dapat difilter dan dipaginasi dalam ruang.

Pemilik dan pengelola ruang dapat membatasi siapa yang dapat melihat daftar anggota dalam ruang. Jika visibilitas dibatasi, panggilan ke metode ini yang dilakukan dengan autentikasi aplikasi mungkin menampilkan daftar kosong atau menghilangkan keanggotaan yang tidak terlihat oleh anggota ruang. Panggilan ke metode ini yang dilakukan dengan autentikasi pengguna mungkin menampilkan error PERMISSION_DENIED.

  • Mencantumkan keanggotaan dengan autentikasi aplikasi mencantumkan keanggotaan di ruang yang dapat diakses oleh aplikasi Chat, tetapi mengecualikan keanggotaan aplikasi Chat, termasuk keanggotaannya sendiri.
  • Mencantumkan keanggotaan dengan autentikasi pengguna mencantumkan keanggotaan di ruang yang dapat diakses oleh pengguna yang diautentikasi.
  • Mencantumkan keanggotaan sebagai administrator Google Workspace dengan autentikasi pengguna menggunakan hak istimewa administrator mencantumkan keanggotaan di semua ruang dalam organisasi Google Workspace Anda.

Resource Membership menunjukkan apakah pengguna manusia atau aplikasi Google Chat diundang ke, merupakan bagian dari, atau tidak ada di ruang.

Prasyarat

Node.js

Python

Java

Apps Script

Mencantumkan anggota dalam ruang dengan autentikasi pengguna

Untuk mencantumkan pengguna, Google Grup, dan aplikasi Chat di ruang yang dapat diakses oleh pengguna terautentikasi, teruskan hal berikut dalam permintaan Anda:

  • Dengan autentikasi pengguna, tentukan cakupan otorisasi chat.memberships.readonly atau chat.memberships.
  • Panggil metode ListMemberships.
  • Untuk mencantumkan Google Grup, setel parameter kueri showGroups ke true.

Contoh berikut mencantumkan anggota Google Grup, manusia, dan aplikasi yang terlihat oleh pengguna terautentikasi.

Node.js

chat/client-libraries/cloud/list-memberships-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to list memberships with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
    // ROLE_MANAGER)
    filter: 'member.type = "HUMAN"',
  };

  // Make the request
  const pageResult = chatClient.listMembershipsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

await main();

Python

chat/client-libraries/cloud/list_memberships_user_cred.py
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.memberships.readonly"]

# This sample shows how to list memberships with user credential
def list_memberships_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.ListMembershipsRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
        # ROLE_MANAGER)
        filter = 'member.type = "HUMAN"',
        # Number of results that will be returned at once
        page_size = 100
    )

    # Make the request
    page_result = client.list_memberships(request)

    # Handle the response. Iterating over page_result will yield results and
    # resolve additional pages automatically.
    for response in page_result:
        print(response)

list_memberships_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMembershipsUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMembershipsRequest;
import com.google.chat.v1.ListMembershipsResponse;
import com.google.chat.v1.Membership;

// This sample shows how to list memberships with user credential.
public class ListMembershipsUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      ListMembershipsRequest.Builder request = ListMembershipsRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Filter membership by type (HUMAN or BOT) or role
        // (ROLE_MEMBER or ROLE_MANAGER).
        .setFilter("member.type = \"HUMAN\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

      // Iterating over results and resolve additional pages automatically.
      for (Membership response :
          chatServiceClient.listMemberships(request.build()).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list memberships with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listMembershipsUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = "spaces/SPACE_NAME";
  // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
  // ROLE_MANAGER)
  const filter = 'member.type = "HUMAN"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.Members.list(parent, {
      filter: filter,
      pageSize: 10,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.memberships) {
      for (const membership of responsePage.memberships) {
        console.log(membership);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Untuk menjalankan contoh ini, ganti SPACE_NAME dengan ID dari kolom name ruang. Anda bisa mendapatkan ID dengan memanggil metode ListSpaces atau dari URL ruang.

Google Chat API menampilkan daftar anggota aplikasi, manusia, dan Google Grup dari ruang yang ditentukan.

Mencantumkan anggota dalam ruang dengan autentikasi aplikasi

Untuk mencantumkan pengguna dan aplikasi Chat di ruang yang dapat diakses oleh aplikasi terautentikasi, teruskan hal berikut dalam permintaan Anda:

Contoh berikut mencantumkan anggota ruang manusia (bukan pengelola ruang) yang dapat dilihat oleh aplikasi Chat:

Node.js

chat/client-libraries/cloud/list-memberships-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to list memberships with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
    // ROLE_MANAGER)
    filter: 'member.type = "HUMAN"',
  };

  // Make the request
  const pageResult = chatClient.listMembershipsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

await main();

Python

chat/client-libraries/cloud/list_memberships_app_cred.py
from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to list memberships with app credential
def list_memberships_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.ListMembershipsRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
        # ROLE_MANAGER)
        filter = 'member.type = "HUMAN"',
        # Number of results that will be returned at once
        page_size = 100
    )

    # Make the request
    page_result = client.list_memberships(request)

    # Handle the response. Iterating over page_result will yield results and
    # resolve additional pages automatically.
    for response in page_result:
        print(response)

list_memberships_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMembershipsAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMembershipsRequest;
import com.google.chat.v1.ListMembershipsResponse;
import com.google.chat.v1.Membership;

// This sample shows how to list memberships with app credential.
public class ListMembershipsAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      ListMembershipsRequest.Builder request = ListMembershipsRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Filter membership by type (HUMAN or BOT) or role
        // (ROLE_MEMBER or ROLE_MANAGER).
        .setFilter("member.type = \"HUMAN\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

      // Iterate over results and resolve additional pages automatically.
      for (Membership response :
          chatServiceClient.listMemberships(request.build()).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list memberships with app credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function listMembershipsAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = "spaces/SPACE_NAME";
  // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
  // ROLE_MANAGER)
  const filter = 'member.type = "HUMAN"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.Members.list(
      parent,
      {
        filter: filter,
        pageSize: 10,
        pageToken: pageToken,
      },
      getHeaderWithAppCredentials(),
    );
    // Handle response pages
    if (responsePage.memberships) {
      for (const membership of responsePage.memberships) {
        console.log(membership);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Untuk menjalankan contoh ini, ganti SPACE_NAME dengan ID dari kolom name ruang. Anda bisa mendapatkan ID dengan memanggil metode ListSpaces atau dari URL ruang.

Google Chat API menampilkan daftar anggota ruang manusia (tidak termasuk pengelola ruang) dari ruang yang ditentukan.

Mencantumkan anggota sebagai administrator Google Workspace

Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metode ListMemberships untuk mencantumkan keanggotaan ruang mana pun di organisasi Google Workspace Anda. Chat API hanya menampilkan keanggotaan tentang pengguna—baik internal maupun eksternal—atau Grup Google dari organisasi Anda, dan oleh karena itu, tidak menyertakan keanggotaan untuk aplikasi Chat apa pun.

Untuk memanggil metode ini sebagai administrator Google Workspace, lakukan hal berikut:

  • Panggil metode menggunakan autentikasi pengguna, dan tentukan cakupan otorisasi yang mendukung panggilan metode menggunakan hak istimewa administrator.
  • Dalam permintaan Anda, tentukan parameter kueri berikut:
    • Setel useAdminAccess ke true.
    • Untuk menampilkan hanya pengguna, tetapkan filter untuk member.type sama dengan HUMAN.
    • Untuk menampilkan pengguna dan grup, tetapkan filter untuk member.type tidak sama dengan BOT AND showGroups sama dengan true.

Untuk mengetahui informasi dan contoh selengkapnya, lihat Mengelola ruang Google Chat sebagai administrator Google Workspace.

Menyesuaikan penomoran halaman atau memfilter daftar

Untuk mencantumkan keanggotaan, teruskan parameter kueri berikut untuk menyesuaikan penomoran halaman atau memfilter keanggotaan yang tercantum:

  • pageSize: Jumlah maksimum keanggotaan yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 100 ruang akan ditampilkan. Nilai maksimum adalah 1.000; nilai lebih dari 1.000 akan otomatis diubah menjadi 1.000.
  • pageToken: Token halaman, yang diterima dari panggilan list spaces sebelumnya. Berikan token ini untuk mengambil halaman berikutnya. Saat melakukan penomoran halaman, nilai filter harus sesuai dengan panggilan yang memberikan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak terduga.
  • filter: Filter kueri. Memerlukan autentikasi pengguna. Untuk mengetahui detail kueri yang didukung, lihat referensi ListMembershipsRequest.