このドキュメントでは、Google Sites Data API で使用される raw プロトコル(XML と HTTP)に関する詳細なリファレンス ドキュメントです。
このドキュメントには、プログラミング言語のクライアント ライブラリに関する情報は記載されていません。クライアント ライブラリのリファレンス情報については、デベロッパー ガイドのプログラミング言語固有のセクションにあるリンクをご覧ください。
オーディエンス
このドキュメントは、Google サイトとやり取りできるクライアント アプリケーションを作成するプログラマーを対象としています。
リファレンス ドキュメントである。プロトコル ガイドに記載されている概念と Google Data API プロトコルの背後にある一般的な概念を理解していることを前提としています。
Google サイトのフィードの種類
Google sites Data API では、次のタイプのフィードが提供されています。
アクティビティ フィード
アクティビティ フィードは、サイト内のすべてのアクティビティの説明を含むフィードです。
特定のドメイン内のサイトを示す、このフィードの GET
URI は次のとおりです。
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName は「site」または G Suite ドメインです。
siteName は、サイトのランディング ページ URL(http://sites.google.com/a/domainName/siteName/)に表示されるサイト名です。
このフィードに対するリクエストはすべて認証する必要があります。
サポートされているリクエスト タイプ: GET
コンテンツ フィード
コンテンツ フィードは、編集可能な現在のサイト コンテンツを含むフィードです。
特定のドメイン内のサイトを示す、このフィードの GET
URI は次のとおりです。
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName は「site」または G Suite ドメインです。
siteName は、サイトのランディング ページ URL(http://sites.google.com/a/domainName/siteName)に表示されるサイト名です。
このフィードに対するリクエストでは、サイトの(公開中の)設定に応じて、認証が必要になる場合と必要でない場合があります。
サポートされているリクエスト タイプ: GET
、POST
、PUT
、DELETE
標準の Data API クエリ パラメータに加えて、Sites Data API では次のオプション パラメータを使用できます。
コンテンツ フィードを使用して 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 |
特定のページ階層内のコンテンツをリクエストする | 文字列 | コンテンツを取得するサイト内のサブページのパス。例: path=/path/to/page 。 |
リビジョン フィード
変更履歴フィードは、サイト コンテンツの変更履歴を含むフィードです。
特定のドメイン内のサイトを示す、このフィードの GET
URI は次のとおりです。
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName は「site」または G Suite ドメインです。
siteName は、サイトのランディング ページ URL(http://sites.google.com/a/domainName/siteName)に表示されるサイト名です。
このフィードに対するリクエストはすべて認証する必要があります。
サポートされているリクエスト タイプ: GET
サイトフィード
サイトフィードを使用すると、ユーザーが所有する Google サイト、または閲覧権限のある 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-results
published-max
(コンテンツ フィードのみ)published-min
(コンテンツ フィードのみ)start-index
updated-max
updated-min
q
(全文クエリ)
フィードに固有のパラメータのリストについては、上記の各フィードをご覧ください。