Tworzenie pokoju o nazwie w Google Chat

Ten przewodnik wyjaśnia, jak utworzyć przestrzeń z nazwą za pomocą metody create() w zasobie Space interfejsu Google Chat API.

Nazwany pokój (w którym spaceType jest SPACE) to miejsce, w którym użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować. Pokoje z nazwami mogą zawierać aplikacje Google Chat. Pokoje z nazwą mają menedżerów, którzy mogą stosować ustawienia administracyjne, opisy oraz dodawać i usuwać osoby i aplikacje.

Aby utworzyć różne typy pokoi w Google Chat (w tym czaty i czaty grupowe), użyj metody setUp() w zasobie Space, aby utworzyć pokój i jednocześnie dodać członków. Więcej informacji znajdziesz w artykule Konfigurowanie pokoju.

Po utworzeniu pokoju z nazwą jedynym jego członkiem jest uwierzytelniony użytkownik. Aby dodać członków do pokoju, wywołaj metodę create() w zasobie Membership dla każdej osoby lub aplikacji, którą chcesz dodać. Możesz też użyć metody setUp(), aby utworzyć nazwany pokój i jednocześnie dodać do niego członków.

Wymagania wstępne

Node.js

Python

Java

Google Apps Script

Tworzenie przestrzeni nazwanej jako użytkownik

Aby utworzyć przestrzeń nazwaną z uwierzytelnianiem użytkownika, w żądaniu przekaż następujące informacje:

  • Określ zakres autoryzacji chat.spaces.create lub chat.spaces.
  • Wywołaj metodę CreateSpace(), przekazując space jako instancję Space z tymi polami:
    • Ustawiono spaceType na SPACE.
    • displayName ustawiona na nazwę pokoju widoczną dla użytkownika.
    • Opcjonalnie możesz ustawić inne atrybuty, takie jak:
      • spaceDetails- opis widoczny dla użytkowników i zestaw wytycznych dotyczących pokoju.
      • predefinedPermissionSettings – predefiniowane uprawnienia pokoju. Możesz na przykład skonfigurować je tak, aby wszyscy użytkownicy lub tylko menedżerowie pokoju mogli publikować wiadomości.

Aby utworzyć nazwany pokój:

Node.js

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

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

// This sample shows how to create a named space 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',
    },
  };

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

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

await main();

Python

chat/client-libraries/cloud/create_space_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.spaces.create"]

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

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

  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))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

Google Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space 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 createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

Tworzenie nazwanego pokoju jako aplikacji w Google Chat

Uwierzytelnianie aplikacji wymaga jednorazowego zatwierdzenia przez administratora.

Aby zaprosić lub dodać użytkownika do pokoju z uwierzytelnianiem aplikacji, w żądaniu przekaż następujące informacje:

  • Określ zakres autoryzacji chat.app.spaces.create lub chat.app.spaces.
  • Wywołaj metodę create w Spacezasobie.
  • Ustaw spaceType na SPACE.
  • Ustaw displayName na nazwę pokoju widoczną dla użytkowników. W tym przykładzie wartość displayName jest ustawiona na API-made.
  • W polu customer podaj identyfikator klienta domeny Google Workspace.
  • Opcjonalnie możesz ustawić inne atrybuty pokoju, takie jak spaceDetails (opis widoczny dla użytkowników i zestaw wytycznych dotyczących pokoju).

Napisz skrypt, który wywołuje Chat API

Aby utworzyć nazwany pokój:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_create_named_app.py.

  2. Dodaj do pliku chat_space_create_named_app.py ten kod:

    from google.oauth2 import service_account
from apiclient.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.app.spaces.create"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat space.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.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',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

    # Prints details about the created space.
    print(result)

if __name__ == '__main__':
    main()

  3. W kodzie zastąp te elementy:

    • CUSTOMER: identyfikator klienta domeny przestrzeni w formacie customer/{customer}, gdzie {customer} to ID z zasobu klienta Admin SDK. Aby utworzyć pokój w tej samej organizacji Google Workspace co aplikacja Google Chat, użyj customers/my_customer.

  4. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_create_named_app.py

Otwieranie pokoju w Google Chat

Aby przejść do pokoju, użyj identyfikatora zasobu pokoju do utworzenia jego adresu URL. Identyfikator zasobu znajdziesz w pokojuname w treści odpowiedzi Google Chat. Jeśli na przykład identyfikator pokojuname to spaces/1234567, możesz przejść do pokoju, korzystając z tego adresu URL: https://mail.google.com/chat/u/0/#chat/space/1234567.

Ograniczenia i kwestie do rozważenia

  • Gdy tworzysz pokój za pomocą uwierzytelniania aplikacji, uwierzytelniana aplikacja Chat jest dodawana jako uczestnik pokoju, ale w przeciwieństwie do uwierzytelniania użytkownika nie jest menedżerem pokoju. Domyślnie wszyscy członkowie pokoju mogą usunąć aplikację Google Chat. Aby zezwolić na to tylko menedżerom pokoju, ustaw permissionSettings.manageApps na managersAllowed.