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) 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 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 các phần dành riêng cho ngôn ngữ lập trình của hướng dẫn dành cho 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.

Đâ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.

Loại nguồn cấp dữ liệu của Google Sites

API Dữ liệu của Google Sites cung cấp các 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 là "trang web" hoặc miền G Suite.

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

Tất cả cá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 là "trang web" hoặc 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 xác thực hoặc không, 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 API Dữ liệu tiêu chuẩn, API Dữ liệu trang web cho phép các tham số không bắt buộc sau đây phát hành yêu cầu GET bằng nguồn cấp dữ liệu Nội dung:

Thông số Mô tả Loại Ghi chú
ancestor Chỉ yêu cầu các mục có thành phần cấp trên được chỉ định. chuỗi Cung cấp mã nhận dạng của mục nhập cấp trên mong 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ư một cấp độ mẹ, cấp độ mẹ, v.v.
include-deleted Chỉ định xem 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 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 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 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 Giá trị có thể là announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent Chỉ yêu cầu các mục nhập có phần tử mẹ đượ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 trong một hệ 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 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à "trang web" hoặc miền G Suite.

siteName là tên trang web xuất hiện trong URL của 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. Bạn cũng có thể sử dụng mã 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 nguồn cấp dữ liệu cho trang thông tin Trang web 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ố (không bắt buộc) sau đây khi đưa ra yêu cầu GET để đăng trang web:

Thông 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 trong miền G Suite ít nhất có thể xem được. boolean Tham số này chỉ áp dụng khi bạn đăng trang web cho một miền G Suite. Các 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 địa chỉ web trong một mục 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

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 của 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ả cá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

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

  • 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 đủ)

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