REST Resource: spaces

Kaynak: Alan

Google Chat'te bir alan. Alanlar, iki veya daha fazla kullanıcı arasındaki görüşmeler ya da bir kullanıcı ile bir 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,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
Alanlar
name

string

Tanımlayıcı. Alan kaynağının 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 türü.
spaceType

enum (SpaceType)

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

boolean

İsteğe bağlıdır. Alan, bir Chat uygulaması ile tek bir kullanıcı arasındaki doğrudan mesajlaşma mı?
threaded
(deprecated)

boolean

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Bu alanda mesajların ileti dizisi olarak gruplandırılıp gruplandırılmadığı
displayName

string

İsteğe bağlıdır. Alanının görünen adı. SPACE spaceType ile alan oluştururken gereklidir. Alan oluştururken veya displayName güncellerken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Doğrudan mesajlarda bu alan boş olabilir.

En fazla 128 karakter desteklenir.
externalUserAllowed

boolean

İsteğe bağlıdır. Değiştirilemez. Bu alanın herhangi bir Google Chat kullanıcısının üye olmasına izin verip vermediği. Google Workspace kuruluşunda alan oluştururken girilen bilgiler. Aşağıdaki koşullarda alan oluştururken bu alanı atlayın:

  • Kimliği doğrulanan kullanıcı, tüketici hesabı (yönetilmeyen kullanıcı hesabı) kullanıyor. Varsayılan olarak, tüketici hesabı tarafından oluşturulan alanlara tüm Google Chat kullanıcıları katılabilir.

Mevcut alanlar için bu alan yalnızca çıkış amaçlıdır.
spaceThreadingState

enum (SpaceThreadingState)

Yalnızca çıkış. Chat alanındaki ileti dizisi durumu.
spaceDetails

object (SpaceDetails)

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

enum (HistoryState)

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

boolean

İsteğe bağlıdır. Bu alanın, Google Workspace'e veri taşıma işleminin bir parçası olarak Import Mode içinde oluşturulup oluşturulmadığı. Alanlar içe aktarılırken, içe aktarma işlemi tamamlanana kadar kullanıcılara görünmez.

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

string (Timestamp format)

İsteğe bağlıdır. Değiştirilemez. Chat'te oluşturulan alanlar için alanın oluşturulma zamanı. Bu alan, içe aktarma modundaki alanlarda kullanılması dışında yalnızca çıkış olarak kullanılır.

İçe aktarma modu alanları için bu alanı, orijinal oluşturma zamanını korumak amacıyla alanın kaynakta oluşturulduğu geçmiş zaman damgası olarak ayarlayın.

Yalnızca spaceType değeri 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ış. Bir Chat uygulamasıyla 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ıyla doğrudan mesaj yükleyip ayarlayabilir.

Yönetici yüklemesini desteklemek için Chat uygulamanızda doğrudan mesajlaşma özelliği bulunmalı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ıdır. Alan erişim ayarını belirtir. Yalnızca spaceType SPACE olduğunda doldurulur.
spaceUri

string

Yalnızca çıkış. Kullanıcının alana erişmek için kullanacağı URI.
importModeExpireTime

string (Timestamp format)

Yalnızca çıkış. Alan içe aktarma modunda kalırsa sistem tarafından otomatik olarak silineceği zaman.

İçe aktarma modunda oluşturulan her alan, spaces.completeImport kullanılarak bu süre dolmadan önce bu moddan çıkmalıdır.

Bu alan yalnızca içe aktarma moduyla oluşturulan alanlar için doldurulur.
customer

string

İsteğe bağlıdır. Değiştirilemez. Alan adının müşteri kimliği. Yalnızca uygulama kimlik doğrulaması ile alan oluşturulurken ve SpaceType değeri SPACE olduğunda gereklidir. Aksi takdirde ayarlanmamalıdır.

customers/{customer} biçiminde olmalıdır. Burada customer, Admin SDK müşteri kaynağındaki id değeridir. Özel uygulamalar, uygulamayla aynı Google Workspace kuruluşunda alan oluşturmak için customers/my_customer diğer adını da kullanabilir.

Bu alan, doğrudan mesajlar (DM'ler) için veya alan Google Workspace kullanıcısı olmayan kişiler tarafından oluşturulduğunda doldurulmaz.
Bir alanın izin ayarlarını temsil eder. Yalnızca space_type SPACE olduğunda doldurulur. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

Önceden tanımlanmış izin ayarlarını belirleme şu özellikleri destekler:
permissionSettings

object (PermissionSettings)

İsteğe bağlıdır. Mevcut alanlar için alan izin ayarları. Mevcut izin ayarlarının değiştirildiği, tam alan izni ayarlarını güncelleme girişi. Mevcut izin ayarlarını listeler.

İzin ayarlarını okuma ve güncelleme şu durumlarda desteklenir:
Birbirini dışlayan alanların sonu.

Tür

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

Sıralamalar
TYPE_UNSPECIFIED Ayrılmış.
ROOM İki veya daha fazla insan arasındaki sohbetler.
DM Bir insan ile bir Chat uygulaması arasındaki bire bir doğrudan mesajlaşma. Tüm mesajlar düz metin biçimindedir. Bu özelliğin, iki kullanıcı arasındaki doğrudan mesajları kapsamadığını unutmayın.

SpaceType

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

Sıralamalar
SPACE_TYPE_UNSPECIFIED Ayrılmış.
SPACE Kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı bir yerdir. SPACE, Chat uygulamalarını içerebilir.
GROUP_CHAT 3 veya daha fazla kişi arasındaki grup görüşmeleri GROUP_CHAT, Chat uygulamalarını içerebilir.
DIRECT_MESSAGE İki insan veya bir insan ile bir Chat uygulaması arasındaki 1:1 mesajlar.

SpaceThreadingState

Chat alanındaki ileti dizisi durumunun türünü belirtir.

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Ayrılmış.
THREADED_MESSAGES Mesaj dizilerini destekleyen alanlar Kullanıcılar bir mesaja yanıt verirken ileti dizisi içinde yanıtlayabilir. Bu sayede yanıtları orijinal mesajın 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

Mesaj dizilerini desteklemeyen alanlar Bu alan ileti dizisi durumu yalnızca aşağıdakiler gibi özel durumlarda kullanılır:

  • İş parçacığı oluşturmanın kasıtlı olarak devre dışı bırakıldığı kesintisiz toplantı sohbeti
  • 2022'den önce oluşturulan eski grup görüşmeleri.

SpaceDetails

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

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

string

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

En fazla 4.096 karakteri destekler.
guidelines

string

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

5.000 karaktere kadar destekler.

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ş kapalı. Mesajlar ve ileti dizileri 24 saat boyunca saklanır.
HISTORY_ON Geçmiş açık olmalıdır. Kuruluşun Apps Kasası saklama kuralları, iletilerin ve ileti dizilerinin ne kadar süreyle saklanacağını belirtir.

MembershipCount

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

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

integer

Yalnızca çıkış. Katılan bir grubun üyeliği aracılığıyla katılan kullanıcılar hariç olmak üzere, alana doğrudan katılan gerçek kullanıcıların sayısı.
joinedGroupCount

integer

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

AccessSettings

Alan erişim ayarını gösterir.

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

enum (AccessState)

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

string

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

Biçim: audiences/{audience}

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

Hedef kitleyi okuma şu özellikleri destekler:

Bu alan, uygulama kimlik doğrulaması ile chat.bot kapsamı kullanılırken doldurulmaz.

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

object (AccessPermissionSettings)

İsteğe bağlıdır. Alan için erişim izni ayarlarına erişebilirsiniz.

Alan oluştururken hedef kitleyi ayarlamak için isteğinizde accessSettings.audience alanını belirtin.

AccessState

Alan erişim durumunu gösterir.

Sıralamalar
ACCESS_STATE_UNSPECIFIED Erişim durumu bilinmiyor veya bu API'de desteklenmiyor.
PRIVATE 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ı alanı keşfedip alana erişebilir.
DISCOVERABLE

Bir alan yöneticisi, hedef kitleye alana erişim izni vermişse Alana tek tek eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı keşfedip alana erişebilir. Daha fazla bilgi için Belirli kullanıcıların alanları bulmasını sağlama başlıklı makaleyi inceleyin.

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

AccessPermissionSettings

Bir alanın izin ayarlarına erişebilirsiniz.

JSON gösterimi 
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
Alanlar
discoverSpaceSetting

object (AccessPermissionSetting)

İsteğe bağlıdır. Alan keşfi için erişim izni ayarı.
joinSpaceSetting

object (AccessPermissionSetting)

İsteğe bağlıdır. Alana katılma için erişim izni ayarı.
viewSpaceMembershipSetting

object (AccessPermissionSetting)

İsteğe bağlıdır. Alan üyeliğini görüntüleme için erişim izni ayarı. Alan üyeliğini kimlerin görüntüleyebileceği güncellenirken güncelleme maskesinde ve istek gövdesinde PermissionSettings.view_space_membership ile birlikte belirtilmelidir. Hedef kitleye görüntüleme erişimi verirken aynı istekteki tüm üyelere de PermissionSettings.view_space_membership erişimi vermeniz gerekir. Mevcut bir hedef kitleyi kaldırmak için (örneğin, görüntüleme erişimini yalnızca alan yöneticileri veya yardımcı yöneticilerle kısıtlamak için) boş bir AccessPermissionSetting belirtin (principals olmadan).

AccessPermissionSetting

Erişim izni ayarı

JSON gösterimi 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Alanlar
principals[]

object (Principal)

İsteğe bağlıdır. Sırasız liste. Bu izin için izin verilen asıl kullanıcılar.

Ana hesap

Erişim izni verilen bir tüzel kişiyi temsil eden asıl sorumlu.

JSON gösterimi 
{

  "audience": {
    object (Audience)
  }
}
Alanlar
Asıl öğenin türü. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
audience

object (Audience)

Kitle
Birbirini dışlayan alanların sonu.

Kitle

Google Chat'te hedef kitle. Hedef kitle, bir Google Workspace kuruluşundaki kullanıcı grubunu temsil eder ve bir yönetici tarafından tanımlanır. Hedef kitleler, kaynaklar için erişim ve görünürlük ayarlarını yapılandırmak amacıyla kullanılır. Örneğin, bir alanı belirli bir kullanıcı grubu tarafından bulunabilir hale getirmek için hedef kitlelerden yararlanılır.

Daha fazla bilgi için Hedef kitleler ve Bir alanı hedef kitle için bulunabilir hale getirme başlıklı makaleleri inceleyin.

JSON gösterimi 
{
  "name": string
}
Alanlar
name

string

Alanı bulabilen veya alana katılabilen hedef kitlenin kaynak adı. Ayrıntılı bilgi için Bir alanı hedef kitle için bulunabilir hale getirme başlıklı makaleyi inceleyin. Biçim: audiences/{audience}

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

PredefinedPermissionSettings

Yalnızca adlandırılmış bir alan oluştururken belirleyebileceğiniz önceden tanımlanmış izin ayarları. Gelecekte daha fazla ayar eklenebilir. Adlandırılmış alanların 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 gönderebileceği bir ortak çalışma alanı yapma ayarı.
ANNOUNCEMENT_SPACE Alanı, yalnızca alan yöneticilerinin ileti yayınlayabileceği bir duyuru alanı yapma ayarı.

PermissionSettings

Mevcut bir adlandırılmış alanı güncellerken belirleyebileceğ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)
  },
  "viewSpaceMembership": {
    object (PermissionSetting)
  }
}
Alanlar
manageMembersAndGroups

object (PermissionSetting)

İsteğe bağlıdır. Alanın üyelerini ve gruplarını yönetme ayarı
modifySpaceDetails

object (PermissionSetting)

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

object (PermissionSetting)

İsteğe bağlıdır. Alan geçmişini etkinleştirme ve devre dışı bırakma ayarı.
useAtMentionAll

object (PermissionSetting)

İsteğe bağlıdır. Bir alanda @tümü ifadesini kullanma ayarı.
manageApps

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

İsteğe bağlıdır. Alan üyeliğini görüntüleme ayarı. Alan üyeliğini kimlerin görüntüleyebileceği güncellenirken güncelleme maskesinde ve istek gövdesinde AccessPermissionSettings.view_space_membership_setting ile birlikte belirtilmelidir. Görüntüleme erişimini belirli rollerle (ör. yalnızca alan yöneticileri veya yardımcı yöneticiler) kısıtlarken istediğiniz rol izinlerini burada belirtin ve aynı istekte boş bir AccessPermissionSettings.view_space_membership_setting sağlayın. AccessPermissionSettings.view_space_membership_setting içinde bir hedef kitle yapılandırılmışsa bu ayar tüm üyelere verilmelidir.

PermissionSetting

Alan izin ayarını gösterir.

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

boolean

İsteğe bağlıdır. Alan sahiplerinin (ROLE_MANAGER) bu izne sahip olup olmadığı
membersAllowed

boolean

İsteğe bağlıdır. Temel alan üyelerinin (ROLE_MEMBER) bu izne sahip olup olmadığı.
assistantManagersAllowed

boolean

İsteğe bağlıdır. Alan yöneticilerinin ROLE_ASSISTANT_MANAGER 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 hâle 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.

findGroupChats

 spaceType == GROUP_CHAT ile tüm alanları döndürür. Bu alanların üyelikleri, tam olarak çağıran kullanıcıyı ve FindGroupChatsRequest.users içinde belirtilen kullanıcıları içerir.

get

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

list

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

patch

 Bir alanı günceller.
Google Workspace kuruluşundaki alanların listesini döndürür.

setup

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