อัปโหลดสื่อเป็นไฟล์แนบ

คู่มือนี้จะอธิบายวิธีใช้เมธอด upload ในทรัพยากร Media ของ Google Chat API เพื่ออัปโหลดสื่อ (ไฟล์) ไปยัง Google Chat แล้วแนบไปกับข้อความ

เมื่อผู้ใช้ส่งข้อความไปยังแอป Google Chat จะส่งMESSAGEเหตุการณ์การโต้ตอบ เหตุการณ์การโต้ตอบที่แอปได้รับจะมีเนื้อหาคำขอ ซึ่งเป็นเพย์โหลด JSON ที่แสดงถึงเหตุการณ์การโต้ตอบ รวมถึงไฟล์แนบ ข้อมูลในไฟล์แนบจะแตกต่างกันไปโดยขึ้นอยู่กับว่าไฟล์แนบเป็นเนื้อหาที่อัปโหลด (ไฟล์ในเครื่อง) หรือเป็นไฟล์ที่เก็บไว้ในไดรฟ์ Mediaทรัพยากรแสดงไฟล์ที่อัปโหลดไปยัง Google Chat เช่น รูปภาพ วิดีโอ และเอกสาร แหล่งข้อมูลAttachmentแสดงถึงอินสแตนซ์ของสื่อ ซึ่งเป็นไฟล์ที่แนบมากับข้อความ Attachment ทรัพยากรจะมีข้อมูลเมตาเกี่ยวกับไฟล์แนบ เช่น ตำแหน่งที่บันทึกไฟล์แนบ

ข้อกำหนดเบื้องต้น

Python

  • บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

อัปโหลดเป็นไฟล์แนบ

หากต้องการอัปโหลดสื่อและแนบไปกับข้อความ ให้ส่งข้อมูลต่อไปนี้ในคำขอ

  • ระบุขอบเขตการให้สิทธิ์ chat.messages.create หรือ chat.messages
  • เรียกใช้เมธอดต่อไปนี้ของ Google Chat
    1. หากต้องการอัปโหลดไฟล์ ให้เรียกใช้เมธอด upload ในทรัพยากร Media
      • ตั้งค่า parent เป็นชื่อพื้นที่ทำงานของพื้นที่ทำงานที่โฮสต์ไฟล์
      • ใน body (เนื้อหาคำขอ) ให้ตั้งค่า filename เป็นชื่อไฟล์แนบที่อัปโหลด
      • ตั้งค่า media_body เป็นอินสแตนซ์ของไฟล์ที่จะอัปโหลด
    2. หากต้องการสร้างข้อความโดยแนบไฟล์ที่อัปโหลด ให้เรียกใช้เมธอด create ในแหล่งข้อมูล Messages

ตัวอย่างต่อไปนี้จะอัปโหลดไฟล์ภาพ 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 ด้วยชื่อพื้นที่ทำงานเพื่ออัปโหลดไฟล์แนบ ซึ่งคุณรับได้จากเมธอด spaces.list ใน Chat API หรือจาก URL ของพื้นที่ทำงาน

  4. ในไดเรกทอรีทํางาน ให้สร้างและเรียกใช้ตัวอย่าง ดังนี้

    python3 chat_media_and_attachment_upload.py

Chat API จะแสดงผลเนื้อหาการตอบกลับที่มี attachmentDataRef พร้อมรายละเอียดเกี่ยวกับไฟล์ที่อัปโหลด

ข้อจำกัดและข้อควรพิจารณา

เมื่อเตรียมอัปโหลดไฟล์และแนบไฟล์ไปกับข้อความ โปรดคำนึงถึงข้อจำกัดและข้อควรพิจารณาต่อไปนี้