本文詳細說明 Google 協作平台 Data API 原始通訊協定 (XML 和 HTTP) 的參考資料。
本文不包含程式設計語言用戶端程式庫的相關資訊。如需用戶端程式庫的參考資訊,請參閱開發人員指南中各個程式設計語言專屬部分的連結。
觀眾
本文適用於想編寫可與 Google 協作平台互動的用戶端應用程式的程式設計師。
這份文件是參考資料,假設您已瞭解通訊協定指南中介紹的概念,以及 Google Data API 通訊協定背後的整體概念。
Google 協作平台動態饋給類型
Google 協作平台資料 API 提供下列類型的動態消息:
活動動態消息
「活動」動態消息會顯示網站內所有活動的說明。
特定網域中網站的 GET URI 如下:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName 可以是「site」或 G Suite 網域。
siteName 是網站到達網頁網址中顯示的網站名稱:http://sites.google.com/a/domainName/siteName/。
所有對這個動態饋給提出的要求都必須經過驗證。
支援的要求類型:GET
內容動態饋給
內容動態饋給是包含目前可編輯網站內容的動態饋給。
特定網域中網站的 GET URI 為:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName 可以是「site」或 G Suite 網域。
siteName 是網站到達網頁網址中顯示的網站名稱:http://sites.google.com/a/domainName/siteName。
視網站 (發布) 設定而定,對這個動態消息的請求可能需要或不需要驗證。
支援的請求類型:GET、POST、PUT、DELETE
除了標準 Data API 查詢參數,Sites Data API 也允許使用下列選用參數,透過 Content 動態饋給發出 GET 要求:
| 參數 | 說明 | 類型 | 附註 |
|---|---|---|---|
ancestor |
只要求具有指定祖先的項目。 | 字串 | 提供所需祖先項目的 ID。例如:0123456789。傳回所有以指定祖先為父項、父項的父項等項目的項目。 |
include-deleted |
指定是否要納入已刪除的項目。 | 布林值 | 可能的值為 true 或 false。預設值為 false。 |
include-draft |
指定是否要納入草稿項目。 | 布林值 | 可能的值為 true 或 false。預設值為 false。您必須是草稿的擁有者或作者,才能查看草稿。 |
kind |
指定要傳回的內容項目類型。這些設定會依據 Google 協作平台中的網頁類型而有所不同。 | 以半形逗號分隔的字串清單 | 可能的值為 announcement、announcementspage、attachment、comment、filecabinet、listitem、listpage、webpage、webattachment、template。 |
parent |
只要求具有指定父項的項目。 | 字串 | 提供父項項目的 ID。例如:0123456789。 |
path |
要求特定網頁階層下的內容 | 字串 | 要擷取內容的 Google 協作平台子頁面路徑。例如:path=/path/to/page。 |
修訂版本動態消息
修訂版本動態消息:包含網站內容的歷史修訂版本。
特定網域中網站的 GET URI 為:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName 可以是「site」或 G Suite 網域。
siteName 是網站到達網頁網址中顯示的網站名稱:http://sites.google.com/a/domainName/siteName。
所有對這個動態饋給提出的要求都必須經過驗證。
支援的要求類型:GET
網站動態饋給
網站動態消息可用於列出使用者擁有或具有檢視權限的 Google 協作平台。您也可以使用這項功能建立新網站、複製網站,或修改現有網站的名稱。
網站資訊的動態饋給 URI 為:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName 可以是「site」或 G Suite 網域。
所有對這個動態饋給提出的要求都必須經過驗證。
支援的要求類型:GET、POST、PUT
發出 GET 要求列出網站時,網站動態饋給支援下列 (選用) 參數:
| 參數 | 說明 | 類型 | 附註 |
|---|---|---|---|
include-all-sites |
列出使用者在 G Suite 網域中至少可以檢視的所有網站。 | 布林值 | 這項參數僅適用於列出 G Suite 網域的網站。可能的值為 true 或 false。預設值為 false。 |
with-mappings |
包括網站條目中的網址對應。 | 布林值 | 可能的值為 true 或 false。預設值為 false。 |
ACL 動態饋給
ACL 資訊主頁可用於列出及/或修改 Google 協作平台的共用權限 (ACL)。
網站資訊的動態饋給 URI 為:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName 可以是「site」或 G Suite 網域。
所有對這個動態饋給提出的要求都必須經過驗證。
支援的請求類型:GET、POST、PUT、DELETE
Google 協作平台查詢參數參考資料
Google Data API 通訊協定支援的查詢參數:
max-resultspublished-max(僅限內容動態消息)published-min(僅限內容動態消息)start-indexupdated-maxupdated-minq(完整文字查詢)
如需各動態饋給的專屬參數清單,請參閱上方的各動態饋給。