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 API Dữ liệu Google Sites.
Tài liệu này không chứa thông tin về 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 khách hàng, hãy xem các liên kết từ các phần dành riêng cho ngôn ngữ lập trình trong hướng dẫn của nhà phát triển.
về khán giả
Tài liệu này dành cho những lập trình viên muốn viết ứng dụng khách có thể tương tác với Google Sites.
Tài liệu nà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 Google Sites
API Dữ liệu Google Sites cung cấp các loại nguồn cấp dữ liệu sau:
- Nguồn cấp dữ liệu 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
Nguồn cấp dữ liệu 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 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 miền G Suite.
siteName là tên trang web xuất hiện trong URL trang đích trên trang web: http://sites.google.com/a/domainName/siteName/.
Tất cả các yêu cầu đến nguồn cấp dữ liệu này phải được xác thực.
Loại yêu cầu được hỗ trợ: GET
Nguồn cấp dữ liệu nội dung
Nguồn cấp dữ liệu nội dung là một nguồn cấp dữ liệu chứa nội dung trang web hiện có thể chỉnh sửa được.
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 miền G Suite.
siteName là tên trang web xuất hiện trong URL trang đích trên 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ể cần hoặc không cần xác thực, tùy thuộc vào chế độ cài đặt của trang web (đã xuất bản).
Loại yêu cầu được hỗ trợ: GET
, POST
, PUT
, DELETE
Ngoài các tham số truy vấn API dữ liệu chuẩn, API Dữ liệu trang web cho phép các tham số không bắt buộc sau
phát hành yêu cầu GET
bằng Nguồn cấp nội dung:
Thông số | Mô tả | Loại | Lưu ý |
---|---|---|---|
ancestor |
Chỉ yêu cầu những mục nhập có đối tượng cấp trên đã chỉ định. | string | Cung cấp mã nhận dạng của đố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 cấp độ gốc, cấp độ gốc của v.v. |
include-deleted |
Chỉ định xem có bao gồm các mục nhập đã xóa hay không. | boolean | Bạn có thể sử dụng các giá trị true hoặc false . Mặc định là false . |
include-draft |
Chỉ định xem có bao gồm các mục nhập nháp hay không. | boolean | Bạn có thể sử dụng các giá trị true hoặc false . 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. |
kind |
Chỉ định(các) loại mục nhập nội dung cần trả về. Các trang này tuân theo loại trang trong Google Sites. | Danh sách các chuỗi được phân tách bằng dấu phẩy | Bạn có thể sử dụng các giá trị sau: announcement , announcementspage , attachment , comment , filecabinet , listitem , listpage , webpage , webattachment , template . |
parent |
Chỉ yêu cầu những mục nhập có cấp độ gốc đã chỉ định. | string | 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 trong một hệ thống phân cấp trang nhất định | string | Đườ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 sửa đổi
Nguồn cấp dữ liệu sửa đổi là một nguồn cấp dữ liệu chứa nội dung sửa đổi trước đây về 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 miền G Suite.
siteName là tên trang web xuất hiện trong URL trang đích trên trang web: http://sites.google.com/a/domainName/siteName.
Tất cả các yêu cầu đến nguồn cấp dữ liệu này phải được xác thự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ê các trang web tạo bằng Google Sites mà người dùng sở hữu hoặc có quyền xem. Bạn cũng có thể sử dụng mẫu này để tạo trang web mới, sao chép trang web hoặc sửa đổi tên của trang web hiện có.
URI của nguồn cấp dữ liệu cho trang thông tin Trang web là:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName là "site" hoặc miền G Suite.
Tất cả các yêu cầu đến nguồn cấp dữ liệu này phải được xác thự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 thông số sau (không bắt buộc) khi đưa ra yêu cầu GET
đối với trang web liệt kê:
Thông số | Mô tả | Loại | Lưu ý |
---|---|---|---|
include-all-sites |
Liệt kê tất cả các trang web mà người dùng có thể xem trong miền G Suite ít nhất. | boolean | Thông số này chỉ áp dụng khi liệt kê trang web cho miền G Suite. Bạn có thể sử dụng các giá trị sau: true hoặc false . Mặc định là false . |
with-mappings |
Bao gồm sơ đồ liên kết địa chỉ web trong một mục nhập trang web. | boolean | Bạn có thể sử dụng các giá trị true hoặc false . Mặc định là false . |
Nguồn cấp dữ liệu ACL
Nguồn cấp dữ liệu ACL có thể được dùng để liệt kê và/hoặc sửa đổi các quyền chia sẻ (ACL) của một Trang web Google.
URI của nguồn cấp dữ liệu cho trang thông tin Trang web là:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName là "site" hoặc miền G Suite.
Tất cả các yêu cầu đến nguồn cấp dữ liệu này phải được xác thực.
Loại yêu cầu được hỗ trợ: GET
, POST
, PUT
, DELETE
Tài liệu tham khảo về tham số truy vấn của Google Sites
Các tham số truy vấn được hỗ trợ trong giao thức API Dữ liệu Google:
max-results
published-max
(chỉ nguồn cấp dữ liệu nội dung)published-min
(chỉ nguồn cấp dữ liệu nội dung)start-index
updated-max
updated-min
q
(truy vấn văn bản đầy đủ)
Bạn có thể 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 đó.