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 lệnh gọi 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 bản sao đầy đủ của tài liệu được 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 các yêu cầu chỉnh sửa để áp dụng ở cấp độ 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 documentId làm tham số để chỉ định tài liệu mục tiêu. Phương thức documents.create
trả về một thực thể của tài liệu đã tạo để bạn có thể đọc
documentId từ đó. Để biết thêm thông tin về documentId, hãy xem phần Mã
tài liệu.
Cập nhật theo lô
Phương thức documents.batchUpdate sẽ lấy một danh sách các đối tượng request, mỗi đối tượng chỉ định một yêu cầu duy nhất cần thực hiện. Ví dụ: định dạng một đoạn văn rồi thêm hình ảnh cùng dòng. Mỗi yêu cầu được xác thực trước khi được á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 hàng loạt đều được áp dụng một cách tỉ mỉ. Nghĩa là nếu có bất kỳ yêu cầu nào không hợp lệ, thì toàn bộ quá trình 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.
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 nội dung phản hồi chứa danh sách các đối tượng response. Các yêu cầu khác không cần trả về thông tin và hiển thị một câu trả lời trống. Các đối tượng trong danh sách phản hồi sẽ có 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)
Xem các phương pháp hay nhất về yêu cầu hàng loạt để biết toàn bộ thông tin chi tiết về cách phân nhóm các lệnh gọi API Tài liệu và tài liệu tham khảo về 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. Dưới đây là bảng chi tiết về loại yêu cầu, được nhóm thành nhiều danh mục.
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ô