Aktualizowanie pokoju

Z tego przewodnika dowiesz się, jak aktualizować pokój za pomocą metody patch w zasobie Space interfejsu Google Chat API. Zaktualizuj pokój, aby zmienić jego atrybuty, takie jak wyświetlana nazwa widoczna dla użytkowników, opis i wytyczne.

Zasób Space reprezentuje miejsce, w którym osoby i aplikacje do obsługi czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka typów pokoi:

  • Czaty to rozmowy między 2 użytkownikami lub użytkownikiem i aplikacją do obsługi czatu.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami i aplikacjami do obsługi czatu.
  • Pokoje z nazwą to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.

Wymagania wstępne

Python

  • Python 3.6 lub nowszy
  • Narzędzie do zarządzania pakietami pip

  • Najnowsze biblioteki klienta Google do języka Python. Aby je zainstalować lub zaktualizować, uruchom w interfejsie wiersza poleceń to polecenie:

    pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client

  • Opublikowana aplikacja Google Chat. Aby utworzyć i opublikować aplikację do obsługi czatu, przeczytaj artykuł Tworzenie aplikacji Google Chat.

  • Autoryzacja aplikacji Google Chat została skonfigurowana. Aktualizowanie pokoju wymaga uwierzytelniania użytkownika o zakresie autoryzacji chat.spaces.

Aktualizowanie pokoju

Aby zaktualizować istniejący pokój w Google Chat, przekaż w swojej prośbie te informacje:

  • Określ zakres autoryzacji chat.spaces.
  • Wywołaj metodę patch w zasobie Space i przekaż name pokoju do aktualizacji oraz updateMask ibody, które określają zaktualizowane atrybuty pokoju.
  • updateMask określa aspekty pokoju, które ma być aktualizowane, i zawiera:
    • displayName: aktualizuje czytelną dla użytkownika nazwę pokoju wyświetlanego w interfejsie Google Chat. Obsługuje tylko zmianę wyświetlanej nazwy pokoju o typie SPACE lub dołączenie maski spaceType w celu zmiany typu spacji GROUP_CHAT na SPACE. Próba zaktualizowania wyświetlanej nazwy pokoju GROUP_CHAT lub DIRECT_MESSAGE kończy się błędem dotyczącym nieprawidłowego argumentu.
    • spaceType: aktualizuje typ pokoju, ale obsługuje tylko zmianę typu pokoju GROUP_CHAT na SPACE. W masce aktualizacji umieść displayName wraz z parametrem spaceType i upewnij się, że podana spacja ma niepuste pole displayName i typ spacji SPACE. Jeśli istniejący pokój ma już typ SPACE, w tym maskę spaceType i typ SPACE w określonym miejscu podczas aktualizowania wyświetlanej nazwy jest opcjonalna . Jeśli spróbujesz zaktualizować typ spacji w inny sposób, wystąpi błąd nieprawidłowego argumentu.
    • spaceDetails: szczegółowe informacje o pokoju, w tym opis i reguły.
    • spaceHistoryState: obsługuje włączanie i wyłączanie historii pokoju, o ile organizacja umożliwia użytkownikom zmienianie ustawień historii. Wzajemnie uzupełniające się względem wszystkich innych ścieżek pól.

Aby zaktualizować spaceDetails istniejącego pokoju:

Python

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

  2. Umieść ten kod w pliku chat_space_update.py:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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.spaces"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the specified space description and guidelines.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

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

    # Use the service endpoint to call Chat API.
    result = chat.spaces().patch(

      # The space to update, and the updated space details.
      #
      # Replace {space} with a space name.
      # Obtain the space name from the spaces resource of Chat API,
      # or from a space's URL.
      name='spaces/SPACE',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. W kodzie zastąp SPACE nazwą pokoju, którą możesz uzyskać za pomocą metody spaces.list w interfejsie Chat API lub z adresu URL pokoju.

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

    python3 chat_space_update.py

Interfejs Google Chat API zwraca instancję zasobu Space z aktualizacjami.