इस गाइड में, Google Chat API के Media
संसाधन पर upload
तरीके का इस्तेमाल करके, Google Chat में मीडिया (फ़ाइल) अपलोड करने और फिर उसे मैसेज से अटैच करने का तरीका बताया गया है.
जब कोई उपयोगकर्ता आपके ऐप्लिकेशन पर मैसेज भेजता है, तो Google Chat एक MESSAGE
इंटरैक्शन इवेंट भेजता है.
आपके ऐप्लिकेशन को मिले इंटरैक्शन इवेंट में एक अनुरोध बॉडी शामिल होता है. यह इंटरैक्शन इवेंट को दिखाने वाला JSON पेलोड होता है. इसमें अटैचमेंट भी शामिल होते हैं. अटैचमेंट में मौजूद डेटा अलग-अलग होता है. यह इस बात पर निर्भर करता है कि अटैचमेंट, अपलोड किया गया कॉन्टेंट (लोकल फ़ाइल) है या Drive पर सेव की गई फ़ाइल. Media
संसाधन, Google Chat पर अपलोड की गई फ़ाइल को दिखाता है. जैसे, इमेज, वीडियो, और दस्तावेज़.
Attachment
रिसॉर्स, मैसेज में अटैच की गई फ़ाइल या मीडिया के इंस्टेंस को दिखाता है. Attachment
रिसॉर्स में अटैचमेंट का मेटाडेटा शामिल होता है. जैसे, वह कहां सेव किया गया है.
ज़रूरी शर्तें
Python
- आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.
- अपना एनवायरमेंट सेट अप करें:
- Google Cloud प्रोजेक्ट बनाएं.
- OAuth की सहमति वाली स्क्रीन को कॉन्फ़िगर करें.
- अपने Chat ऐप्लिकेशन के लिए नाम, आइकॉन, और जानकारी के साथ Google Chat API को चालू और कॉन्फ़िगर करें.
- Python Google API क्लाइंट लाइब्रेरी को इंस्टॉल करें.
- डेस्कटॉप ऐप्लिकेशन के लिए,
OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं. इस गाइड में दिए गए सैंपल को चलाने के लिए, अपनी लोकल डायरेक्ट्री में क्रेडेंशियल को
client_secrets.json
नाम की JSON फ़ाइल के तौर पर सेव करें.
- उपयोगकर्ता की पुष्टि करने की सुविधा वाला अनुमति का स्कोप चुनें.
फ़ाइल के तौर पर अटैचमेंट के तौर पर अपलोड करना
मीडिया अपलोड करने और उसे मैसेज में अटैच करने के लिए, अपने अनुरोध में ये चीज़ें डालें:
chat.messages.create
याchat.messages
ऑथराइज़ेशन स्कोप की जानकारी दें.- Google Chat में कॉल करने के लिए, इन तरीकों का इस्तेमाल करें:
- फ़ाइल अपलोड करने के लिए,
Media
संसाधन परupload
तरीका कॉल करें.parent
को उस स्पेस के नाम पर सेट करें जिसमें फ़ाइल होस्ट की गई है.body
(अनुरोध का मुख्य हिस्सा) में,filename
को अपलोड की गई फ़ाइल के अटैचमेंट के नाम पर सेट करें.media_body
को अपलोड की जाने वाली फ़ाइल के इंस्टेंस के तौर पर सेट करें.
- अपलोड की गई फ़ाइल को अटैच करके मैसेज बनाने के लिए,
Messages
संसाधन परcreate
तरीका इस्तेमाल करें.attachment
कोMedia
संसाधन पर,upload
तरीके को कॉल करने से मिले रिस्पॉन्स के तौर पर सेट करें.attachment
फ़ील्ड में सूची डाली जा सकती है.
- फ़ाइल अपलोड करने के लिए,
इस उदाहरण में, PNG इमेज फ़ाइल अपलोड करके उसे मैसेज से अटैच किया गया है.
Python
- अपनी वर्किंग डायरेक्ट्री में,
chat_media_and_attachment_upload.py
नाम की फ़ाइल बनाएं. chat_media_and_attachment_upload.py
में यह कोड शामिल करें: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()
कोड में,
SPACE
को उस स्पेस के नाम से बदलें जिसमें अटैचमेंट अपलोड करना है. यह नाम, Chat API मेंspaces.list
तरीके या स्पेस के यूआरएल से लिया जा सकता है.अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:
python3 chat_media_and_attachment_upload.py
Chat API, रिस्पॉन्स बॉडी के तौर पर attachmentDataRef
दिखाता है. इसमें अपलोड की गई फ़ाइल की जानकारी होती है.
सीमाएं और ज़रूरी बातें
फ़ाइलें अपलोड करने और उन्हें मैसेज में अटैच करने से पहले, इन सीमाओं और बातों का ध्यान रखें:
- 200 एमबी तक की फ़ाइलें अपलोड की जा सकती हैं.
- कुछ फ़ाइल टाइप काम नहीं करते और उन्हें अपलोड नहीं किया जा सकता. ज़्यादा जानकारी के लिए, Google Chat में ब्लॉक किए गए फ़ाइल टाइप देखें.
- आपके मैसेज में ऐक्सेसरी विजेट नहीं होने चाहिए.