API Google Tài liệu cho phép bạn tạo và sửa đổi tài liệu.
Các ứng dụng có thể tích hợp với API Tài liệu để tạo tài liệu hoàn hảo từ cả dữ liệu do người dùng và hệ thống cung cấp. API này cho phép bạn:
- Tự động hoá quy trình
- Tạo nhiều tài liệu cùng lúc
- Tạo hoá đơn hoặc hợp đồng
Tổng quan về API
Tài nguyên tài liệu cung cấp các phương thức mà bạn sử dụng để gọi API Tài liệu.
Phương thức API
Các phương pháp sau cho phép bạn tạo, đọc và cập nhật tài liệu Google Tài liệu:
- Sử dụng documents.create để tạo một tài liệu.
- Sử dụng documents.get để truy xuất nội dung của một tài liệu được chỉ định.
- Sử dụng documents.batchUpdate để thực hiện một tập hợp các cập nhật trên một tài liệu cụ thể.
Phương thức get và batchUpdate yêu cầu phải có documentId (xem bên dưới) làm
thông số để chỉ định tài liệu mục tiêu. Phương thức create trả về một bản sao của tài liệu đã tạo, từ đó bạn có thể đọc mã nhận dạng.
Cập nhật theo lô
Phương thức batchUpdate lấy danh sách các đối tượng yêu cầu và cập nhật theo cùng thứ tự mà các đối tượng đó xuất hiện trong yêu cầu hàng loạt. Các bản cập nhật trong bản cập nhật theo lô được áp dụng nguyên tử. Tức là, nếu bất kỳ yêu cầu nào không hợp lệ thì toàn bộ bản cập nhật sẽ không thành công và không có thay đổi nào (có thể phụ thuộc) được áp dụng.
Phương thức batchUpdate trả về danh sách các đối tượng phản hồi. Các đối tượng trong danh sách này chiếm cùng thứ tự chỉ mục như yêu cầu tương ứng.
Xem các phương pháp hay nhất về yêu cầu hàng loạt để biết cách nhóm các lệnh gọi API theo nhóm cùng tài liệu tham khảo batchUpdate cho các loại yêu cầu và phản hồi.
ID tài liệu
Mã tài liệu tham chiếu đến một tài liệu và các tài liệu đó có thể lấy từ URL:
https://docs.google.com/document/d/documentId/edit
documentId là một chuỗi duy nhất chứa các chữ cái, số và một số ký tự đặc biệt. Bạn có thể sử dụng biểu thức chính quy sau để trích xuất mã nhận dạng tài liệu từ URL của Google Tài liệu:
/document/d/([a-zA-Z0-9-_]+)
Nếu bạn đã quen thuộc với API Google Drive, thì documentId sẽ tương ứng với
mã nhận dạng của tài nguyên Tệp.
Vị trí trong tài liệu: chỉ mục
Khi bạn cập nhật nội dung của một tài liệu, mỗi lần cập nhật sẽ diễn ra tại một vị trí hoặc trên một phạm vi tài liệu. Các vị trí và phạm vi này được chỉ định bằng cách sử dụng chỉ mục, đại diện cho độ dời trong phân đoạn tài liệu. Để tìm hiểu thêm về chỉ mục và cách sử dụng các chỉ mục đó, hãy xem hướng dẫn khái niệm về Cấu trúc của tài liệu trên Google Tài liệu.
Quy trình cập nhật tài liệu
Việc tạo và điền tài liệu mới rất đơn giản vì bạn không cần lo lắng về nội dung hiện có và không có cộng tác viên nào có thể thay đổi trạng thái của tài liệu. Về mặt lý thuyết, tính năng này hoạt động như minh hoạ trong sơ đồ trình tự sau đây:
Việc cập nhật tài liệu hiện có phức tạp hơn. Trước khi có thể thực hiện các lệnh gọi có ý nghĩa để cập nhật tài liệu, bạn cần biết trạng thái hiện tại của tài liệu: phần tử nào tạo nên tài liệu đó, nội dung nào có trong các phần tử đó và vị trí của tất cả các mục này trong tài liệu. Sơ đồ trình tự sau đây cho thấy cách hoạt động của tính năng này:
Sơ đồ này không xem xét quy trình làm việc mà các cộng tác viên khác sẽ cập nhật đồng thời trong cùng một tài liệu. Xem Kế hoạch cộng tác để cùng thảo luận về chủ đề này.