Hướng dẫn này giới thiệu các phương thức phản hồi và yêu cầu chính tạo nên API Google Tài liệu và cách bạn có thể cập nhật hàng loạt một tài liệu.
Bạn có thể gọi API Google Tài liệu bằng cách sử dụng yêu cầu HTTP hoặc sử dụng một phương thức trong thư viện ứng dụng dành riêng cho từng ngôn ngữ. Các cấp độ này nhìn chung là tương đương.
API Google Tài liệu trả về phản hồi HTTP, thường bao gồm kết quả của lệnh gọi yêu cầu. Khi sử dụng thư viện ứng dụng để đưa ra yêu cầu, phản hồi sẽ được trả về theo cách dành riêng cho ngôn ngữ.
Phương thức yêu cầu
API Tài liệu hỗ trợ các phương thức sau:
documents.create
: Tạo một tài liệu trống trên Google Tài liệu.documents.get
: Trả về một thực thể đầy đủ của tài liệu đã chỉ định. Bạn có thể phân tích cú pháp JSON được trả về để trích xuất nội dung, định dạng và các tính năng khác của tài liệu.documents.batchUpdate
: Gửi danh sách yêu cầu chỉnh sửa để áp dụng chi tiết cho tài liệu, và trả về danh sách kết quả.
Các phương thức documents.get
và documents.batchUpdate
yêu cầu có documentId
làm tham số để chỉ định tài liệu đích. Phương thức documents.create
sẽ trả về một phiên bản của tài liệu đã tạo để bạn có thể đọc
documentId
. Để biết thêm thông tin về documentId
, hãy xem Tài liệu
Mã nhận dạng.
Cập nhật theo lô
documents.batchUpdate
phương thức lấy danh sách
request
đối tượng, mỗi đối tượng
chỉ định một yêu cầu duy nhất để thực hiện. Ví dụ: định dạng một đoạn rồi
thêm hình ảnh cùng dòng. Mỗi yêu cầu đều được xác thực trước khi áp dụng và
các yêu cầu được xử lý theo thứ tự xuất hiện trong yêu cầu hàng loạt.
Tất cả các yêu cầu trong quá trình cập nhật theo lô đều được áp dụng một cách tỉ mỉ. Tức là, nếu có yêu cầu không hợp lệ thì toàn bộ cập nhật không thành công và không có lượt chuyển đổi nào (có thể phụ thuộc) sẽ được áp dụng.
Một số phương thức documents.batchUpdate
cung cấp phản hồi kèm theo thông tin về
các yêu cầu đã áp dụng. Các phương thức này trả về một phản hồi
nội dung
chứa danh sách response
. Các yêu cầu khác không cần trả về thông tin và hiện trường trống
trả lời. Các đối tượng trong danh sách phản hồi sẽ chiếm cùng thứ tự chỉ mục với
yêu cầu tương ứng.
Một mẫu phổ biến để tạo yêu cầu hàng loạt có dạng như sau:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Hãy xem các phương pháp hay nhất về yêu cầu theo lô để biết thông tin chi tiết đầy đủ về cách tạo lô lệnh gọi API Tài liệu và tài liệu tham khảo documents.batchUpdate
về các loại yêu cầu và phản hồi.
Hoạt động cập nhật theo lô
Có nhiều loại yêu cầu cập nhật hàng loạt. Sau đây là bảng chi tiết về loại yêu cầu, được nhóm thành các danh mục khác nhau.
Chủ đề có liên quan
- Cấu trúc của một tài liệu trên Google Tài liệu
- Các quy tắc và hành vi chỉnh sửa cấu trúc
- Yêu cầu theo lô