Method: spaces.patch

Atualiza um espaço. Para conferir um exemplo, consulte Atualizar um espaço.

Se você estiver atualizando o campo displayName e receber a mensagem de erro ALREADY_EXISTS, tente usar outro nome de exibição. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

Aceita os seguintes tipos de autenticação:

  • Autenticação de app com aprovação do administrador e um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.app.spaces

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, useAdminAccess é true e os seguintes escopos de autorização são usados:
      • https://www.googleapis.com/auth/chat.admin.spaces

A autenticação de app tem as seguintes limitações:

  • Para atualizar space.predefined_permission_settings ou space.permission_settings, o app precisa ser o criador do espaço.
  • Não é possível atualizar o space.access_settings.audience para autenticação de apps.

Solicitação HTTP

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
space.name

string

Identificador. Nome do recurso do espaço.

Formato: spaces/{space}

Em que {space} representa o ID atribuído pelo sistema ao espaço. Você pode conseguir o ID do espaço chamando o método spaces.list() ou no URL do espaço. Por exemplo, se o URL do espaço for https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, o ID do espaço será AAAAAAAAA.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Obrigatório. Os caminhos de campo atualizados, separados por vírgulas se houver vários.

É possível atualizar os seguintes campos de um espaço:

spaceDetails: atualiza a descrição do espaço. Aceita até 150 caracteres.

displayName: só é possível atualizar o nome de exibição para espaços em que o campo spaceType é SPACE. Se você receber a mensagem de erro ALREADY_EXISTS, tente um valor diferente. Um espaço na organização do Google Workspace já pode usar esse nome de exibição.

spaceType: só é possível mudar um tipo de espaço GROUP_CHAT para SPACE. Inclua displayName com spaceType na máscara de atualização e verifique se o espaço especificado tem um nome de exibição não vazio e o tipo de espaço SPACE. Incluir a máscara spaceType e o tipo SPACE no espaço especificado ao atualizar o nome de exibição é opcional se o espaço já tiver o tipo SPACE. Tentar atualizar o tipo de espaço de outras maneiras resulta em um erro de argumento inválido. spaceType não é compatível com useAdminAccess.

spaceHistoryState: atualiza as configurações de histórico do espaço ativando ou desativando o histórico do espaço. Só é compatível se as configurações de histórico estiverem ativadas para a organização do Google Workspace. Para atualizar o estado do histórico do espaço, omita todas as outras máscaras de campo na sua solicitação. spaceHistoryState não é compatível com useAdminAccess.

accessSettings.audience: atualiza a configuração de acesso de quem pode descobrir e participar do espaço, além de visualizar as mensagens no espaço nomeado em que o campo spaceType é SPACE. Se o espaço atual tiver um público-alvo, você poderá remover o público e restringir o acesso ao espaço omitindo um valor para essa máscara de campo. Para atualizar as configurações de acesso de um espaço, o usuário autenticado precisa ser um administrador do espaço e omitir todas as outras máscaras de campo na solicitação. Não é possível atualizar esse campo se o espaço estiver no modo de importação. Saiba mais em Tornar um espaço detectável para usuários específicos. accessSettings.audience não é compatível com useAdminAccess.

permissionSettings: permite mudar as configurações de permissão de um espaço. Ao atualizar as configurações de permissão, só é possível especificar máscaras de campo permissionSettings. Não é possível atualizar outras máscaras de campo ao mesmo tempo. permissionSettings não é compatível com useAdminAccess. As máscaras de campo compatíveis incluem:

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

Opcional. Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio de gerenciar conversas no Chat e nos espaços.

Requer o escopo do OAuth 2.0 chat.admin.spaces.

Alguns valores de FieldMask não são compatíveis com o acesso de administrador. Para mais detalhes, consulte a descrição de updateMask.

Corpo da solicitação

O corpo da solicitação contém uma instância de Space.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Space.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Para mais informações, consulte o guia de autorização.