Method: spaces.setup

Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik nawiązujący połączenie jest automatycznie dodawany do pokoju i nie powinien być określony jako członek w prośbie. Przykład znajdziesz w sekcji Konfigurowanie pokoju z początkowymi użytkownikami.

Aby określić osoby, które mają zostać dodane, dodaj członkostwa za pomocą odpowiednich właściwości membership.member.name. Aby dodać użytkownika, użyj pola users/{user}, gdzie {user} może być jego adresem e-mail. W przypadku użytkowników w tej samej organizacji Workspace {user} może być też id dla osoby z interfejsu People API lub id dla użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu osoby w interfejsie People API w aplikacji user@example.com to 123456789, możesz dodać użytkownika do pokoju, ustawiając membership.member.name na users/user@example.com lub users/123456789.

Aby określić grupy dyskusyjne Google, które chcesz dodać, dodaj członków za pomocą odpowiednich właściwości membership.group_member.name. Aby dodać lub zaprosić grupę dyskusyjną Google, użyj polecenia groups/{group}, gdzie {group} to id grupy z interfejsu Cloud Identity Groups API. Możesz na przykład użyć interfejsu Cloud Identity Groups lookup API, aby pobrać identyfikator 123456789 dla adresu e-mail grupy group@example.com. Następnie możesz dodać grupę do pokoju, ustawiając membership.group_member.name na groups/123456789. Adres e-mail grupy nie jest obsługiwany. Grupy dyskusyjne Google można dodawać tylko jako członków w pokojach nazwanych.

W przypadku nazwanego pokoju lub czatu grupowego: jeśli rozmówca zablokuje połączenie, jest zablokowany przez niektórych użytkowników lub nie ma uprawnień do dodawania niektórych osób, wtedy tacy użytkownicy nie zostaną dodani do utworzonego pokoju.

Aby utworzyć czat między dzwoniącym a innym użytkownikiem, określ dokładnie jedną subskrypcję, która 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 dzwoniącym a aplikacją do rozmów, ustaw Space.singleUserBotDm na true i nie określaj żadnych członkostwa. Tej metody możesz użyć tylko do skonfigurowania czatu w aplikacji do połączeń. Aby dodać aplikację do rozmów jako członka pokoju lub istniejącego czatu między 2 użytkownikami, przeczytaj artykuł Zapraszanie i dodawanie użytkownika lub aplikacji do pokoju.

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

Pokoje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego elementu displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

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)

Wymagane. Pole Space.spaceType jest wymagane.

Aby utworzyć pokój, ustaw opcję Space.spaceType na SPACE i ustaw Space.displayName. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego elementu displayName. Istniejący pokój w organizacji Google Workspace może już używać tej wyświetlanej nazwy.

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

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

Aby utworzyć rozmowę 1:1 między osobą a dzwoniącym aplikacją Google Chat, ustaw opcję Space.spaceType na DIRECT_MESSAGE, a Space.singleUserBotDm na true. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Jeśli pokój DIRECT_MESSAGE już istnieje, zostanie on zwrócony, a nie zostanie utworzony nowy.
requestId

string

Opcjonalnie. Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Jeśli podasz identyfikator istniejącego żądania, zostanie zwrócony pokój utworzony z tym identyfikatorem, zamiast tworzyć nowy pokój. Podanie 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 lub grupy Google Chat, których chcesz zaprosić do pokoju; Pomiń użytkownika dzwoniącego, ponieważ jest on dodawany automatycznie.

Zestaw pozwala obecnie na maksymalnie 20 członków (oprócz wywołującego).

W przypadku członkostwa człowieka pole Membership.member musi zawierać pole user z wypełnionymi wartościami name (format: users/{user}) i wartością type ustawioną na User.Type.HUMAN. Użytkowników można dodawać tylko podczas konfigurowania pokoju (dodawanie aplikacji do obsługi czatu jest obsługiwane tylko w przypadku konfigurowania czatu w aplikacji do połączeń). Możesz też dodać członków przy użyciu 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, {user} musi mieć adres e-mail użytkownika.

W przypadku członkostwa w grupie dyskusyjnej Google pole Membership.group_member musi zawierać wartość group z wypełnioną wartością name (format groups/{group}). Grupy dyskusyjne Google możesz dodawać tylko wtedy, gdy Space.spaceType ma wartość SPACE.

Opcjonalne przy ustawianiu Space.spaceType na SPACE.

Wymagany w przypadku ustawienia zasady Space.spaceType na GROUP_CHAT i co najmniej 2 subskrypcji.

Wymagane, gdy Space.spaceType ma wartość DIRECT_MESSAGE wraz z człowiekiem i dokładnie 1 subskrypcją.

To pole musi być puste podczas tworzenia rozmowy 1:1 między osobą a dzwoniącą aplikacją Google Chat (gdy Space.spaceType ma wartość DIRECT_MESSAGE, a Space.singleUserBotDm na true).

Treść odpowiedzi

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.