मीडिया को फ़ाइल अटैचमेंट के तौर पर अपलोड करें

इस गाइड में बताया गया है कि Google Chat API में कोई फ़ाइल (फ़ाइल) अपलोड करने और उसे मैसेज में अटैच करने के लिए, Google Chat API के Media संसाधन पर upload तरीके का इस्तेमाल कैसे करना है.

जब उपयोगकर्ता आपके ऐप्लिकेशन पर मैसेज भेजता है, तो Google Chat एक MESSAGE इंटरैक्शन इवेंट भेजता है. आपके ऐप्लिकेशन को मिले इंटरैक्शन इवेंट में, अनुरोध का मुख्य हिस्सा शामिल होता है. यह अनुरोध का मुख्य हिस्सा होता है, जो इंटरैक्शन इवेंट को दिखाता है. इसमें सभी अटैचमेंट भी शामिल होते हैं. अटैचमेंट में मौजूद डेटा इस आधार पर अलग-अलग होता है कि अटैचमेंट अपलोड किया गया कॉन्टेंट (लोकल फ़ाइल) है या Drive पर सेव कोई फ़ाइल है. Media रिसॉर्स, Google Chat पर अपलोड की गई फ़ाइल के बारे में बताता है. जैसे, इमेज, वीडियो, और दस्तावेज़. Attachment रिसॉर्स, किसी मैसेज के साथ अटैच की गई फ़ाइल—मीडिया के इंस्टेंस को दिखाता है. Attachment संसाधन में, अटैचमेंट का मेटाडेटा शामिल होता है. जैसे, उसे कहां सेव किया जाता है.

ज़रूरी शर्तें

Python

  • Python 3.6 या इससे नया वर्शन
  • pip पैकेज मैनेजमेंट टूल

  • Python के लिए नई Google क्लाइंट लाइब्रेरी. उन्हें इंस्टॉल या अपडेट करने के लिए, अपने कमांड-लाइन इंटरफ़ेस में नीचे दिया गया कमांड चलाएं:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • ऐसा Google Cloud प्रोजेक्ट जिसमें Google Chat API चालू हो और उसे कॉन्फ़िगर किया गया हो. तरीका जानने के लिए, Google Chat ऐप्लिकेशन बनाना देखें.

  • Chat ऐप्लिकेशन के लिए अनुमति कॉन्फ़िगर की गई. मीडिया को फ़ाइल अटैचमेंट के तौर पर अपलोड करने के लिए, chat.messages.create या chat.messages की अनुमति देने के स्कोप का इस्तेमाल करके उपयोगकर्ता की पुष्टि करना ज़रूरी है.

फ़ाइल अटैचमेंट के तौर पर अपलोड करें

मीडिया अपलोड करने और उसे किसी मैसेज में अटैच करने के लिए, अपने अनुरोध में यह जानकारी दें:

  • अनुमति देने के लिए, chat.messages.create या chat.messages का स्कोप बताएं.
  • Google Chat के इन तरीकों को कॉल करें:
    1. फ़ाइल अपलोड करने के लिए, Media संसाधन पर मौजूद upload तरीके को कॉल करें.
      • parent को उस स्पेस के नाम पर सेट करें जो फ़ाइल को होस्ट करता है.
      • body (अनुरोध के मुख्य हिस्से) में, filename को अपलोड किए गए फ़ाइल अटैचमेंट के नाम पर सेट करें.
      • media_body को अपलोड की जाने वाली फ़ाइल के इंस्टेंस के तौर पर सेट करें.
    2. अपलोड की गई फ़ाइल अटैच करके मैसेज बनाने के लिए, Messages संसाधन पर create तरीके को कॉल करें.
      • Media संसाधन पर upload तरीके का इस्तेमाल करके, attachment को रिस्पॉन्स के तौर पर सेट करें. attachment फ़ील्ड एक सूची स्वीकार करता है.

नीचे दिया गया उदाहरण एक PNG इमेज फ़ाइल अपलोड करता है और उसे किसी मैसेज में अटैच करता है.

Python

  1. अपनी वर्किंग डायरेक्ट्री में, chat_media_and_attachment_upload.py नाम की फ़ाइल बनाएं.

  2. 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()

  3. अटैचमेंट को अपलोड करने के लिए, कोड में SPACE की जगह स्पेस का नाम डालें. इसे स्पेस के यूआरएल या Chat API में spaces.list तरीके से लिया जा सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, यह सैंपल बनाएं और चलाएं:

    python3 chat_media_and_attachment_upload.py

Chat API जवाब का एक मुख्य हिस्सा दिखाता है, जिसमें attachmentDataRef अपलोड की गई फ़ाइल के बारे में जानकारी होती है.

सीमाएं और ध्यान देने वाली बातें

फ़ाइलों को अपलोड करने और उन्हें मैसेज में अटैच करते समय, इन सीमाओं और बातों का ध्यान रखें:

  • फ़ाइल का साइज़ 200 एमबी तक अपलोड किया जा सकता है.
  • कुछ फ़ाइल टाइप काम नहीं करते और उन्हें अपलोड नहीं किया जा सकता. ज़्यादा जानकारी के लिए, Google Chat में ब्लॉक किए गए फ़ाइल टाइप देखें.