Method: spaces.setup

Bir alan oluşturur ve belirli kullanıcıları bu alana ekler. Arayan kullanıcı otomatik olarak alana eklenir ve istekte üyelik olarak belirtilmemelidir. Örnek için Alan oluşturma bölümüne bakın.

Eklenecek insan üyeleri belirtmek için SetUpSpaceRequest içerisinde uygun member.name ile üyelik ekleyin. İnsan kullanıcı eklemek için users/{user} kullanın. Burada {user}, Kişiler API'sinde kişi için {person_id}, Admin SDK Directory API'de ise kullanıcı için id şeklindedir. Örneğin, Kişiler API'si Person resourceName people/123456789 ise member.name olarak users/123456789 üyeliğini ekleyerek kullanıcıyı alana ekleyebilirsiniz.

Bir alanda veya grup sohbetinde, arayan kişi bazı üyeleri engellerse veya engellerse bu üyeler oluşturulan alana eklenmez.

Arayan kullanıcıyla başka bir gerçek kullanıcı arasında doğrudan mesaj (DM) oluşturmak için tam olarak bir kullanıcıyı 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 oluşturmak için kullanabilirsiniz. Arama uygulamasını bir alanın üyesi veya iki gerçek kullanıcı arasında mevcut bir DM olarak eklemek için üyelik oluşturma konusuna bakın.

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

Mesaj dizisi halinde yanıtlar veya davetli erişimi olan alanlar desteklenmez.

Kullanıcı kimlik doğrulaması ve chat.spaces.create veya chat.spaces kapsamı 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 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 değerini SPACE ve Space.displayName değerini belirleyin.

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

İnsanlar arasında bire bir görüşme oluşturmak için Space.spaceType özelliğini DIRECT_MESSAGE ve Space.singleUserBotDm özelliğini false olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlamayın.

Gerçek kişi ile arayanın Chat uygulaması arasında bire bir görüşme oluşturmak için Space.spaceType ayarını DIRECT_MESSAGE, Space.singleUserBotDm özelliğini de true olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlamayın.

DIRECT_MESSAGE alanı zaten varsa yeni bir alan oluşturmak yerine ilgili alan döndürülür.

requestId

string

İsteğe bağlı. Bu istek için benzersiz bir tanımlayıcı. 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ında kimliği doğrulanmış farklı bir kullanıcıyla mevcut bir istek kimliği belirtilmesi hata döndürür.

memberships[]

object (Membership)

İsteğe bağlı. Alana katılmaya davet edilen ilk alan adı kullanıcıları grubu. Arayan kullanıcı alana otomatik olarak eklenir ve üyelik olarak belirtilmemelidir.

Grup şu anda en fazla 20 üyeye (arayana ek olarak) izin veriyor.

Membership.member alanı, name doldurulmuş ve User.Type.HUMAN değerine sahip bir kullanıcı içermelidir. Diğer tüm alanlar yoksayılır.

Space.spaceType değeri SPACE olarak ayarlandığında isteğe bağlıdır.

Space.spaceType en az iki üyelikle birlikte GROUP_CHAT olarak ayarlandığında gereklidir.

Space.spaceType ayarı, gerçek kullanıcı olan bir kullanıcıyla birlikte tam olarak bir üyelikle DIRECT_MESSAGE olarak ayarlanır.

Gerçek kişi ile arayanın Chat uygulaması arasında bire bir görüşme oluştururken Space.spaceType boş bırakılmalıdır (Space.spaceType DIRECT_MESSAGE ve Space.singleUserBotDm olarak ayarlanır).true

Desteklenmez: Misafir kullanıcıları davet etme veya başka Chat uygulamaları ekleme.

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.