Wyświetlanie listy użytkowników w pokoju

Z tego przewodnika dowiesz się, jak używać metody list w zasobie Membership interfejsu Google Chat API, aby wyświetlać użytkowników w pokoju w postaci podzielonej na strony, filtrowanej listy członkostw w pokoju.

Właściciele i menedżerowie pokoju mogą ograniczyć zakres osób, które mogą wyświetlać listę użytkowników w pokoju. Jeśli widoczność jest ograniczona, wywołania tej metody z uwierzytelnianiem aplikacji mogą zwracać pustą listę lub pomijać osoby, które nie są widoczne dla użytkowników pokoju. Wywołania tej metody z uwierzytelnianiem użytkownika mogą zwracać błąd PERMISSION_DENIED.

  • Wyświetlanie subskrypcji z uwierzytelnianiem aplikacji wyświetla subskrypcje w pokojach, do których aplikacja Google Chat ma dostęp, ale wyklucza subskrypcje aplikacji Google Chat, w tym własne.
  • Wyświetlanie członkostw z uwierzytelnianiem użytkownika wyświetla członkostwa w pokojach, do których uwierzytelniony użytkownik ma dostęp.
  • Wyświetlanie członkostwa jako administrator Google Workspace z uwierzytelnianiem użytkownika za pomocą uprawnień administratora wyświetla członkostwo we wszystkich przestrzeniach w organizacji Google Workspace.

MembershipZasób określa, czy użytkownik lub aplikacja Google Chat jest zaproszony do pokoju, należy do niego czy nie.

Wymagania wstępne

Node.js

  • Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do obsługi czatu, dodaj ją do pokoju.

Python

  • Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do obsługi czatu, dodaj ją do pokoju.

Java

  • Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do obsługi czatu, dodaj ją do pokoju.

Google Apps Script

  • Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do obsługi czatu, dodaj ją do pokoju.

Wyświetlanie listy członków pokoju z uwierzytelnianiem użytkownika

Aby wyświetlić listę użytkowników, grup dyskusyjnych Google i aplikacji do obsługi czatu w przestrzeni, do której uwierzytelniony użytkownik ma dostęp, w żądaniu przekaż te informacje:

  • W przypadku uwierzytelniania użytkownika określ zakres autoryzacji chat.memberships.readonly lub chat.memberships.
  • Wywołaj metodę ListMemberships.
  • Aby wyświetlić listę grup Google, ustaw parametr zapytania showGroups na true.

W tym przykładzie wymieniono członków grup dyskusyjnych Google, użytkowników i aplikacji widocznych dla uwierzytelnionego użytkownika.

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

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

Aby uruchomić ten przykład, zastąp SPACE_NAME identyfikatorem z pola name przestrzeni. Możesz go uzyskać, wywołując metodę ListSpaces lub z adresu URL pokoju.

Interfejs Google Chat API zwraca listę członków grupy Google, osób i aplikacji z określonego pokoju.

Wyświetlanie listy członków w pokoju z uwierzytelnianiem aplikacji

Aby wyświetlić listę użytkowników i aplikacji Google Chat w pokoju, do którego uwierzytelniona aplikacja ma dostęp, w żądaniu przekaż te informacje:

W tym przykładzie wymieniono członków pokoju (nie menedżerów pokoju), którzy są widoczni dla aplikacji Google 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));
      }
    }
  }
}

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

Aby uruchomić ten przykład, zastąp SPACE_NAME identyfikatorem z pola name przestrzeni. Możesz go uzyskać, wywołując metodę ListSpaces lub z adresu URL pokoju.

Interfejs Google Chat API zwraca listę użytkowników pokoju (z wyłączeniem menedżerów pokoju) w określonym pokoju.

Wyświetlanie członków jako administrator Google Workspace

Jeśli jesteś administratorem Google Workspace, możesz wywołać metodę ListMemberships, aby wyświetlić listę członkostw w dowolnym pokoju w organizacji Google Workspace. Interfejs Chat API zwraca tylko informacje o użytkownikach (wewnętrznych i zewnętrznych) lub grupach dyskusyjnych Google w Twojej organizacji, a tym samym pomija informacje o członkostwie w aplikacjach Google Chat.

Aby wywołać tę metodę jako administrator Google Workspace, wykonaj te czynności:

  • Wywołaj metodę za pomocą uwierzytelniania użytkownika i określ zakres autoryzacji, który umożliwia wywoływanie metody z uprawnieniami administratora.
  • W żądaniu podaj te parametry zapytania:
    • Ustaw useAdminAccess na true.
    • Aby zwrócić tylko użytkowników, ustaw wartość filter dla member.type na HUMAN.
    • Aby zwrócić użytkowników i grupy, ustaw filter dla member.type nie jest równe BOT AND showGroups jest równe true.

Więcej informacji i przykłady znajdziesz w artykule Zarządzanie pokojami w Google Chat jako administrator Google Workspace.

Dostosowywanie podziału na strony lub filtrowanie listy

Aby wyświetlić listę subskrypcji, przekaż te parametry zapytania, aby dostosować paginację lub filtrować wyświetlane subskrypcje:

  • pageSize: maksymalna liczba subskrypcji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 pokoi. Maksymalna wartość to 1000. Wartości powyżej 1000 są automatycznie zmieniane na 1000.
  • pageToken: token strony otrzymany z poprzedniego wywołania listy miejsc. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazanie innej wartości może prowadzić do nieoczekiwanych wyników.
  • filter: filtr zapytania. Wymaga uwierzytelnienia użytkownika. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w ListMembershipsRequest.