Tài liệu này cung cấp tài liệu tham khảo chi tiết về giao thức thô (XML và HTTP) cho Google Sites Data API.
Tài liệu này không chứa thông tin về các thư viện ứng dụng bằng ngôn ngữ lập trình. Để biết thông tin tham khảo về thư viện ứng dụng, hãy xem các đường liên kết trong phần dành riêng cho ngôn ngữ lập trình trong hướng dẫn dành cho nhà phát triển.
Đối tượng
Tài liệu này dành cho những lập trình viên muốn viết các ứng dụng có thể tương tác với Google Sites.
Đây là tài liệu tham khảo; tài liệu này giả định rằng bạn hiểu các khái niệm được trình bày trong hướng dẫn về giao thức và các ý tưởng chung đằng sau giao thức API Dữ liệu của Google.
Các loại nguồn cấp dữ liệu của Google Sites
Google Sites Data API cung cấp các loại nguồn cấp dữ liệu sau:
- Trang Hoạt động
- Nguồn cấp nội dung
- Nguồn cấp dữ liệu sửa đổi
- Nguồn cấp dữ liệu trang web
- Nguồn cấp dữ liệu ACL
Trang Hoạt động
Nguồn cấp dữ liệu hoạt động là một nguồn cấp dữ liệu chứa nội dung mô tả về tất cả hoạt động trong một trang web.
URI GET của nguồn cấp dữ liệu này cho một trang web trong một miền cụ thể là:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName là "site" hoặc một miền G Suite.
siteName là tên trang web xuất hiện trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName/.
Bạn phải xác thực tất cả các yêu cầu đối với nguồn cấp dữ liệu này.
Các loại yêu cầu được hỗ trợ: GET
Nguồn cấp nội dung
Nguồn cấp nội dung là nguồn cấp dữ liệu chứa nội dung hiện tại của trang web mà bạn có thể chỉnh sửa.
URI GET của nguồn cấp dữ liệu này cho một trang web trong một miền cụ thể là:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName là "site" hoặc một miền G Suite.
siteName là tên trang web xuất hiện trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName.
Các yêu cầu đối với nguồn cấp dữ liệu này có thể yêu cầu hoặc không yêu cầu xác thực, tuỳ thuộc vào chế độ cài đặt (đã xuất bản) của Trang web.
Các loại yêu cầu được hỗ trợ: GET, POST, PUT, DELETE
Ngoài các tham số truy vấn Data API tiêu chuẩn, Sites Data API còn cho phép các tham số không bắt buộc sau đây đưa ra yêu cầu GET bằng cách sử dụng nguồn cấp dữ liệu nội dung:
| Tham số | Mô tả | Loại | Ghi chú |
|---|---|---|---|
ancestor |
Chỉ yêu cầu những mục có đối tượng cấp trên được chỉ định. | chuỗi | Cung cấp mã nhận dạng của mục nhập đối tượng cấp trên mong muốn. Ví dụ: 0123456789. Trả về tất cả các mục có đối tượng cấp trên được chỉ định làm mục gốc, mục gốc của mục gốc, v.v. |
include-deleted |
Chỉ định có bao gồm các mục đã xoá hay không. | boolean | Giá trị có thể là true hoặc false. Giá trị mặc định là false. |
include-draft |
Chỉ định có bao gồm các mục nháp hay không. | boolean | Giá trị có thể là true hoặc false. Giá trị mặc định là false. Bạn phải là chủ sở hữu hoặc tác giả của bản nháp thì mới xem được bản nháp đó. |
kind |
Chỉ định(các) loại mục nội dung cần trả về. Các loại này tuân theo loại trang trong Google Sites. | danh sách chuỗi được phân tách bằng dấu phẩy | Các giá trị có thể có là announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template. |
parent |
Chỉ yêu cầu những mục có đối tượng cấp trên được chỉ định. | chuỗi | Cung cấp mã nhận dạng của mục nhập gốc. Ví dụ: 0123456789. |
path |
Yêu cầu nội dung theo một hệ thống phân cấp trang nhất định | chuỗi | Đường dẫn đến một trang con trong một Trang web để tìm nạp nội dung. Ví dụ: path=/path/to/page. |
Nguồn cấp dữ liệu bản sửa đổi
Nguồn cấp dữ liệu về bản sửa đổi là nguồn cấp dữ liệu chứa các bản sửa đổi trước đây của nội dung trang web.
URI GET của nguồn cấp dữ liệu này cho một trang web trong một miền cụ thể là:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName là "site" hoặc một miền G Suite.
siteName là tên trang web xuất hiện trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName.
Bạn phải xác thực tất cả các yêu cầu đối với nguồn cấp dữ liệu này.
Các loại yêu cầu được hỗ trợ: GET
Nguồn cấp dữ liệu trang web
Bạn có thể sử dụng nguồn cấp dữ liệu trang web để liệt kê những trang web trên Google Sites mà người dùng sở hữu hoặc có quyền xem. Bạn cũng có thể dùng tính năng này để tạo trang web mới, sao chép trang web hoặc sửa đổi tên của một trang web hiện có.
URI nguồn cấp dữ liệu cho trang thông tin về Các trang web là:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName là "site" hoặc một miền G Suite.
Bạn phải xác thực tất cả các yêu cầu đối với nguồn cấp dữ liệu này.
Các loại yêu cầu được hỗ trợ: GET, POST, PUT
Nguồn cấp dữ liệu trang web hỗ trợ các tham số sau (không bắt buộc) khi đưa ra yêu cầu GET để liệt kê các trang web:
| Tham số | Mô tả | Loại | Ghi chú |
|---|---|---|---|
include-all-sites |
Liệt kê tất cả các trang web mà người dùng có thể xem được trong miền G Suite. | boolean | Tham số này chỉ áp dụng khi liệt kê các trang web cho một miền G Suite. Giá trị có thể là true hoặc false. Giá trị mặc định là false. |
with-mappings |
Bao gồm các mối liên kết giữa địa chỉ web trong một mục nhập trang web. | boolean | Giá trị có thể là true hoặc false. Giá trị mặc định là false. |
Nguồn cấp dữ liệu ACL
Bạn có thể dùng nguồn cấp dữ liệu ACL để liệt kê và/hoặc sửa đổi quyền chia sẻ (ACL) của một trang web trên Google Sites.
URI nguồn cấp dữ liệu cho trang thông tin về Các trang web là:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName là "site" hoặc một miền G Suite.
Bạn phải xác thực tất cả các yêu cầu đối với nguồn cấp dữ liệu này.
Các loại yêu cầu được hỗ trợ: GET, POST, PUT, DELETE
Thông tin tham khảo về tham số truy vấn của Google Sites
Các tham số truy vấn được hỗ trợ từ giao thức Google Data API:
max-resultspublished-max(chỉ nguồn cấp nội dung)published-min(chỉ nguồn cấp nội dung)start-indexupdated-maxupdated-minq(cụm từ tìm kiếm đầy đủ)
Hãy xem từng nguồn cấp dữ liệu ở trên để biết danh sách các thông số dành riêng cho nguồn cấp dữ liệu đó.