Tworzenie pokoju o nazwie w Google Chat

Z tego przewodnika dowiesz się, jak utworzyć przestrzeń nazwaną, używając metody create() na zasobie Space interfejsu Google Chat API.

Pokój z nazwą (spaceTypeSPACE) to miejsce, w którym użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują. Nazwane pokoje mogą zawierać aplikacje Google Chat. Nazwane pokoje mają menedżerów, którzy mogą stosować ustawienia administracyjne, opisy oraz dodawać i usuwać osoby i aplikacje.

Aby utworzyć różne typy pokoi Google Chat (w tym czaty bezpośrednie lub grupowe), użyj metody setUp() w zasobach Space, aby utworzyć pokój i jednocześnie dodać do niego użytkowników. Więcej informacji znajdziesz w artykule Konfigurowanie pokoju.

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

Wymagania wstępne

Node.js

Python

Java

Google Apps Script

Tworzenie przestrzeni nazw przez użytkownika

Aby utworzyć przestrzeń nazwaną z uwierzytelnieniem użytkownika, w żądaniu podaj:

  • Określ zakres autoryzacji chat.spaces.create lub chat.spaces.
  • Wywołaj metodę CreateSpace(), przekazując jako argument space instancję klasy Space z tymi polami:
    • Ustawiono spaceType na SPACE.
    • displayName ustawiona na widoczną dla użytkowników nazwę pokoju.
    • Opcjonalnie ustaw inne atrybuty, takie jak:
      • spaceDetails- opis widoczny dla użytkowników i zestaw wskazówek dotyczących pokoju.
      • predefinedPermissionSettings – wstępnie zdefiniowane uprawnienia pokoju. Możesz na przykład skonfigurować pokój tak, aby wiadomości mogli publikować wszyscy użytkownicy lub tylko ich administratorzy.

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

main().catch(console.error);

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 pokoju o nazwie jako aplikacji Google Chat

Uwierzytelnianie aplikacji wymaga jednorazowego zatwierdzenia przez administratora.

Aby zaprosić użytkownika do pokoju lub dodać go do pokoju przy użyciu uwierzytelniania aplikacji, prześlij w żądaniu te informacje:

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

Tworzenie klucza interfejsu API

Aby wywołać metodę interfejsu API w wersji przedpremierowej dla programistów, musisz użyć niepublicznej wersji dokumentu dotyczącego wykrywania interfejsu API w wersji przedpremierowej dla programistów. Aby uwierzytelnić żądanie, musisz podać klucz interfejsu API.

Aby utworzyć klucz interfejsu API, otwórz projekt Google Cloud aplikacji i wykonaj te czynności:

  1. W konsoli Google Cloud kliknij Menu  > Interfejsy API i usługi > Dane logowania.

    Przejdź do danych logowania

  2. Kliknij Utwórz dane logowania > Klucz interfejsu API.
  3. Wyświetli się nowy klucz API.
    • Kliknij Kopiuj , aby skopiować klucz interfejsu API i użyć go w kodzie aplikacji. Klucz interfejsu API znajdziesz też w sekcji „Klucze interfejsu API” w danych logowania projektu.
    • Aby zaktualizować ustawienia zaawansowane i ograniczyć użycie klucza API, kliknij Ogranicz klucz. Więcej informacji znajdziesz w artykule Stosowanie ograniczeń kluczy interfejsu API.

Napisać skrypt, który wywołuje interfejs 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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 zamień:

    • API_KEY: klucz interfejsu API utworzony do tworzenia punktu końcowego usługi Chat API.

    • CUSTOMER: identyfikator klienta domeny w usłudze w formacie customer/{customer}, gdzie {customer} to ID z zasobu klienta w Admin SDK. Aby utworzyć pokój w tej samej organizacji Google Workspace, w której znajduje się 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 pokoju name znajdziesz w treści odpowiedzi w Google Chat. Jeśli na przykład name Twojego pokoju to spaces/1234567, możesz przejść do tego pokoju, korzystając z tego adresu URL: https://mail.google.com/chat/u/0/#chat/space/1234567.