Bu kılavuzda, Google Chat API'nin Message
kaynağındaki get()
yönteminin, metin veya kart mesajıyla ilgili ayrıntıları döndürmek için nasıl kullanılacağı açıklanmaktadır.
Chat API'de Chat mesajı, Message
kaynağı ile temsil edilir.
Chat kullanıcıları yalnızca metin içeren mesajlar gönderebilirken Chat uygulamaları, statik veya etkileşimli kullanıcı arayüzleri görüntüleme, kullanıcılardan bilgi toplama ve mesajları gizli olarak iletme gibi birçok başka mesajlaşma özelliğini kullanabilir. Chat API'de kullanılabilen mesajlaşma özellikleri hakkında daha fazla bilgi edinmek için Google Chat mesajlarına genel bakış başlıklı makaleyi inceleyin.
Ö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.
- Kimliği doğrulanmış kullanıcının veya arama yapan Chat uygulamasının üyesi olduğu bir Google Chat alanı. Chat uygulaması olarak kimlik doğrulamak için Chat uygulamasını alana ekleyin.
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.
- Kimliği doğrulanmış kullanıcının veya arama yapan Chat uygulamasının üyesi olduğu bir Google Chat alanı. Chat uygulaması olarak kimlik doğrulamak için Chat uygulamasını alana ekleyin.
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.
- Kimliği doğrulanmış kullanıcının veya arama yapan Chat uygulamasının üyesi olduğu bir Google Chat alanı. Chat uygulaması olarak kimlik doğrulamak için Chat uygulamasını alana ekleyin.
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.
- Kimliği doğrulanmış kullanıcının veya arama yapan Chat uygulamasının üyesi olduğu bir Google Chat alanı. Chat uygulaması olarak kimlik doğrulamak için Chat uygulamasını alana ekleyin.
Kullanıcı kimlik doğrulaması içeren mesaj alma
Kullanıcı kimlik doğrulaması içeren bir iletiyle ilgili ayrıntıları almak için isteğinizde aşağıdakileri iletin:
chat.messages.readonly
veyachat.messages
yetkilendirme kapsamını belirtin.GetMessage()
yöntemini çağırın.name
değerini, alınacak mesajın kaynak adı olarak ayarlayın.
Aşağıdaki örnekte, kullanıcı kimlik doğrulaması içeren bir ileti alınmaktadır:
Node.js
Python
Java
Apps Komut Dosyası
Bu örneği çalıştırmak için aşağıdakileri değiştirin:
SPACE_NAME
: Alanınname
kimliği. Kimliği,ListSpaces()
yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.MESSAGE_NAME
: İletininname
bölümündeki kimlik. Kimliği, Chat API ile asenkron olarak mesaj oluşturduktan sonra döndürülen yanıt gövdesinden veya oluşturma sırasında mesaja atanan özel adla alabilirsiniz.
Chat API, belirtilen iletiyi ayrıntılandıran bir Message
örneği döndürür.
Uygulama kimlik doğrulamasıyla ilgili mesaj alma
Uygulama kimlik doğrulaması içeren bir mesajla ilgili ayrıntılı bilgi edinmek için isteğinizde aşağıdakileri iletin:
- Yetkilendirme kapsamı belirtin. Bu bölümdeki örneklerde, genel kullanıma sunulan ve yönetici onayı gerektirmeyen
chat.bot
kapsamı kullanılmaktadır. Alternatif olarak, geliştirici önizlemesinde kullanılabilen yönetici onayıyla Chat uygulaması olarak yetkilendirme seçeneğini kullanabilirsiniz. GetMessage()
yöntemini çağırın.name
değerini, alınacak mesajın kaynak adı olarak ayarlayın.
Aşağıdaki örnekte, uygulama kimlik doğrulaması içeren bir ileti alınmaktadır:
Node.js
Python
Java
Apps Komut Dosyası
Bu örneği çalıştırmak için aşağıdakileri değiştirin:
SPACE_NAME
: Alanınname
kimliği. Kimliği,ListSpaces()
yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.MESSAGE_NAME
: İletininname
bölümündeki kimlik. Kimliği, Chat API ile asenkron olarak mesaj oluşturduktan sonra döndürülen yanıt gövdesinden veya oluşturma sırasında mesaja atanan özel adla alabilirsiniz.
Chat API, belirtilen iletiyi ayrıntılandıran bir Message
örneği döndürür.
Yönetici onayıyla Chat uygulaması olarak mesaj alma
chat.app.*
yetkilendirme kapsamıyla uygulama kimlik doğrulaması için tek seferlik yönetici onayı gerekir.
Chat REST API'yi kullanarak uygulama kimlik doğrulaması ile ilgili mesaj hakkında ayrıntılı bilgi almak için isteğinizde aşağıdakileri iletin:
GetMessage()
yöntemini çağırın.chat.app.messages.readonly
yetkilendirme kapsamını belirtin.name
değerini, alınacak mesajın kaynak adı olarak ayarlayın.
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ını, projenizin kimlik bilgilerinin "API Anahtarları" bölümünde de bulabilirsiniz.
- Yetkisiz kullanımı önlemek için API anahtarının nerede ve hangi API'ler için kullanılabileceğini kısıtlamanızı öneririz. Daha fazla bilgi için API kısıtlamaları ekleme başlıklı makaleyi inceleyin.
Chat API'yi çağıran bir komut dosyası yazma
Uygulama kimlik doğrulaması ve yönetici onayı ile Chat REST API kullanılarak gönderilen mesajlarla ilgili ayrıntıları nasıl alacağınızı aşağıda bulabilirsiniz:
Python
- Çalışma dizininizde
chat_messages_get_admin_app.py
adlı bir dosya oluşturun. chat_messages_get_admin_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.messages.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then gets details about a message. ''' # 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().messages().get( # The message to get details about. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/messages/MESSAGE_NAME', ).execute() # Print Chat API's response in your command line interface. 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ı.SPACE_NAME
: Alanınname
kimliği. Kimliği,ListSpaces()
yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.MESSAGE_NAME
: İletininname
bölümündeki kimlik. Kimliği, Chat API ile asenkron olarak mesaj oluşturduktan sonra döndürülen yanıt gövdesinden veya oluşturma sırasında mesaja atanan özel ad ile alabilirsiniz.
Çalışma dizininizde örneği oluşturun ve çalıştırın:
python3 chat_messages_get_admin_app.py
Chat API, belirtilen iletiyi ayrıntılandıran bir Message
örneği döndürür.
İlgili konular
- İletileri biçimlendirme
- İletileri silme
- Alanımdaki mesajları listele.
- Mesaj güncelleme
- Mesaj gönderin.