Method: spaces.setup

Bir alan oluşturur ve belirtilen kullanıcıları alana ekler. Arayan kullanıcı otomatik olarak alana eklenir ve istekte üyelik olarak belirtilmemelidir. Örneğin, İlk üyelerle alan oluşturma başlıklı makaleyi inceleyin.

Eklenecek gerçek üyeleri belirtmek için SetUpSpaceRequest içinde uygun member.name ile üyelik ekleyin. Gerçek bir kullanıcı eklemek için users/{user} biçimini kullanın. Burada {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki {user}, People API'deki kişinin id veya Directory API'deki kullanıcının id rolü de olabilir. Örneğin, user@example.com için People API Kişi profili kimliği 123456789 ise membership.member.name değerini users/user@example.com veya users/123456789 olarak ayarlayarak kullanıcıyı alana ekleyebilirsiniz.

Alan veya grup sohbeti söz konusu olduğunda, arayan kişi bazı üyeler tarafından veya bazı üyeler tarafından engellenirse söz konusu üyeler oluşturulan alana eklenmez.

Arayan kullanıcı ile diğer bir gerçek kullanıcı arasında doğrudan mesaj (DM) oluşturmak için, gerçek kullanıcıyı temsil edecek tam bir üyelik belirtin. Bir kullanıcı diğerini engellerse istek başarısız olur ve DM oluşturulmaz.

Arayan kullanıcı ile arama uygulaması arasında bir DM oluşturmak için Space.singleUserBotDm öğesini true olarak ayarlayın ve herhangi bir üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla bir DM ayarlamak için kullanabilirsiniz. Arama uygulamasını bir alanın veya iki gerçek kullanıcı arasındaki mevcut bir DM'nin üyesi olarak eklemek için Bir kullanıcıyı veya uygulamayı bir alana davet etme ya da ekleme başlıklı makaleyi inceleyin.

İki kullanıcı arasında zaten bir DM varsa, istek yapıldığında bir kullanıcı diğerini engellese bile mevcut DM döndürülür.

Mesaj dizili yanıtlar içeren alanlar desteklenmez. Alan ayarlarken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan, bu görünen adı zaten kullanıyor olabilir.

Kullanıcı kimlik doğrulaması gerektirir.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Alanlar
space

object (Space)

Zorunlu. Space.spaceType alanı zorunludur.

Alan oluşturmak için Space.spaceType öğesini SPACE olarak ayarlayın ve Space.displayName olarak ayarlayın. Alan ayarlarken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan, bu görünen adı zaten kullanıyor olabilir.

Grup sohbeti oluşturmak için Space.spaceType değerini GROUP_CHAT olarak ayarlayın. Space.displayName olarak ayarlamayın.

Kullanıcılar arasında 1:1 görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise false olarak ayarlayın. Space.displayName veya Space.spaceDetails olarak ayarlamayın.

Gerçek kişi ile sesli arama yapan Chat uygulaması arasında 1:1 görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm ayarını ise true yapın. Space.displayName veya Space.spaceDetails olarak ayarlamayın.

DIRECT_MESSAGE alanı zaten varsa yeni bir alan oluşturulması yerine söz konusu alan döndürülür.
requestId

string

İsteğe bağlı. Bu isteğin benzersiz tanımlayıcısı. Rastgele bir UUID önerilir. Mevcut bir istek kimliği belirtildiğinde, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alan döndürülür. Aynı Chat uygulamasından, kimliği doğrulanmış farklı bir kullanıcıyla mevcut bir istek kimliğinin belirtilmesi hata döndürür.
memberships[]

object (Membership)

İsteğe bağlı. Alana katılmaya davet edilecek Google Chat kullanıcıları. Otomatik olarak eklendiği için arayan kullanıcıyı atlayın.

Grup şu anda 20 adede kadar üyeliğe (arayana ek olarak) izin vermektedir.

Membership.member alanı, name doldurulmuş (biçim: users/{user}) ve type değeri User.Type.HUMAN olarak ayarlanmış bir user içermelidir. Yalnızca alan oluştururken gerçek kullanıcı ekleyebilirsiniz (Chat uygulaması ekleme işlemi yalnızca arama uygulamasıyla doğrudan mesaj kurulumunda desteklenir). Ayrıca, {kullanıcı} için bir takma ad olarak kullanıcının e-posta adresini kullanarak üye ekleyebilirsiniz. Örneğin, user.name değeri users/example@gmail.com olabilir." Gmail veya harici Google Workspace alanlarından kullanıcı davet etmek istiyorsanız {user} için kullanıcının e-posta adresi kullanılmalıdır.

Space.spaceType, SPACE olarak ayarlanırken isteğe bağlıdır.

Space.spaceType, en az iki üyelikle birlikte GROUP_CHAT olarak ayarlanırken gereklidir.

Space.spaceType bir insan kullanıcı ile ve tam olarak bir üyelikle DIRECT_MESSAGE olarak ayarlanırken gereklidir.

Gerçek kişi ile çağrı yapan Chat uygulaması arasında 1:1 görüşme oluşturulurken (Space.spaceType değeri DIRECT_MESSAGE, Space.singleUserBotDm ayarı true olarak ayarlandığında) boş olmalıdır.

Yanıt gövdesi

Başarılıysa yanıt metni, Space öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.