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

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

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

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

Python

  • आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.

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

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

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

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

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