Bu kılavuzda, Google Chat API'nin Space
kaynağında create()
yöntemini kullanarak nasıl adlandırılmış alan oluşturacağınız açıklanmaktadır.
Adlandırılmış alan (spaceType
simgesinin bulunduğu yer
SPACE
), kullanıcıların mesaj gönderdiği, dosya paylaştığı ve ortak çalıştığı bir yerdir.
Adlandırılmış alanlar Chat uygulamalarını içerebilir. Adlandırılmış alanlarda, yönetim ayarlarını ve açıklamalarını uygulayabilen, ayrıca kullanıcı ve uygulama ekleyip kaldırabilen alan yöneticileri bulunur.
Farklı türlerde Chat alanları (doğrudan mesajlar veya grup mesajları dahil) oluşturmak için setUp()
kaynağında Space
yöntemini kullanarak alanı oluşturun ve aynı anda üye ekleyin. Ayrıntılı bilgi için Alan oluşturma başlıklı makaleyi inceleyin.
Adlandırılmış bir alan oluşturduktan sonra, alanın tek üyesi kimliği doğrulanmış kullanıcı olur. Alana üye eklemek için eklemek istediğiniz her kişi veya uygulama için Membership
kaynağında create()
yöntemini çağırın. Dilerseniz setUp()
yöntemini kullanarak adlandırılmış bir alan oluşturabilir ve aynı anda üyeler ekleyebilirsiniz.
Ön koşullar
Node.js
- Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
- Ortamınızı ayarlayın:
- Google Cloud projesi oluşturun.
- OAuth izin ekranını yapılandırın.
- Google Chat API'yi etkinleştirin ve yapılandırın. Chat uygulamanız için ad, simge ve açıklama ekleyin.
- Node.js Cloud İstemci Kitaplığı'nı yükleyin.
- Google Chat API isteğinizde kimlik doğrulaması yapmak istediğiniz yönteme göre erişim kimlik bilgileri oluşturun:
- Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgileri oluşturun ve kimlik bilgilerini yerel dizininize
credentials.json
adlı bir JSON dosyası olarak kaydedin. - Chat uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun ve kimlik bilgilerini
credentials.json
adlı bir JSON dosyası olarak kaydedin.
- Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgileri oluşturun ve kimlik bilgilerini yerel dizininize
- Kullanıcı veya Chat uygulaması olarak kimliğinizi doğrulamak isteyip istemediğinize bağlı olarak bir yetkilendirme kapsamı seçin.
Python
- Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
- Ortamınızı ayarlayın:
- Google Cloud projesi oluşturun.
- OAuth izin ekranını yapılandırın.
- Google Chat API'yi etkinleştirin ve yapılandırın. Chat uygulamanız için ad, simge ve açıklama ekleyin.
- Python Cloud İstemci Kitaplığı'nı yükleyin.
- Google Chat API isteğinizde kimlik doğrulaması yapmak istediğiniz yönteme göre erişim kimlik bilgileri oluşturun:
- Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgileri oluşturun ve kimlik bilgilerini yerel dizininize
credentials.json
adlı bir JSON dosyası olarak kaydedin. - Chat uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun ve kimlik bilgilerini
credentials.json
adlı bir JSON dosyası olarak kaydedin.
- Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgileri oluşturun ve kimlik bilgilerini yerel dizininize
- Kullanıcı veya Chat uygulaması olarak kimliğinizi doğrulamak isteyip istemediğinize bağlı olarak bir yetkilendirme kapsamı seçin.
Java
- Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
- Ortamınızı ayarlayın:
- Google Cloud projesi oluşturun.
- OAuth izin ekranını yapılandırın.
- Google Chat API'yi etkinleştirin ve yapılandırın. Chat uygulamanız için ad, simge ve açıklama ekleyin.
- Java Cloud İstemci Kitaplığı'nı yükleyin.
- Google Chat API isteğinizde kimlik doğrulaması yapmak istediğiniz yönteme göre erişim kimlik bilgileri oluşturun:
- Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgileri oluşturun ve kimlik bilgilerini yerel dizininize
credentials.json
adlı bir JSON dosyası olarak kaydedin. - Chat uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun ve kimlik bilgilerini
credentials.json
adlı bir JSON dosyası olarak kaydedin.
- Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgileri oluşturun ve kimlik bilgilerini yerel dizininize
- Kullanıcı veya Chat uygulaması olarak kimliğinizi doğrulamak isteyip istemediğinize bağlı olarak bir yetkilendirme kapsamı seçin.
Apps Komut Dosyası
- Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.
- Ortamınızı ayarlayın:
- Google Cloud projesi oluşturun.
- OAuth izin ekranını yapılandırın.
- Google Chat API'yi etkinleştirin ve yapılandırın. Chat uygulamanız için ad, simge ve açıklama ekleyin.
- Bağımsız bir Apps Komut Dosyası projesi oluşturun ve Gelişmiş Chat Hizmeti'ni etkinleştirin.
- Bu kılavuzda kullanıcı veya uygulama kimlik doğrulamasını kullanmanız gerekir. Sohbet uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun. Adımlar için Google Chat uygulaması olarak kimlik doğrulama ve yetkilendirme başlıklı makaleyi inceleyin.
- Kullanıcı veya Chat uygulaması olarak kimliğinizi doğrulamak isteyip istemediğinize bağlı olarak bir yetkilendirme kapsamı seçin.
Kullanıcı olarak adlandırılmış alan oluşturma
Kullanıcı kimlik doğrulaması ile adlandırılmış bir alan oluşturmak için isteğinizde aşağıdakileri iletin:
chat.spaces.create
veyachat.spaces
yetkilendirme kapsamını belirtin.- Aşağıdaki alanlarla
space
öğesiniSpace
örneği olarak ileterekCreateSpace()
yöntemini çağırın:spaceType
şu değere ayarlandı:SPACE
.displayName
, alanın kullanıcı tarafından görülebilen adıyla ayarlanır.- İsteğe bağlı olarak, aşağıdaki gibi diğer özellikleri ayarlayın:
spaceDetails
- Alanla ilgili, kullanıcı tarafından görülebilen bir açıklama ve yönergeler.predefinedPermissionSettings
: Alan için önceden tanımlanmış izinler. Örneğin, tüm üyelerin veya yalnızca alan yöneticilerinin mesaj yayınlayabileceği şekilde yapılandırabilirsiniz.
Adlandırılmış alan oluşturmak için:
Node.js
Python
Java
Apps Komut Dosyası
Chat uygulaması olarak adlandırılmış alan oluşturma
Uygulama kimlik doğrulaması için tek seferlik yönetici onayı gerekir.
Uygulama kimlik doğrulaması olan bir alana kullanıcı davet etmek veya eklemek için isteğinizde aşağıdakileri iletin:
chat.app.spaces.create
veyachat.app.spaces
yetkilendirme kapsamını belirtin.Space
kaynağındacreate
yöntemini çağırın.spaceType
değeriniSPACE
olarak ayarlayın.displayName
değerini, alanın kullanıcı tarafından görülebilen adıyla değiştirin. Aşağıdaki örnekte,displayName
API-made
olarak ayarlanmıştır.customer
alanını kullanarak Google Workspace alanının müşteri kimliğini belirtin.- İsteğe bağlı olarak, diğer alan özelliklerini ayarlayın (ör.
spaceDetails
(alan için kullanıcı tarafından görülebilen açıklama ve yönergeler).
API anahtarı oluşturma
Bir geliştirici önizlemesi API yöntemini çağırmak için API bulma belgesinin herkese açık olmayan bir geliştirici önizlemesi sürümünü kullanmanız gerekir. İsteğin kimliğini doğrulamak için bir API anahtarı iletmeniz gerekir.
API anahtarı oluşturmak için uygulamanızın Google Cloud projesini açın ve aşağıdakileri yapın:
- Google Cloud Console'da Menü > API'ler ve Hizmetler > Kimlik Bilgileri'ne gidin.
- Kimlik bilgileri oluştur > API anahtarı'nı tıklayın.
- Yeni API anahtarınız gösterilir.
- Uygulamanızın kodunda kullanmak üzere API anahtarınızı kopyalamak için Kopyala'yı tıklayın. API anahtarı, projenizin kimlik bilgilerinin "API anahtarları" bölümünde de bulunabilir.
- Gelişmiş ayarları güncellemek ve API anahtarınızın kullanımını sınırlamak için Anahtarı kısıtla'yı tıklayın. Daha fazla bilgi için API anahtarı kısıtlamaları uygulama başlıklı makaleyi inceleyin.
Chat API'yi çağıran bir komut dosyası yazma
Adlandırılmış alan oluşturmak için:
Python
- Çalışma dizininizde
chat_space_create_named_app.py
adlı bir dosya oluşturun. chat_space_create_named_app.py
'ya aşağıdaki kodu ekleyin:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
Koddaki aşağıdaki yerleri değiştirin:
API_KEY
: Chat API için hizmet uç noktası oluşturmak üzere oluşturduğunuz API anahtarı.CUSTOMER
: Alanın müşteri kimliği,customer/{customer}
biçiminde. Burada{customer}
,ID
değeridir. Admin SDK müşteri kaynağındaki. Chat uygulamasıyla aynı Google Workspace kuruluşunda alan oluşturmak içincustomers/my_customer
simgesini kullanın.
Çalışma dizininizde örneği oluşturun ve çalıştırın:
python3 chat_space_create_named_app.py
Google Chat'te alanı açma
Alana gitmek için alanın URL'sini oluştururken alanın kaynak kimliğini kullanın. Kaynak kimliğini, Google Chat yanıt gövdesindeki alan name
bölümünde bulabilirsiniz. Örneğin, alanınızın name
değeri spaces/1234567
ise aşağıdaki URL'yi kullanarak alana gidebilirsiniz: https://mail.google.com/chat/u/0/#chat/space/1234567
.
Sınırlamalar ve dikkat edilmesi gereken noktalar
- Uygulama kimlik doğrulaması kullanarak alan oluşturduğunuzda, kimlik doğrulayan Chat uygulaması alanın üyesi olarak eklenir ancak kullanıcı kimlik doğrulamasının aksine alan yöneticisi olarak eklenmez. Varsayılan olarak, tüm alan üyeleri Chat uygulamasını kaldırabilir. Yalnızca alan yöneticilerinin Chat uygulamasını kaldırmasına izin vermek için
permissionSettings.manageApps
seçeneğinimanagersAllowed
olarak ayarlayın.
İlgili konular
- Üye oluşturarak alana kullanıcı ve uygulama ekleme
- Mesaj oluşturarak alanda mesaj yayınlayın.
- Bir alan hakkında ayrıntılı bilgi edinin.
- Alanları listeleme.
- Bir alanı güncelleme
- Alan silme
- Alan oluşturma
- Doğrudan mesaj alanını bulma
- Belirli kullanıcıların alanları bulabilmesini sağlama