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 cho 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ề thư viện ứng dụng dành cho ngôn ngữ lập trình. Để biết thông tin tham khảo thư viện ứng dụng, hãy xem các liên kết từ phần ngôn ngữ lập trình cụ thể trong hướng dẫn của nhà phát triển.

Đối tượng người xem

Tài liệu này dành cho các lập trình viên muốn viết các ứng dụng khách có thể tương tác với Google Sites.

Đây là tài liệu tham khảo; 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 của giao thức API Dữ liệu của Google.

Các loại nguồn cấp dữ liệu trên 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 dành 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 là một 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ả các yêu cầu gửi đến 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 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 hiện có thể chỉnh sửa được của trang web.

URI GET của nguồn cấp dữ liệu này dành 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 là một miền G Suite.

siteName là tên trang web giống như trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName.

Các 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 API Dữ liệu tiêu chuẩn, API Dữ liệu trang web còn cho phép các tham số không bắt buộc sau đây tạo yêu cầu GET bằng nguồn cấp dữ liệu Nội dung:

Thông số Nội dung 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 đã chỉ định là thành phần mẹ, thành phần mẹ của thành phần mẹ, v.v.
include-deleted Chỉ định xem có đưa vào 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 việc có đưa vào 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 được bản nháp đó.
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 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ó thư mục mẹ đã chỉ định. string Cung cấp mã nhận dạng của mục nhập chính. 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 của 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 dành 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 là một miền G Suite.

siteName là tên trang web giống như trong URL trang đích của trang web: http://sites.google.com/a/domainName/siteName.

Tất cả các yêu cầu gửi đến 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

Nguồn cấp dữ liệu trang web có thể dùng để 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ể dùng API này để tạo trang web mới, sao chép một 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 trên Sites là:

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

domainName là "trang web" hoặc là một miền G Suite.

Tất cả các yêu cầu gửi đến 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 đưa ra yêu cầu GET cho các trang web liệt kê:

Thông số Nội dung 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. Giá trị có thể là true hoặc false. Mặc định là false.
with-mappings Đưa các mục ánh xạ địa chỉ web vào 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

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 được tạo bằng Google Sites.

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 là "trang web" hoặc là một miền G Suite.

Tất cả các yêu cầu gửi đến 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 đủ)

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 đó.

Trở lại đầu trang