Method: spaces.setup

Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik wywołujący jest automatycznie dodawany do pokoju i nie powinien być określany jako członek prośby. Przykład: ustaw pokój.

Aby wskazać członków, których chcesz dodać, dodaj członków o odpowiednim member.name elemencie SetUpSpaceRequest. Aby dodać użytkownika, użyj users/{user}, gdzie {user} może być jego adresem e-mail. W przypadku użytkowników z tej samej organizacji Workspace {user} może też być {person_id} dla osoby z interfejsu People API lub id dla użytkownika w interfejsie Directory API. Jeśli na przykład użytkownik interfejsu API osób resourceName dla user@example.com to people/123456789, możesz dodać użytkownika do pokoju, ustawiając wartość membership.member.name na users/user@example.com lub users/123456789.

W przypadku pokoju lub czatu grupowego, jeśli rozmówca blokuje lub jest zablokowany przez niektórych członków, nie są oni dodawani do tworzonego pokoju.

Aby utworzyć czat z użytkownikiem, który łączy się z innym użytkownikiem, określ dokładnie 1 członek, który będzie reprezentował tego użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie nie powiedzie się, a czat nie zostanie utworzony.

Aby utworzyć czat między użytkownikiem wywołującym a aplikacją do wykonywania połączeń, ustaw Space.singleUserBotDm na true i nie określaj żadnych członkostwa. Tej metody możesz użyć tylko do skonfigurowania czatu z aplikacją do wykonywania połączeń. Aby dodać aplikację do połączeń jako osobę w pokoju lub do istniejącego czatu między 2 osobami, zobacz Tworzenie subskrypcji.

Jeśli czat istnieje już między 2 użytkownikami, nawet jeśli jeden z nich zablokuje innego w momencie przesyłania żądania, zostanie zwrócony istniejący czat.

Pokoje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju zobaczysz komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego: displayName. Obecna przestrzeń w organizacji Google Workspace może już mieć tę wyświetlaną nazwę.

Wymaga uwierzytelniania użytkownika.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Pola
space

object (Space)

Wymagany. Pole Space.spaceType jest wymagane.

Aby utworzyć pokój, ustaw Space.spaceType na SPACE i ustaw Space.displayName. Jeśli podczas konfigurowania pokoju zobaczysz komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego: displayName. Obecna przestrzeń w organizacji Google Workspace może już mieć tę wyświetlaną nazwę.

Aby utworzyć czat grupowy, ustaw wartość Space.spaceType na GROUP_CHAT. Nie ustawiaj Space.displayName.

Aby utworzyć rozmowę 1:1 między ludźmi, ustaw wartość Space.spaceType na DIRECT_MESSAGE i ustaw Space.singleUserBotDm na false. Nie ustawiaj Space.displayName ani Space.spaceDetails.

Aby utworzyć rozmowę 1:1 między człowiekiem a aplikacją do rozmów na czacie, ustaw wartość Space.spaceType na DIRECT_MESSAGE, a Space.singleUserBotDm na true. Nie ustawiaj Space.displayName ani Space.spaceDetails.

Jeśli istnieje już pokój DIRECT_MESSAGE, zostanie on zwrócony zamiast tworzenia nowego.
requestId

string

Opcjonalnie. Unikalny identyfikator tego żądania. Zalecany jest losowy identyfikator UUID. Jeśli określisz identyfikator żądania, nie będzie trzeba tworzyć nowego pokoju, który zostanie utworzony z tym identyfikatorem. Określenie istniejącego identyfikatora żądania z tej samej aplikacji do obsługi czatu z innym uwierzytelnionym użytkownikiem zwraca błąd.
memberships[]

object (Membership)

Opcjonalnie. użytkowników Google Chat, którzy mogą zaprosić do pokoju; Pomiń połączenie z użytkownikiem, który dodał rozmówcę, ponieważ zostanie dodany automatycznie.

Zestaw może obecnie obejmować do 20 członków (oprócz rozmówcy).

Pole Membership.member musi zawierać pole user z wypełnionymi polami name (format: users/{user}) i type o wartości User.Type.HUMAN. Użytkowników możesz dodać tylko podczas konfigurowania pokoju (aplikacje na czacie są obsługiwane tylko w przypadku rozmów na czacie). Możesz też dodać użytkowników, używając adresu e-mail użytkownika jako aliasu {user}. Na przykład user.name może mieć wartość users/example@gmail.com”. Aby zaprosić użytkowników Gmaila lub użytkowników z zewnętrznych domen Google Workspace, musisz użyć adresu e-mail użytkownika {user}.

Opcjonalna, gdy ustawiasz Space.spaceType na SPACE.

Wymagane w przypadku ustawienia Space.spaceType na GROUP_CHAT, a także co najmniej 2 wspierania.

Wymagane w przypadku ustawienia Space.spaceType na DIRECT_MESSAGE dla użytkownika, wraz z 1 subskrypcją.

Pole musi być puste podczas tworzenia rozmowy 1:1 między człowiekiem a aplikacją Google do rozmów (gdy ustawisz wartość Space.spaceType na DIRECT_MESSAGE i Space.singleUserBotDm na true).

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Space.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.