Z tego przewodnika dowiesz się, jak używać metody setup
w zasobie Space
funkcji
Google Chat API do konfigurowania pokoju Google Chat. Skonfigurowanie pokoju powoduje utworzenie pokoju
i dodaje do niego określonych użytkowników.
Space
zasób
to miejsce, gdzie ludzie 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ę.
Podczas konfigurowania pokoju weź pod uwagę te kwestie:
- Użytkownik nawiązujący połączenie (uwierzytelniony) jest automatycznie dodawany do pokoju, więc nie musisz określać w żądaniu członkostwa użytkownika.
- Jeśli podczas tworzenia czatu istnieje 2 użytkowników, po wysłaniu wiadomości czatu pojawi się czat. W przeciwnym razie zostanie utworzony czat.
- podczas tworzenia czatu grupowego, jeśli nie wybrano żadnego członkostwa wymienionego w prośbie. zostaną dodani do czatu grupowego (np. problem z uprawnieniami), a potem może zostać utworzony pusty czat grupowy (z którym tylko użytkownik dzwoni).
- Nie możesz konfigurować pokoi z odpowiedziami w wątkach ani dodawać osób spoza swojej domeny Google Workspace
- Zduplikowane subskrypcje (w tym użytkownik dzwoniący) podane w prośbie. są odfiltrowywane, a nie powodują błędu żądania.
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.
Konfigurowanie pokoju
Aby skonfigurować pokój, w swojej prośbie podaj te informacje:
- Określ zakres autoryzacji
chat.spaces.create
lubchat.spaces
. - Wywołaj funkcję
Metoda
setup
w zasobieSpace
. - Aby dodać użytkownika jako członka pokoju, wpisz
users/{user}
, gdzie{user}
jest{person_id}
dlaperson
z interfejsu People API lub identyfikatoruser
w interfejsie Directory API. Jeśli na przykład osoba korzystająca z interfejsu People APIresourceName
topeople/123456789
. Możesz dodać użytkownika do pokoju, wykonując: w tym członkostwo zusers/123456789
jakomember.name
. - Aby dodać grupę jako członka pokoju, wpisz
groups/{group}
, gdzie{group}
to identyfikator grupy, do której chcesz utworzyć członkostwo. Identyfikatorem grupy może być pobrać za pomocą interfejsu Cloud Identity API. Jeśli na przykład interfejs Cloud Identity API zwraca grupę o nazwiegroups/123456789
, a następnie ustawionomembership.groupMember.name
dogroups/123456789
. Grupy dyskusyjne Google nie mogą została dodana do czatu grupowego lub czatu, ale tylko do nazwanego pokoju. - Aby utworzyć czat między użytkownikiem dzwoniącym a inną osobą użytkownika, należy określić w żądaniu członkostwo tego użytkownika.
- Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw
Space.singleUserBotDm
dotrue
i nie określaj żadnych członkostwa. Dostępne opcje tej metody należy użyć tylko do skonfigurowania czatu z aplikacją do rozmów. Aby dodać połączenie jako członka pokoju lub istniejącego czatu między 2 użytkownikami, patrz utworzyć subskrypcję.
Przykład poniżej tworzy pokój nazwany i użytkowników w pokoju dla jednej grupy i trzech użytkowników (w tym uwierzytelnionego użytkownika i dwóch innym określonym użytkownikom).
Python
- W katalogu roboczym utwórz plik o nazwie
chat_space_setup.py
. Umieść w pliku
chat_space_setup.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.create"] def main(): ''' Authenticates with Chat API via user credentials, then sets up a Chat space by creating a space and adding members. ''' # 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().setup( # Details about the space to set up. body = { # Attributes of the space to set up, like space type and display name. 'space': { # To set up a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space 'displayName': 'API-setup' }, # The users and groups to add to the space. # # The authenticated user is automatically added to the space, # and doesn't need to be specified in the memberships array. 'memberships': [ { 'member': { 'name':'users/123456789', 'type': 'HUMAN' } }, { 'member': { 'name':'users/987654321', 'type': 'HUMAN' } }, { 'groupMember': { 'name': 'groups/11223344' } } ] } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_space_setup.py
Node.js
- W katalogu roboczym utwórz plik o nazwie
setup-space.js
. Umieść w pliku
setup-space.js
ten kod:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Sets up a new Chat space with users. * @return {!Promise<!Object>} */ async function setupSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.create', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.setup({ requestBody: { space: { spaceType: 'SPACE', displayName: 'API-made', }, memberships: [ {member: {name: 'users/123456789', type: 'HUMAN'}}, {member: {name: 'users/987654321', type: 'HUMAN'}}, {groupMember: {name: 'groups/11223344'}}, ] } }); } setupSpace().then(console.log);
W katalogu roboczym uruchom przykładowy kod:
node setup-space.js
Nazwany pokój czatu z 1 grupą i 3 użytkownikami, w tym
Aby otworzyć pokój, utwórz jego adres URL na podstawie identyfikatora jego zasobu.
Identyfikator zasobu znajdziesz w odpowiedzi Google Chat z pokoju name
. Jeśli na przykład name
w Twoim pokoju to spaces/1234567
, możesz
do pokoju pod tym adresem URL:
https://mail.google.com/chat/u/0/#chat/space/1234567
Powiązane artykuły
- Tworzenie pokoju
- Wyświetlanie informacji o pokoju
- Pokoje listy.
- Aktualizowanie pokoju.
- Usuwanie pokoju
- Znajdź pokój czatu.
- Ustawianie pokoju jako wykrywalnego dla określonych użytkowników