Bu kılavuzda, Google Chat API'nin Message kaynağında bulunan 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'sinde, sohbet 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 kullanıcı rızası 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.jsonadlı bir JSON dosyası olarak kaydedin. - Chat uygulaması olarak kimlik doğrulamak için
hizmet hesabı kimlik bilgileri oluşturunve kimlik bilgilerini
credentials.jsonadlı 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 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 kullanıcı rızası 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.jsonadlı bir JSON dosyası olarak kaydedin. - Chat uygulaması olarak kimlik doğrulamak için
hizmet hesabı kimlik bilgileri oluşturunve kimlik bilgilerini
credentials.jsonadlı 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 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 kullanıcı rızası 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.jsonadlı bir JSON dosyası olarak kaydedin. - Chat uygulaması olarak kimlik doğrulamak için
hizmet hesabı kimlik bilgileri oluşturunve kimlik bilgilerini
credentials.jsonadlı 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 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 kullanıcı rızası 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. Chat 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 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.readonlyveyachat.messagesyetkilendirme kapsamını belirtin.GetMessage()yöntemini çağırın.- Alınacak mesajın kaynak adını
nameolarak 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ınnamekimliği. KimliğiListSpaces()yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.MESSAGE_NAME: İletininnamebölümündeki kimlik. Kimliği, Chat API ile eşzamansız 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.
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 iletiyle ilgili ayrıntılı bilgi edinmek için isteğinizde aşağıdakileri iletin:
- Yetkilendirme kapsamı belirtin. Bu bölümdeki örneklerde, genellikle kullanılabilen ve yönetici onayı gerektirmeyen
chat.botkapsamı kullanılmaktadır. Alternatif olarak, yönetici onayıyla Chat uygulaması olarak yetkilendirebilirsiniz. GetMessage()yöntemini çağırın.- Alınacak mesajın kaynak adını
nameolarak ayarlayın.
Aşağıdaki örnekte, uygulama kimlik doğrulaması ile 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ınnamekimliği. KimliğiListSpaces()yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.MESSAGE_NAME: İletininnamebölümündeki kimlik. Kimliği, Chat API ile eşzamansız 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.
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ına sahip 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 edinmek için isteğinizde aşağıdakileri iletin:
GetMessage()yöntemini çağırın.chat.app.messages.readonlyyetkilendirme kapsamını belirtin.- Alınacak mesajın kaynak adını
nameolarak ayarlayın.
Chat API'yi çağıran bir komut dosyası yazma
Uygulama kimlik doğrulaması ve yönetici onayı ile Chat REST API kullanılarak bir mesajla ilgili ayrıntıları nasıl alacağınız aşağıda açıklanmıştır:
Python
- Çalışma dizininizde
chat_messages_get_admin_app.pyadlı 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) # 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:
SPACE_NAME: Alanınnamekimliği. KimliğiListSpaces()yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.MESSAGE_NAME: İletininnamebö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.
Ç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.
- İleti arama