คู่มือนี้จะอธิบายวิธีใช้เมธอด download
ในทรัพยากร Media
ของ Google Chat API เพื่อดาวน์โหลดสื่อ (ไฟล์) จากข้อความใน Google Chat
เมื่อผู้ใช้ส่งข้อความไปยังแอป Google Chat จะส่งMESSAGE
เหตุการณ์การโต้ตอบ
เหตุการณ์การโต้ตอบที่แอปได้รับจะมีเนื้อหาคำขอ ซึ่งเป็นเพย์โหลด JSON ที่แสดงถึงเหตุการณ์การโต้ตอบ รวมถึงไฟล์แนบ ข้อมูลในไฟล์แนบจะแตกต่างกันไปโดยขึ้นอยู่กับว่าไฟล์แนบเป็นเนื้อหาที่อัปโหลด (ไฟล์ในเครื่อง) หรือเป็นไฟล์ที่เก็บไว้ในไดรฟ์ Media
ทรัพยากรแสดงไฟล์ที่อัปโหลดไปยัง Google Chat เช่น รูปภาพ วิดีโอ และเอกสาร
แหล่งข้อมูลAttachment
แสดงถึงอินสแตนซ์ของสื่อ ซึ่งเป็นไฟล์ที่แนบมากับข้อความ Attachment
ทรัพยากรจะมีข้อมูลเมตาเกี่ยวกับไฟล์แนบ เช่น ตำแหน่งที่บันทึกไฟล์แนบ
ข้อกำหนดเบื้องต้น
Python
- บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมโดยทำดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกําหนดค่า Google Chat API พร้อมตั้งชื่อ ไอคอน และคําอธิบายสําหรับแอป Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ Google API สำหรับ Python
- สร้างข้อมูลเข้าสู่ระบบตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
client_secrets.json
ลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ที่มีชื่อว่า
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
ดาวน์โหลดจากไฟล์แนบ
หากต้องการดาวน์โหลดสื่อจากไฟล์แนบ ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ ให้ระบุขอบเขตการให้สิทธิ์
chat.messages.readonly
หรือchat.messages
เมื่อใช้การตรวจสอบสิทธิ์ของแอป ให้ระบุขอบเขตการให้สิทธิ์chat.bot
- เรียกใช้เมธอดต่อไปนี้ของ Google Chat
- รับ
attachmentDataRef
โดยการเรียกใช้เมธอดใดเมธอดหนึ่งต่อไปนี้ - เรียกเมธอด
download
ในทรัพยากรMedia
และระบุattachmentDataRef.resourceName
ที่ดึงข้อมูลไว้ก่อนหน้านี้เป็นmedia.download.resourceName
- รับ
ตัวอย่างต่อไปนี้จะดาวน์โหลดไฟล์ที่แนบมากับข้อความ
Python
- ในไดเรกทอรีทํางาน ให้สร้างไฟล์ชื่อ
chat_media_and_attachment_download.py
ใส่รหัสต่อไปนี้ใน
chat_media_and_attachment_download.py
import io from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaIoBaseDownload # 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"] def main(): ''' Authenticates with Chat API via user credentials, then downloads a file attached to a 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. chat = build('chat', 'v1', credentials=creds) # Download media resource. request = chat.media().download_media( resourceName=RESOURCE_NAME, ) file = io.BytesIO() downloader = MediaIoBaseDownload(file, request) done = False while done is False: status, done = downloader.next_chunk() if status.total_size: print(f'Total size: {status.total_size}') print(f'Download {int(status.progress() * 100)}') if __name__ == '__main__': main()
ในโค้ด ให้แทนที่
RESOURCE_NAME
ด้วยattachmentDataRef.resourceName
ซึ่งคุณเรียกดูได้โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้ในไดเรกทอรีทํางาน ให้สร้างและเรียกใช้ตัวอย่าง ดังนี้
python3 chat_media_and_attachment_download.py
หากดำเนินการสำเร็จ วิธีการนี้จะแสดงผลเนื้อหาไฟล์เป็นไบต์
หากต้องการดาวน์โหลดเนื้อหาของไฟล์ ให้เลือกวิธีใดวิธีหนึ่งต่อไปนี้
เราขอแนะนำให้ใช้คลาส
MediaIoBaseDownload
ใน Python ซึ่งมีเมธอดสำหรับดาวน์โหลดไฟล์เป็นท่อนๆ และบันทึกเนื้อหาลงในสตรีมเอาต์พุตหากต้องส่งคำขอ HTTP ด้วยตนเอง ให้เรียกใช้เมธอด
download
และระบุส่วนของไฟล์ที่ต้องการดาวน์โหลดโดยใช้ช่วงไบต์ที่มีส่วนหัวRange
เช่นRange: bytes=500-999
หัวข้อที่เกี่ยวข้อง
- หากข้อความเป็นไฟล์ในไดรฟ์ ให้ใช้ Drive API เพื่อเข้าถึงไฟล์
- อัปโหลดสื่อเป็นไฟล์แนบ
- ดาวน์โหลดสื่อเป็นไฟล์แนบ
- รับข้อมูลเมตาเกี่ยวกับไฟล์แนบของข้อความ