เอกสาร

คู่มือนี้จะแนะนำแนวคิดต่างๆ เช่น วิธีการหลักที่ประกอบกันเป็น Google เอกสาร API, วิธีเข้าถึงเอกสาร และขั้นตอนการทำงานเมื่อสร้าง เอกสาร

เมธอด API

ทรัพยากร documents มีวิธีการที่คุณใช้เรียกใช้ Docs API วิธีการต่อไปนี้ช่วยให้คุณ สร้าง อ่าน และอัปเดตเอกสารใน Google เอกสาร:

• ใช้เมธอด documents.create เพื่อสร้างเอกสาร
• ใช้เมธอด documents.get เพื่อเรียกเนื้อหาของเอกสารที่ระบุ
• ใช้documents.batchUpdate ในการดำเนินการอัปเดตชุดโดยอัตโนมัติในเอกสารที่ระบุ

เมธอด documents.get และ documents.batchUpdate ต้องมี documentId เป็นพารามิเตอร์เพื่อระบุเอกสารเป้าหมาย เมธอด documents.create จะแสดงอินสแตนซ์ของเอกสารที่สร้างขึ้น ซึ่งคุณสามารถอ่าน documentId ดูข้อมูลเพิ่มเติมเกี่ยวกับคำขอและวิธีการตอบกลับของ Docs API ได้ที่คำขอและคำตอบ

รหัสเอกสาร

documentId เป็นตัวระบุที่ไม่ซ้ำกันสำหรับเอกสารและดึงข้อมูลได้ จาก URL ของเอกสาร ซึ่งเป็นสตริงที่มีตัวอักษร ตัวเลข และ สัญลักษณ์พิเศษบางอย่าง รหัสเอกสารจะคงที่ แม้ว่าจะชื่อเอกสาร การเปลี่ยนแปลง

https://docs.google.com/document/d/DOCUMENT_ID/edit

คุณใช้นิพจน์ทั่วไปต่อไปนี้เพื่อดึง documentId จาก URL ของ Google เอกสาร:

/document/d/([a-zA-Z0-9-_]+)

หากคุณคุ้นเคยกับ Google ไดรฟ์ API documentId จะตรงกับ id ในแหล่งข้อมูล files

จัดการเอกสารใน Google ไดรฟ์

ไฟล์เอกสารถูกเก็บไว้ใน Google ไดรฟ์ ซึ่งเป็นพื้นที่เก็บข้อมูลในระบบคลาวด์ของเรา service. แม้ว่า Docs API จะมีเมธอดที่แยกเป็นเดี่ยวๆ แต่มักจะ จำเป็นต่อการใช้เมธอด Google Drive API เพื่อโต้ตอบกับ ไฟล์เอกสาร เช่น หากต้องการคัดลอกไฟล์เอกสาร ให้ใช้ files.copy ของ Drive API สำหรับข้อมูลเพิ่มเติม ดูที่ คัดลอก เอกสาร

โดยค่าเริ่มต้น เมื่อใช้ Docs API ระบบจะบันทึกเอกสารใหม่ลงในโฟลเดอร์รูทของผู้ใช้บนไดรฟ์ มีตัวเลือกในการบันทึกไฟล์ ไปยังโฟลเดอร์ไดรฟ์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อทำงานกับโฟลเดอร์ Google ไดรฟ์

การทำงานกับไฟล์เอกสาร

หากต้องการเรียกเอกสารจากไดรฟ์ของฉันของผู้ใช้ สำหรับการใช้งานในไดรฟ์เป็นครั้งแรก files.list เพื่อเรียกข้อมูล รหัสสำหรับไฟล์ การเรียกใช้เมธอดโดยไม่มีพารามิเตอร์จะแสดงรายการไฟล์และโฟลเดอร์ทั้งหมด รวมถึงรหัสสำหรับผู้ใช้

ประเภท MIME ของเอกสารจะระบุประเภทและรูปแบบข้อมูล รูปแบบประเภท MIME สำหรับเอกสารคือ application/vnd.google-apps.document สำหรับรายการ ประเภท MIME โปรดดูที่ MIME ที่ Google Workspace และ Google ไดรฟ์รองรับ ประเภทต่างๆ

หากต้องการค้นหาตามประเภท MIME สำหรับไฟล์เอกสารเท่านั้นภายในไดรฟ์ของฉัน ให้เพิ่มตัวกรองสตริงการค้นหาต่อไปนี้ต่อท้าย

q: mimeType = 'application/vnd.google-apps.document'

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับตัวกรองสตริงการค้นหาที่หัวข้อค้นหาไฟล์และ โฟลเดอร์

เมื่อทราบ documentId แล้ว ให้ใช้ เมธอด documents.get ในการดึงข้อมูล อินสแตนซ์ที่สมบูรณ์ของเอกสารที่ระบุ สำหรับข้อมูลเพิ่มเติม โปรดดู คำขอและการตอบกลับ

หากต้องการส่งออกเนื้อหาไบต์ในเอกสารของ Google Workspace ให้ใช้ files.export ที่มีเมธอด documentId ของไฟล์ที่จะส่งออก และส่งออก MIME ที่ถูกต้อง ประเภท สำหรับข้อมูลเพิ่มเติม โปรดดูที่ส่งออก เอกสารใน Google Workspace เนื้อหา

เปรียบเทียบวิธีการ Get กับ List

โปรดดูความแตกต่างระหว่างไดรฟ์ต่อไปนี้ และเมธอดเอกสาร และข้อมูลที่ส่งกลับมาพร้อมเมธอด

ขั้นตอนการสร้างเอกสาร

การสร้างและป้อนข้อมูลในเอกสารใหม่นั้นทำได้ง่ายมากเนื่องจากไม่มี ของเนื้อหาที่มีอยู่ให้ต้องกังวล และไม่มีผู้ทำงานร่วมกันที่สามารถแก้ไข สถานะเอกสาร โดยหลักการแล้ว ฟังก์ชันนี้จะทำงานตามที่แสดงในลำดับต่อไปนี้ แผนภาพ:

ในรูปที่ 1 ผู้ใช้โต้ตอบกับ ทรัพยากร documents มีข้อมูลต่อไปนี้ การรับส่งข้อมูล:

1. มีแอปเรียกเมธอด เมธอด documents.create เปิดอยู่ เว็บเซิร์ฟเวอร์
2. เว็บเซิร์ฟเวอร์จะส่งการตอบกลับ HTTP ที่มีอินสแตนซ์ของ สร้างเอกสารเป็นทรัพยากร documents แล้ว
3. (ไม่บังคับ) แอปจะเรียกเมธอด documents.batchUpdate ในการดำเนินการชุดคำขอแก้ไขในระดับอะตอมเพื่อเติมข้อมูลในเอกสาร กับข้อมูล
4. เว็บเซิร์ฟเวอร์จะส่งการตอบกลับ HTTP บางวิธีของ documents.batchUpdate ให้เนื้อหาการตอบกลับพร้อมข้อมูลเกี่ยวกับคำขอที่นำไปใช้ ในขณะที่ คนอื่นๆ แสดงคำตอบที่ว่างเปล่า

เวิร์กโฟลว์การอัปเดตเอกสาร

การอัปเดตเอกสารที่มีอยู่มีความซับซ้อนกว่า ก่อนจะสร้างเนื้อหาที่มีความหมาย ของการเรียกเพื่ออัปเดตเอกสาร คุณจะต้องทราบสถานะปัจจุบันของเอกสาร นั่นคือ องค์ประกอบใดที่ คำอธิบาย เนื้อหาที่มีในองค์ประกอบเหล่านั้น และลำดับขององค์ประกอบภายในองค์ประกอบ เอกสาร แผนภาพลำดับต่อไปนี้แสดงวิธีการทํางาน

วันที่

ในรูปที่ 2 ผู้ใช้ที่โต้ตอบกับทรัพยากร documents มี โฟลว์ข้อมูลดังต่อไปนี้

1. แอปเรียกใช้เมธอด documents.get ในเว็บเซิร์ฟเวอร์พร้อม documentId ของไฟล์ที่จะค้นหา
2. เว็บเซิร์ฟเวอร์จะส่งการตอบกลับ HTTP ที่มีอินสแตนซ์ของ เอกสารที่ระบุเป็นทรัพยากร documents JSON ที่แสดงผลมีแอตทริบิวต์ เนื้อหา การจัดรูปแบบ และฟีเจอร์อื่นๆ ของเอกสาร
3. แอปแยกวิเคราะห์ JSON เพื่อให้ผู้ใช้สามารถระบุเนื้อหาหรือรูปแบบที่จะ อัปเดต
4. แอปเรียกเมธอด documents.batchUpdate เพื่อดำเนินการเซตแบบอะตอม คำขอแก้ไขเพื่ออัปเดตเอกสาร
5. เว็บเซิร์ฟเวอร์จะส่งการตอบกลับ HTTP บางวิธีของ documents.batchUpdate ให้เนื้อหาการตอบกลับพร้อมข้อมูลเกี่ยวกับคำขอที่นำไปใช้ ในขณะที่ คนอื่นๆ แสดงคำตอบที่ว่างเปล่า

แผนภาพนี้ไม่คำนึงถึงเวิร์กโฟลว์ที่มีการอัปเดตพร้อมกันโดยผู้ทำงานร่วมกันคนอื่นๆ ในเอกสารเดียวกัน ดูข้อมูลเพิ่มเติมได้ที่ส่วนแนวทางปฏิบัติแนะนำวางแผนเพื่อการทำงานร่วมกัน

หัวข้อที่เกี่ยวข้อง

• โครงสร้างของเอกสารใน Google เอกสาร
• คำขอและการตอบกลับ
• กฎและลักษณะการทำงานของการแก้ไขโครงสร้าง
• แนวทางปฏิบัติแนะนำเพื่อผลลัพธ์ที่ดีที่สุด