Обновить пространство

В этом руководстве объясняется, как использовать метод patch() ресурса Space API Google Chat для обновления пространства. Обновите пространство, чтобы изменить его атрибуты, такие как отображаемое пользователем имя, описание и правила.

Если вы являетесь администратором Google Workspace, вы можете вызвать метод patch() для обновления любого существующего пространства в вашей организации Google Workspace.

Ресурс Space представляет собой место, где пользователи и чат-приложения могут отправлять сообщения, обмениваться файлами и работать вместе. Существует несколько типов пространств:

  • Прямые сообщения (ЛС) — это беседы между двумя пользователями или пользователем и приложением чата.
  • Групповые чаты — это беседы между тремя и более пользователями и приложениями чата.
  • Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.

Предпосылки

Node.js

Питон

Ява

Скрипт приложений

Обновите пространство как пользователь

Чтобы обновить существующее пространство в Google Chat с аутентификацией пользователя , передайте в запросе следующее:

  • Укажите область авторизации chat.spaces .
  • Вызовите метод UpdateSpace() . В запросе укажите поле name пространства, поле updateMask с одним или несколькими полями для обновления и body с обновлённой информацией о пространстве.

Вы можете обновить такие данные, как отображаемое имя, тип пространства, состояние истории и т. д. Список всех полей, которые можно обновить, см. в справочной документации .

Вот как обновить поле displayName существующего пространства:

Node.js

chat/client-libraries/cloud/update-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';  const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces'];  // This sample shows how to update a 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: {       // Replace SPACE_NAME here       name: 'spaces/SPACE_NAME',       displayName: 'New space display name'     },     // The field paths to update. Separate multiple values with commas or use     // `*` to update all field paths.     updateMask: {       // The field paths to update.       paths: ['display_name']     }   };    // Make the request   const response = await chatClient.updateSpace(request);    // Handle the response   console.log(response); }  main().catch(console.error);

Питон

chat/client-libraries/cloud/update_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"]  # This sample shows how to update a space with user credential def update_space_with_user_cred():     # Create a client     client = create_client_with_user_credentials(SCOPES)      # Initialize request argument(s)     request = google_chat.UpdateSpaceRequest(         space = {             # Replace SPACE_NAME here             'name': 'spaces/SPACE_NAME',             'display_name': 'New space display name'         },         # The field paths to update. Separate multiple values with commas.         update_mask = 'displayName'     )      # Make the request     response = client.update_space(request)      # Handle the response     print(response)  update_space_with_user_cred()

Ява

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.UpdateSpaceRequest; import com.google.chat.v1.Space; import com.google.protobuf.FieldMask;  // This sample shows how to update space with user credential. public class UpdateSpaceUserCred {    private static final String SCOPE =     "https://www.googleapis.com/auth/chat.spaces";    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithUserCredentials(           ImmutableList.of(SCOPE))) {       UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()         .setSpace(Space.newBuilder()           // Replace SPACE_NAME here.           .setName("spaces/SPACE_NAME")           .setDisplayName("New space display name"))         .setUpdateMask(FieldMask.newBuilder()           // The field paths to update.           .addPaths("display_name"));       Space response = chatServiceClient.updateSpace(request.build());        System.out.println(JsonFormat.printer().print(response));     }   } }

Скрипт приложений

chat/advanced-service/Main.gs
/**  * This sample shows how to update a space with user credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'  * referenced in the manifest file (appsscript.json).  */ function updateSpaceUserCred() {   // Initialize request argument(s)   // TODO(developer): Replace SPACE_NAME here   const name = 'spaces/SPACE_NAME';   const space = {     displayName: 'New space display name'   };   // The field paths to update. Separate multiple values with commas or use   // `*` to update all field paths.   const updateMask = 'displayName';    // Make the request   const response = Chat.Spaces.patch(space, name, {     updateMask: updateMask   });    // Handle the response   console.log(response); }

Чтобы запустить этот пример, замените SPACE_NAME на идентификатор из поля name пространства. Идентификатор можно получить, вызвав метод ListSpaces() или перейдя по URL-адресу пространства.

API Google Chat возвращает экземпляр Space , отражающий обновления.

Обновите пространство как администратор Google Workspace

Если вы являетесь администратором Google Workspace, вы можете вызвать метод UpdateSpace() для обновления любого пространства в вашей организации Google Workspace.

Чтобы вызвать этот метод от имени администратора Google Workspace, выполните следующие действия:

Дополнительную информацию и примеры см. в статье Управление пространствами Google Chat в качестве администратора Google Workspace .

Обновите пространство как приложение чата

Аутентификация приложения требует однократного одобрения администратора .

Чтобы обновить существующее пространство в Google Chat с аутентификацией приложения , передайте в запросе следующее:

  • Укажите область авторизации chat.app.spaces . При аутентификации через приложение вы можете обновлять только пространства, созданные приложениями Chat.
  • Вызовите метод patch для ресурса Space . В запросе укажите поле name пространства, поле updateMask с одним или несколькими полями для обновления и body с обновлённой информацией о пространстве.

Вы можете обновить такие данные, как отображаемое имя, тип пространства, состояние истории, настройки разрешений и многое другое. Чтобы узнать обо всех полях, которые можно обновить, см. справочную документацию .

Напишите скрипт, который вызывает Chat API

Вот как обновить поле spaceDetails существующего пространства:

Питон

  1. В рабочем каталоге создайте файл с именем chat_space_update_app.py .

  2. Включите следующий код в chat_space_update_app.py :

    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"]  def main():     '''     Authenticates with Chat API using app authentication,     then updates the specified space description and guidelines.     '''      # 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().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()

  3. В коде замените следующее:

    • SPACE с именем пространства, которое можно получить из метода spaces.list в Chat API или из URL-адреса пространства.

  4. В вашем рабочем каталоге соберите и запустите пример:

    python3 chat_space_update_app.py

API Google Chat возвращает экземпляр ресурса Space , отражающий обновления.

Ограничения и соображения