REST Resource: spaces

Kaynak: Space

Google Chat'teki bir alan. Alanlar, iki veya daha fazla kullanıcı arasındaki görüşmeler ya da bir kullanıcı ile Chat uygulaması arasındaki bire bir mesajlardır.

JSON gösterimi 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Alanlar
name

string

Tanımlayıcı. Alanın kaynak adı.

Biçim: spaces/{space}

Burada {space}, alana sistem tarafından atanan kimliği temsil eder. Alan kimliğini spaces.list() yöntemini çağırarak veya alan URL'sinden alabilirsiniz. Örneğin, alan URL'si https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA ise alan kimliği AAAAAAAAA olur.
type
(deprecated)

enum (Type)

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceType kullanın. Alanın türü.
spaceType

enum (SpaceType)

İsteğe bağlı. Alanın türü. Alan oluştururken veya alanın alan türünü güncellerken gereklidir. Yalnızca diğer kullanımlar için çıkış.
singleUserBotDm

boolean

İsteğe bağlı. Alanın, bir Chat uygulaması ile tek bir kullanıcı arasında doğrudan mesaj olup olmadığı.
threaded
(deprecated)

boolean

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Bu alanda mesajların dizili olup olmadığı.
displayName

string

İsteğe bağlı. Alanın görünen adı. SPACE spaceType değerine sahip bir alan oluştururken gereklidir. Alan oluştururken veya displayName'yi güncellerken 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.

Doğrudan mesajlarda bu alan boş olabilir.

En fazla 128 karakter destekler.
externalUserAllowed

boolean

İsteğe bağlı. Değişmez. Bu alanın, Google Chat kullanıcılarının üye olmasına izin verip vermediği. Google Workspace kuruluşunda alan oluştururken girilen giriş. Aşağıdaki koşullarda alan oluştururken bu alanı atlayın:

  • Kimliği doğrulanmış kullanıcı bir tüketici hesabı (yönetilmeyen kullanıcı hesabı) kullanıyor. Tüketici hesabı tarafından oluşturulan alanlar varsayılan olarak tüm Google Chat kullanıcılarına izin verir.

Mevcut alanlar için bu alan yalnızca çıkıştır.
spaceThreadingState

enum (SpaceThreadingState)

Yalnızca çıkış. Chat alanındaki mesaj dizili mesaj durumu.
spaceDetails

object (SpaceDetails)

İsteğe bağlı. Açıklama ve kurallar dahil olmak üzere alanla ilgili ayrıntılar.
spaceHistoryState

enum (HistoryState)

İsteğe bağlı. Bu alandaki mesajlar ve ileti dizileri için mesaj geçmişi durumu.
importMode

boolean

İsteğe bağlı. Bu alanın, Google Workspace'e veri taşıma işlemi kapsamında Import Mode'te oluşturulup oluşturulmadığı. Alanlar içe aktarılırken içe aktarma işlemi tamamlanana kadar kullanıcılar tarafından görülemez.

Import Mode'te alan oluşturmak için kullanıcı kimlik doğrulaması gerekir.
createTime

string (Timestamp format)

İsteğe bağlı. Değişmez. Chat'te oluşturulan alanlar için alanın oluşturulduğu saat. Bu alan, içe aktarma modu alanlarında kullanıldığında hariç olmak üzere yalnızca çıkış içindir.

İçe aktarma modundaki alanlar için bu alanı, orijinal oluşturma zamanını korumak amacıyla alanın kaynakta oluşturulduğu tarih damgasına ayarlayın.

Yalnızca spaceType GROUP_CHAT veya SPACE olduğunda çıkışta doldurulur.
lastActiveTime

string (Timestamp format)

Yalnızca çıkış. Alandaki son mesajın zaman damgası.
adminInstalled

boolean

Yalnızca çıkış. Chat uygulaması içeren doğrudan mesaj (DM) alanları için alanın bir Google Workspace yöneticisi tarafından oluşturulup oluşturulmadığı. Yöneticiler, kuruluşlarındaki kullanıcılar adına Chat uygulamasını yükleyip doğrudan mesaj ayarlayabilir.

Yönetici yüklemesini desteklemek için Chat uygulamanızda doğrudan mesajlaşma özelliği olmalıdır.
membershipCount

object (MembershipCount)

Yalnızca çıkış. Üye türüne göre gruplandırılmış, katılan üyeliklerin sayısı. spaceType SPACE, DIRECT_MESSAGE veya GROUP_CHAT olduğunda doldurulur.
accessSettings

object (AccessSettings)

İsteğe bağlı. Alanın erişim ayarını belirtir. Yalnızca spaceType SPACE olduğunda doldurulur.
spaceUri

string

Yalnızca çıkış. Kullanıcının alana erişmesi için URI.
customer

string

İsteğe bağlı. Değişmez. Alanın müşteri kimliği. Yalnızca uygulama kimlik doğrulamasıyla alan oluştururken ve SpaceType SPACE ise gereklidir. Aksi takdirde ayarlanmamalıdır.

customers/{customer} biçimindedir. Burada customer, [Admin SDK müşteri kaynağındaki]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) id değeridir. Gizli uygulamalar, alanı uygulamayla aynı Google Workspace kuruluşunda oluşturmak için customers/my_customer takma adını da kullanabilir.

DM'ler için bu alan doldurulmaz.

Birlik alanı space_permission_settings. Bir alanın izin ayarlarını temsil eder. Yalnızca space_type SPACE olduğunda doldurulur.

Kullanıcı kimlik doğrulaması gerektirir. space_permission_settings yalnızca aşağıdakilerden biri olabilir:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

İsteğe bağlı. Yalnızca giriş. Önceden tanımlanmış alan izni ayarları, yalnızca alan oluştururken girilir. Alan ayarlanmamışsa bir ortak çalışma alanı oluşturulur. Alanı oluşturduktan sonra ayarlar PermissionSettings alanına doldurulur.
permissionSettings

object (PermissionSettings)

İsteğe bağlı. Mevcut alanlar için alan izni ayarları. Mevcut izin ayarlarının değiştirildiği tam alan izin ayarlarını güncellemek için giriş. Çıkışta mevcut izin ayarları listelenir.

Tür

Desteği sonlandırıldı: Bunun yerine SpaceType kullanın.

Sıralamalar
TYPE_UNSPECIFIED Rezerve edildi.
ROOM İki veya daha fazla kişi arasındaki konuşmalar.
DM Bir kullanıcı ile Chat uygulaması arasında gerçekleşen ve tüm mesajların düz olduğu 1:1 Doğrudan Mesaj. Bu, iki kullanıcı arasındaki doğrudan mesajları kapsamaz.

SpaceType

Alanın türü. Alan oluştururken veya güncellerken gereklidir. Yalnızca diğer kullanımlar için çıkış.

Sıralamalar
SPACE_TYPE_UNSPECIFIED Rezerve.
SPACE Kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı bir yerdir. SPACE, Chat uygulamaları içerebilir.
GROUP_CHAT 3 veya daha fazla kullanıcının yer aldığı grup görüşmeleri. GROUP_CHAT, Chat uygulamaları içerebilir.
DIRECT_MESSAGE İki gerçek kullanıcı veya bir gerçek kullanıcı ile Chat uygulaması arasında gerçekleşen 1:1 mesajlar.

SpaceThreadingState

Chat alanındaki mesaj dizilişi durumunun türünü belirtir.

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Rezerve edildi.
THREADED_MESSAGES İleti dizilerini destekleyen adlandırılmış alanlar. Kullanıcılar bir iletiyi yanıtlarken ileti dizisinde yanıt verebilir. Bu sayede, yanıtları orijinal ileti bağlamında kalır.
GROUPED_MESSAGES Görüşmenin konuya göre düzenlendiği adlandırılmış alanlar. Konular ve yanıtları birlikte gruplandırılır.
UNTHREADED_MESSAGES İki kişi arasındaki doğrudan mesajlar (DM'ler) ve 3 veya daha fazla kişi arasındaki grup görüşmeleri.

SpaceDetails

Açıklama ve kurallar dahil olmak üzere alanla ilgili ayrıntılar.

JSON gösterimi 
{
  "description": string,
  "guidelines": string
}
Alanlar
description

string

İsteğe bağlı. Alanın açıklaması. Örneğin, alanın tartışma konusunu, işlevsel amacını veya katılımcılarını açıklayın.

En fazla 150 karakter desteklenir.
guidelines

string

İsteğe bağlı. Alanın kuralları, beklentileri ve görgü kuralları.

En fazla 5.000 karakter desteklenir.

HistoryState

Mesajlar ve alanlar için geçmiş durumu. İletilerin ve ileti dizilerinin oluşturulduktan sonra ne kadar süreyle saklanacağını belirtir.

Sıralamalar
HISTORY_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
HISTORY_OFF Geçmişe kayıt kapalı. Mesajlar ve ileti dizileri 24 saat boyunca saklanır.
HISTORY_ON Geçmişe kayıt açık. Kuruluşun Apps Kasası saklama kuralları, iletilerin ve ileti dizilerinin ne kadar süre saklanacağını belirtir.

MembershipCount

Bir alanın üyelik sayısını kategorilere göre gruplandırılmış olarak gösterir.

JSON gösterimi 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Alanlar
joinedDirectHumanUserCount

integer

Yalnızca çıkış. Bir gruba üye olarak katılan kullanıcılar hariç, alana doğrudan katılan gerçek kullanıcıların sayısı.
joinedGroupCount

integer

Yalnızca çıkış. Doğrudan alana katılan tüm grupların sayısı.

AccessSettings

Alanın erişim ayarını temsil eder.

JSON gösterimi 
{
  "accessState": enum (AccessState),
  "audience": string
}
Alanlar
accessState

enum (AccessState)

Yalnızca çıkış. Alanın erişim durumunu gösterir.
audience

string

İsteğe bağlı. Alanı keşfedebilen, alana katılabilen ve alandaki mesajları önizleyebilen hedef kitlenin kaynak adı. Bu ayar devre dışıysa alana yalnızca tek tek davet edilen veya alana eklenen kullanıcılar ya da Google Gruplar erişebilir. Ayrıntılı bilgi için Bir alanı hedef kitle için keşfedilebilir hale getirme başlıklı makaleyi inceleyin.

Biçim: audiences/{audience}

Google Workspace kuruluşu için varsayılan hedef kitleyi kullanmak istiyorsanız audiences/default olarak ayarlayın.

Hedef kitleyi okuma özelliği şunları destekler:

chat.bot kapsamı uygulama kimlik doğrulamasıyla kullanıldığında bu alan doldurulmaz.

Hedef kitleyi ayarlamak için kullanıcı kimlik doğrulaması gerekir.

AccessState

Alanın erişim durumunu gösterir.

Sıralamalar
ACCESS_STATE_UNSPECIFIED Erişim durumu bilinmiyor veya bu API'de desteklenmiyor.
PRIVATE Alanı yalnızca diğer kullanıcılar veya Google Workspace yöneticileri tarafından tek tek eklenen ya da davet edilen kullanıcılar veya Google Grupları keşfedebilir ve alana erişebilir.
DISCOVERABLE

Alan yöneticisi, bir hedef kitleye alana erişim izni verdiyse. Alana ayrı ayrı eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı bulup erişebilir. Daha fazla bilgi edinmek için Alanları belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

Herkese açık alanlar oluşturmak için kullanıcı kimlik doğrulaması gerekir.

PredefinedPermissionSettings

Yalnızca adlandırılmış bir alan oluştururken belirtebileceğiniz önceden tanımlanmış izin ayarları. Gelecekte daha fazla ayar eklenebilir. Adlandırılmış alanlarla ilgili izin ayarları hakkında ayrıntılı bilgi için Alanlar hakkında başlıklı makaleyi inceleyin.

Sıralamalar
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Belirtilmedi. Kullanmayın.
COLLABORATION_SPACE Alanı tüm üyelerin mesaj yayınlayabileceği bir ortak çalışma alanı haline getirme ayarı.
ANNOUNCEMENT_SPACE Alanı yalnızca alan yöneticilerinin mesaj yayınlayabileceği bir duyuru alanı haline getirme ayarı.

PermissionSettings

Mevcut bir adlandırılmış alanı güncellerken belirtebileceğiniz izin ayarları.

Alan oluştururken izin ayarlarını belirlemek için isteğinizde PredefinedPermissionSettings alanını belirtin.

JSON gösterimi 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Alanlar
manageMembersAndGroups

object (PermissionSetting)

İsteğe bağlı. Bir alandaki üyeleri ve grupları yönetme ayarı.
modifySpaceDetails

object (PermissionSetting)

İsteğe bağlı. Alan adını, avatarını, açıklamasını ve yönergelerini güncelleme ayarı.
toggleHistory

object (PermissionSetting)

İsteğe bağlı. Alan geçmişini etkinleştirmek veya devre dışı bırakmak için kullanılan ayar.
useAtMentionAll

object (PermissionSetting)

İsteğe bağlı. Bir alanda @all ifadesini kullanma ayarı.
manageApps

object (PermissionSetting)

İsteğe bağlı. Alandaki uygulamaları yönetme ayarı.
manageWebhooks

object (PermissionSetting)

İsteğe bağlı. Alandaki webhook'ları yönetme ayarı.
postMessages

object (PermissionSetting)

Yalnızca çıkış. Alanda mesaj yayınlama ayarı.
replyMessages

object (PermissionSetting)

İsteğe bağlı. Alandaki mesajları yanıtlama ayarı.

PermissionSetting

Alan izin ayarını temsil eder.

JSON gösterimi 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Alanlar
managersAllowed

boolean

İsteğe bağlı. Alan yöneticilerinin bu izne sahip olup olmadığı.
membersAllowed

boolean

İsteğe bağlı. Yönetici olmayan üyelerin bu izne sahip olup olmadığı.

Yöntemler

completeImport

 Belirtilen alan için içe aktarma işlemini tamamlar ve alanı kullanıcılara görünür hale getirir.

create

 Alan oluşturur.

delete

 Adlandırılmış bir alanı siler.

findDirectMessage

 Belirtilen kullanıcıyla mevcut doğrudan mesajı döndürür.

get

 Bir alanla ilgili ayrıntıları döndürür.

list

 Arayanın üyesi olduğu alanları listeler.

patch

 Alanları günceller.
Yöneticinin yaptığı aramaya göre Google Workspace kuruluşundaki alanların listesini döndürür.

setup

 Bir alan oluşturur ve belirtilen kullanıcıları bu alana ekler.