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

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

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

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

Python

  • कोई Business या Enterprise Google Workspace खाता, जिसके पास Google Chat का ऐक्सेस हो.

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

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

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

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

    python3 chat_media_and_attachment_upload.py

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

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

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