Method: spaces.setup

Bir alan oluşturur ve belirtilen kullanıcıları bu alana ekler. Arayan kullanıcı alana otomatik olarak eklenir ve istekte üyelik olarak belirtilmemelidir. Örnek için İlk üyeleri olan bir alan oluşturma başlıklı makaleyi inceleyin.

Eklenecek gerçek kullanıcıları belirtmek için uygun membership.member.name ile üyelikler ekleyin. Gerçek kullanıcı eklemek için users/{user} değerini kullanın. {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki kullanıcılar için {user}, People API'deki kullanıcının id veya Directory API'deki kullanıcının id değeri 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.

Eklenecek Google gruplarını belirtmek için uygun membership.group_member.name ile üyelikler ekleyin. Google grubu eklemek veya davet etmek için groups/{group} değerini kullanın. Burada {group}, Cloud Identity Groups API'deki grup için id değeridir. Örneğin, group@example.com grup e-postası için 123456789 kimliğini almak üzere Cloud Identity Groups lookup API'yi kullanabilir, ardından membership.group_member.name değerini groups/123456789 olarak ayarlayarak grubu alana ekleyebilirsiniz. Grup e-postaları desteklenmez ve Google grupları yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Adlandırılmış bir alan veya grup sohbetinde, arayan kullanıcı bazı üyeleri engellerse ya da bazı üyeler tarafından engellenirse ya da bazı üyeleri ekleme izni yoksa bu üyeler oluşturulan alana eklenmez.

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

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

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

Mesaj dizili yanıtların bulunduğu alanlar desteklenmez. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşunda 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

İstek metni aşağıdaki yapıyla birlikte verileri 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'ü SPACE olarak ayarlayın ve Space.displayName'yi ayarlayın. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşunda mevcut bir alan bu görünen adı zaten kullanıyor olabilir.

Grup sohbeti oluşturmak için Space.spaceType'ü GROUP_CHAT olarak ayarlayın. Space.displayName ayarını yapmayı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 ayarlanamaz.

Bir kullanıcı ile Chat uygulaması arasında 1:1 görüşme oluşturmak için Space.spaceType'ü DIRECT_MESSAGE, Space.singleUserBotDm'yi ise true olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlanamaz.

Halihazırda bir DIRECT_MESSAGE alanı varsa yeni bir alan oluşturmak yerine bu alan döndürülür.
requestId

string

İsteğe bağlı. Bu istek için benzersiz bir tanımlayıcı. Rastgele bir UUID kullanılması önerilir. Mevcut bir istek kimliği belirtmek, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alanı döndürür. Aynı Chat uygulamasında kimliği doğrulanmış farklı bir kullanıcının mevcut istek kimliğini belirtmek hata döndürür.
memberships[]

object (Membership)

İsteğe bağlı. Alana katılmaya davet edilecek Google Chat kullanıcıları veya grupları. Arayan kullanıcı otomatik olarak ekleneceğinden bu kullanıcıyı atlayın.

Grup şu anda arayana ek olarak en fazla 49 üyeliğe izin veriyor.

Kullanıcı üyeliği için Membership.member alanında, name doldurulmuş (biçim: users/{user}) ve type User.Type.HUMAN olarak ayarlanmış bir user bulunmalıdır. Yalnızca alan oluştururken gerçek kullanıcıları ekleyebilirsiniz (Chat uygulamalarının eklenmesi yalnızca arama uygulamasıyla doğrudan mesaj oluşturma için desteklenir). {user} için takma ad olarak kullanıcının e-posta adresini kullanarak da üye ekleyebilirsiniz. Örneğin, user.name users/example@gmail.com olabilir. Gmail kullanıcılarını veya harici Google Workspace alanlarındaki kullanıcıları davet etmek için {user} parametresinde kullanıcının e-postası kullanılmalıdır.

Google grubu üyeliği için Membership.group_member alanında, name değerinin doldurulduğu bir group bulunmalıdır (groups/{group} biçimi). Yalnızca Space.spaceType'i SPACE olarak ayarlarken Google grupları ekleyebilirsiniz.

Space.spaceType öğesi SPACE olarak ayarlandığında isteğe bağlıdır.

Space.spaceType değerini GROUP_CHAT olarak ayarlama işleminde en az iki üyelikle birlikte gereklidir.

Tam olarak bir üyelikle birlikte gerçek bir kullanıcıyla Space.spaceType'ü DIRECT_MESSAGE olarak ayarlama sırasında gereklidir.

Bir kullanıcı ile arayan Chat uygulaması arasında 1:1 görüşme oluştururken boş olmalıdır (Space.spaceType DIRECT_MESSAGE, Space.singleUserBotDm ise true olarak ayarlandığında).

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ılavuzuna bakın.