Bu kılavuzda, Google Chat'e medya (dosya) yüklemek ve ardından bir mesaja eklemek için Google Chat API'nin Media
kaynağındaki upload
yönteminin nasıl kullanılacağı açıklanmaktadır.
Kullanıcı uygulamanıza mesaj gönderdiğinde Google Chat bir MESSAGE
etkileşim etkinliği gönderir.
Uygulamanızın aldığı etkileşim etkinliği, istek gövdesini içerir. Bu, ekler de dahil olmak üzere etkileşim etkinliğini temsil eden JSON yüküdür. Ekteki veriler, ekin yüklenen içerik mi (yerel dosya) yoksa Drive'da depolanan bir dosya mı olduğuna bağlı olarak farklılık gösterir. Media
kaynağı, Google Chat'e yüklenen bir dosyayı (resim, video ve doküman gibi) temsil eder.
Attachment
kaynağı, bir mesaja eklenmiş medya örneğini (dosya) temsil eder. Attachment
kaynağı, ekle ilgili meta verileri (ör. dosyanın kaydedildiği yer) içerir.
Ön koşullar
Python
- Python 3.6 veya sonraki sürümler
- pip paket yönetimi aracı
Python için en yeni Google istemci kitaplıkları. Bunları yüklemek veya güncellemek için komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Google Chat API'nin etkin ve yapılandırılmış olduğu bir Google Cloud projesi. Adımlar için Google Chat uygulaması oluşturma başlıklı makaleye göz atın.
Chat uygulaması için yetkilendirme yapılandırıldı. Medyayı dosya eki olarak yüklemek için
chat.messages.create
veyachat.messages
yetkilendirme kapsamında Kullanıcı kimlik doğrulaması yapılması gerekir.
Dosya eki olarak yükle
Medya yüklemek ve bir mesaja eklemek için isteğinizde aşağıdakileri iletin:
chat.messages.create
veyachat.messages
yetkilendirme kapsamını belirtin.- Aşağıdaki Google Chat yöntemlerini çağırın:
- Dosyayı yüklemek için
Media
kaynağındaupload
yöntemini çağırın.parent
öğesini, dosyayı barındıran alanın alan adına ayarlayın.body
alanında (istek gövdesi)filename
öğesini, yüklenen dosya ekinin adı olarak ayarlayın.media_body
öğesini, yüklenecek dosyanın örneği olarak ayarlayın.
- Yüklenen dosya ekli bir mesaj oluşturmak için
Messages
kaynağındacreate
yöntemini çağırın.attachment
öğesini,Media
kaynağındaupload
yöntemini çağırma yanıtı olarak ayarlayın.attachment
alanına liste kabul edilir.
- Dosyayı yüklemek için
Aşağıdaki örnekte bir PNG resim dosyası yüklenmekte ve dosya bir iletiye iliştirilmektedir.
Python
- Çalışma dizininizde
chat_media_and_attachment_upload.py
adında bir dosya oluşturun. chat_media_and_attachment_upload.py
içine şu kodu ekleyin:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaFileUpload # 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.messages.create"] def main(): ''' Authenticates with Chat API via user credentials, then uploads a file as media, creates a message, and attaches the file to the message. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. service = build('chat', 'v1', credentials=creds) # Upload a file to Google Chat. media = MediaFileUpload('test_image.png', mimetype='image/png') # Create a message and attach the uploaded file to it. attachment_uploaded = service.media().upload( # The space to upload the attachment in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE', # The filename of the attachment, including the file extension. body={'filename': 'test_image.png'}, # Media resource of the attachment. media_body=media ).execute() print(attachment_uploaded) # Create a Chat message with attachment. result = service.spaces().messages().create( # The space to create the message in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Must match the space name that the attachment is uploaded to. parent='spaces/SPACE', # The message to create. body={ 'text': 'Hello, world!', 'attachment': [attachment_uploaded] } ).execute() print(result) if __name__ == '__main__': main()
Koddaki
SPACE
kısmını, eki yüklemek için alan adıyla değiştirin. Eki yüklemek için bu alanı Chat API'dekispaces.list
yönteminden veya alanın URL'sinden edinebilirsiniz.Çalışma dizininizde örneği derleyip çalıştırın:
python3 chat_media_and_attachment_upload.py
Chat API, yüklenen dosyayla ilgili ayrıntıları içeren attachmentDataRef
ifadesini içeren bir yanıt gövdesi döndürür.
Sınırlar ve dikkat edilmesi gereken noktalar
Dosyaları yüklemeye ve iletilere eklemeye hazırlanırken aşağıdaki sınırları ve dikkat edilmesi gereken noktaları göz önünde bulundurun:
- 200 MB'a kadar olan dosya boyutlarını yükleyebilirsiniz.
- Bazı dosya türleri desteklenmez ve yüklenemez. Ayrıntılı bilgi için Google Chat'te engellenen dosya türleri başlıklı makaleyi inceleyin.