Method: spaces.setup

Cria um espaço e adiciona usuários especificados a ele. O usuário que faz a chamada é adicionado automaticamente ao espaço e não precisa ser especificado como participante na solicitação. Para conferir um exemplo, consulte Configurar um espaço com os primeiros participantes.

Para especificar os membros humanos a serem adicionados, adicione as assinaturas com o membership.member.name apropriado. Para adicionar um usuário humano, use users/{user}, em que {user} pode ser o endereço de e-mail do usuário. Para usuários na mesma organização do Workspace, {user} também pode ser o id da pessoa da API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil da API People para user@example.com for 123456789, você poderá adicionar o usuário ao espaço definindo membership.member.name como users/user@example.com ou users/123456789.

Para especificar os Grupos do Google a serem adicionados, adicione associações com o membership.group_member.name apropriado. Para adicionar ou convidar um grupo do Google, use groups/{group}, em que {group} é o id do grupo da API Cloud Identity Groups. Por exemplo, é possível usar a API de pesquisa de grupos da Cloud Identity para extrair o ID 123456789 do e-mail do grupo group@example.com e, em seguida, adicionar o grupo ao espaço definindo membership.group_member.name como groups/123456789. Não é possível usar e-mails de grupo, e os grupos do Google só podem ser adicionados como membros em espaços nomeados.

Em um espaço com nome ou chat em grupo, se o autor da chamada bloquear ou for bloqueado por alguns participantes ou não tiver permissão para adicionar alguns participantes, esses participantes não serão adicionados ao espaço criado.

Para criar uma mensagem direta (DM) entre o usuário que faz a chamada e outro usuário humano, especifique exatamente uma associação para representar o usuário humano. Se um usuário bloquear o outro, a solicitação falhará e a DM não será criada.

Para criar uma DM entre o usuário que faz a chamada e o app de chamada, defina Space.singleUserBotDm como true e não especifique nenhuma associação. Só é possível usar esse método para configurar uma DM com o app de chamada. Para adicionar o app de chamada como membro de um espaço ou de uma DM entre dois usuários humanos, consulte Convidar ou adicionar um usuário ou app a um espaço.

Se uma DM já existir entre dois usuários, mesmo que um deles bloqueie o outro no momento em que uma solicitação é feita, a DM atual será retornada.

Não é possível usar espaços com respostas em linha. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar um displayName diferente. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

Requer autenticação do usuário.

Solicitação HTTP

POST https://chat.googleapis.com/v1/spaces:setup

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Campos
space

object (Space)

Obrigatório. O campo Space.spaceType é obrigatório.

Para criar um espaço, defina Space.spaceType como SPACE e Space.displayName. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar um displayName diferente. Um espaço existente na organização do Google Workspace já pode usar esse nome de exibição.

Para criar um chat em grupo, defina Space.spaceType como GROUP_CHAT. Não defina Space.displayName.

Para criar uma conversa individual entre humanos, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como false. Não defina Space.displayName ou Space.spaceDetails.

Para criar uma conversa individual entre uma pessoa e o app de chat que está ligando, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true. Não defina Space.displayName ou Space.spaceDetails.

Se um espaço DIRECT_MESSAGE já existir, ele será retornado em vez de criar um novo espaço.
requestId

string

Opcional. Um identificador exclusivo para essa solicitação. Recomendamos um UUID aleatório. Especificar um ID de solicitação atual retorna o espaço criado com esse ID em vez de criar um novo espaço. Especificar um ID de solicitação do mesmo app de chat com um usuário autenticado diferente retorna um erro.
memberships[]

object (Membership)

Opcional. Os usuários ou grupos do Google Chat que você quer convidar para participar do espaço. Omita o usuário que fez a chamada, porque ele é adicionado automaticamente.

No momento, o conjunto permite até 49 assinaturas (além do autor da chamada).

Para a associação humana, o campo Membership.member precisa conter um user com name preenchido (formato: users/{user}) e type definido como User.Type.HUMAN. Só é possível adicionar usuários humanos ao configurar um espaço. A adição de apps do Chat só é possível para a configuração de mensagens diretas com o app de chamada. Também é possível adicionar membros usando o e-mail do usuário como um alias para {user}. Por exemplo, user.name pode ser users/example@gmail.com. Para convidar usuários do Gmail ou de domínios externos do Google Workspace, o e-mail do usuário precisa ser usado para {user}.

Para a associação a grupos do Google, o campo Membership.group_member precisa conter um group com name preenchido (formato groups/{group}). Só é possível adicionar grupos do Google ao definir Space.spaceType como SPACE.

Opcional ao definir Space.spaceType como SPACE.

Obrigatório ao definir Space.spaceType como GROUP_CHAT, junto com pelo menos duas assinaturas.

Obrigatório ao definir Space.spaceType como DIRECT_MESSAGE com um usuário humano e exatamente uma assinatura.

Precisa estar vazio ao criar uma conversa individual entre uma pessoa e o app de chat que está ligando (ao definir Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true).

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.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

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