Method: spaces.patch

Atualiza um espaço. Veja um exemplo em Atualizar um espaço.

Se você estiver atualizando o campo displayName e receber a mensagem de erro ALREADY_EXISTS, tente um nome de exibição diferente. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.

Exige a autenticação do usuário.

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

Nome do recurso do espaço.

Formato: spaces/{space}

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.

Você pode atualizar os seguintes campos de um espaço:

  • spaceDetails

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

  • spaceType: só oferece suporte à mudança de 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. A inclusão da máscara spaceType e do tipo SPACE no espaço especificado ao atualizar o nome de exibição é opcional se o espaço atual já tiver o tipo SPACE. A tentativa de atualizar o tipo de espaço de outras maneiras resulta em um erro de argumento inválido. spaceType não é compatível com o acesso de administrador.

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

  • accessSettings.audience: atualiza a configuração de acesso de quem pode descobrir, participar e 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á removê-lo 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 autenticador precisa ser um administrador e omitir todas as outras máscaras de campo da solicitação. Não é possível atualizar esse campo se o espaço está 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 o acesso de administrador.

  • Prévia para desenvolvedores: oferece suporte à mudança das configurações de permissão de um espaço. Os caminhos de campo compatíveis incluem permissionSettings.manage_members_and_groups, permissionSettings.modify_space_details, permissionSettings.toggle_history, permissionSettings.use_at_mention_all, permissionSettings.manage_apps, permissionSettings.manage_webhooks e permissionSettings.reply_messages. Aviso: mutuamente exclusivo com todos os outros caminhos de campo de configurações que não são de permissão. permissionSettings não é compatível com o acesso de administrador.
useAdminAccess

boolean

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 "Gerenciar conversas de chats e espaços".

Exige o escopo OAuth 2.0 chat.admin.spaces.

Alguns valores 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.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.