Z tego przewodnika dowiesz się, jak używać metody patch
w zasobie Space
interfejsu Google Chat API w celu zaktualizowania pokoju. Aktualizowanie pokoju, aby zmienić jego atrybuty
takich jak wyświetlana nazwa, opis i wytyczne.
Space
zasób
to miejsce, w którym użytkownicy i aplikacje do obsługi czatu mogą wysyłać wiadomości,
udostępniać pliki i współpracować. Jest kilka rodzajów pokoi:
- Czaty to rozmowy między 2 użytkownikami lub użytkownikiem aplikacji do obsługi czatu.
- Czaty grupowe to rozmowy między co najmniej 3 użytkownikami komunikatory;
- Pokoje nazwane to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracę.
Wymagania wstępne
Python
- Firmy lub przedsiębiorstwa Konto Google Workspace z dostępem do Google Chat.
- Python w wersji 3.6 lub nowszej
- narzędzie do zarządzania pakietami pip;
- Najnowsze biblioteki klienta Google. Aby je zainstalować lub zaktualizować:
uruchom następujące polecenie w interfejsie wiersza poleceń:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth
- Włącz i skonfiguruj interfejs Google Chat API pod nazwą. ikonę i opis aplikacji Google Chat.
-
Utwórz dane logowania na podstawie identyfikatora klienta OAuth dla aplikacji komputerowej. Aby uruchomić próbkę w tym
zapisz dane logowania w pliku JSON (
client_secrets.json
) na swoim katalog lokalny.
- Wybierz zakres autoryzacji, który obsługuje uwierzytelnianie użytkowników.
Node.js
- Firmy lub przedsiębiorstwa Konto Google Workspace z dostępem do Google Chat.
- Node.js w wersji 14 lub nowszej
- npm narzędzie do zarządzania pakietami
- Najnowsze biblioteki klienta Google. Aby je zainstalować lub zaktualizować:
uruchom następujące polecenie w interfejsie wiersza poleceń:
npm install @google-cloud/local-auth @googleapis/chat
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth
- Włącz i skonfiguruj interfejs Google Chat API pod nazwą. ikonę i opis aplikacji Google Chat.
-
Utwórz dane logowania na podstawie identyfikatora klienta OAuth dla aplikacji komputerowej. Aby uruchomić próbkę w tym
zapisz dane logowania w pliku JSON (
client_secrets.json
) na swoim katalog lokalny.
- Wybierz zakres autoryzacji, który obsługuje uwierzytelnianie użytkowników.
Aktualizowanie pokoju
Aby zaktualizować istniejący pokój w Google Chat, przekaż te informacje: w Twoim żądaniu:
- Określ zakres autoryzacji
chat.spaces
. - Wywołaj funkcję
Metoda
patch
w zasobieSpace
. W należy określić pole pokojuname
orazupdateMask
z co najmniej jednym polem do zaktualizowania orazbody
ze zaktualizowanymi informacjami o pokoju.
Możesz zmieniać wyświetlane dane, takie jak wyświetlana nazwa, typ pokoju, stan historii czy i innych. Aby zobaczyć wszystkie pola, które możesz zaktualizować, zobacz dokumentację referencyjną.
Aby zaktualizować pole spaceDetails
w istniejącym pokoju:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_space_update.py
. Umieść w pliku
chat_space_update.py
ten kod:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.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 updated space. print(result) if __name__ == '__main__': main()
W kodzie zastąp
SPACE
nazwą pokoju, która który znajdziesz w Metodaspaces.list
w interfejsie Chat API lub z adresu URL pokoju.W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_space_update.py
Node.js
- W katalogu roboczym utwórz plik o nazwie
update-space.js
. Umieść w pliku
update-space.js
ten kod:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a Chat space with the description and guidelines. * @return {!Promise<!Object>} */ async function updateSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.patch({ name: 'spaces/SPACE', updateMask: 'spaceDetails', requestBody: { spaceDetails: { description: 'This description was updated with Chat API!', guidelines: 'These guidelines were updated with Chat API!' }, } }); } updateSpace().then(console.log);
W kodzie zastąp
SPACE
nazwą pokoju, która który znajdziesz w Metodaspaces.list
w interfejsie Chat API lub z adresu URL pokoju.W katalogu roboczym uruchom przykładowy kod:
node update-space.js
Interfejs Google Chat API zwraca instancję
Space
zasób z aktualizacjami.
Powiązane artykuły
- Wyświetlanie informacji o pokoju
- Pokoje listy.
- Usuwanie pokoju
- Skonfiguruj pokój.
- Znajdź pokój czatu.
- Ustawianie pokoju jako wykrywalnego dla określonych użytkowników