Hướng dẫn tham chiếu

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) dành cho Google Sites Data API.

Tài liệu này không chứa thông tin về thư viện ứng dụng của 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 đường liên kết trong phần dành riêng cho ngôn ngữ lập trình trong tài liệu hướng dẫn của nhà phát triển.

Đối tượng

Tài liệu này dành cho các 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.

Đó là một tài liệu tham khảo; Hướng dẫn này giả định rằng bạn hiểu rõ các khái niệm được trình bày trong hướng dẫn về giao thức cũng như các ý tưởng chung về giao thức API dữ liệu của Google.

Các loại nguồn cấp dữ liệu Google Sites

Google Sites Data API cung cấp những loại nguồn cấp dữ liệu sau:

Trang Hoạt động

Nguồn cấp dữ liệu Hoạt động là nguồn cấp dữ liệu chứa nội dung mô tả về tất cả cá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 có thể là "trang web" hoặc miền G Suite.

siteName là tên trang web như xuất hiện trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName/.

Tất cả yêu cầu đối với nguồn cấp dữ liệu này phải được xác thực.

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à một nguồn cấp dữ liệu chứa nội dung hiện tại, có thể chỉnh sửa của 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/content/domainName/siteName/[contentEntryID]

domainName có thể là "trang web" hoặc miền G Suite.

siteName là tên trang web như xuất hiện trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName.

Yêu cầu gửi đến nguồn cấp dữ liệu này có thể cần hoặc không cần 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 chuẩn, Sites Data API cho phép các tham số không bắt buộc sau đưa ra yêu cầu GET bằng nguồn cấp nội dung:

Thông số Mô tả Loại Ghi chú
ancestor Chỉ yêu cầu các 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 mục nhập đối tượng cấp trên mà bạn muốn. Ví dụ: 0123456789. Trả về tất cả các mục nhập có đối tượng cấp trên được chỉ định như cấp độ mẹ, cấp độ mẹ, v.v.
include-deleted Chỉ định xem có bao gồm các mục nhập đã xoá hay không. boolean Giá trị có thể là true hoặc false. Mặc định là false.
include-draft Chỉ định xem có đưa các mục nhập nháp hay không. boolean Giá trị có thể là 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 để xem.
kind Chỉ định(các) loại mục nhập nội dung cần trả về. Những trang 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ể sử dụng là announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent Chỉ yêu cầu các mục nhập có cha mẹ đượ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ệ phân cấp trang nhất định string Đường dẫn đến 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 của bản sửa đổi

Nguồn cấp dữ liệu bản sửa đổi là một 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 có thể là "trang web" hoặc miền G Suite.

siteName là tên trang web như xuất hiện trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName.

Tất cả yêu cầu đối với nguồn cấp dữ liệu này phải được xác thực.

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 này để liệt kê những trang web tạo bằng Google Sites mà người dùng sở hữu hoặc có quyền xem. Cũng có thể được dùng để 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 nguồn cấp dữ liệu cho trang thông tin trên Sites là:

https://sites.google.com/feeds/site/domainName/[siteName]

domainName có thể là "trang web" hoặc miền G Suite.

Tất cả yêu cầu đối với nguồn cấp dữ liệu này phải được xác thực.

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 gửi yêu cầu GET để liệt kê các trang web:

Thông số Mô tả Loại Ghi chú
include-all-sites Liệt kê tất cả trang web mà ít nhất người dùng có thể xem 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. Các giá trị có thể sử dụng là true hoặc false. Mặc định là false.
with-mappings Đưa mục ánh xạ địa chỉ web vào mục nhập trang web. boolean Giá trị có thể là 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 sử dụng để liệt kê và/hoặc sửa đổi quyền chia sẻ (ACL) của một trang web trên Google.

URI nguồn cấp dữ liệu cho trang thông tin trên Sites là:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName có thể là "trang web" hoặc miền G Suite.

Tất cả yêu cầu đối với nguồn cấp dữ liệu này phải được xác thực.

Cá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

Tham số truy vấn được hỗ trợ từ giao thức Google Data API:

  • max-results
  • published-max (chỉ nguồn cấp nội dung)
  • published-min (chỉ nguồn cấp nội dung)
  • start-index
  • updated-max
  • updated-min
  • q (truy vấn văn bản đầ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 đó.

Trở lại đầu trang