このドキュメントでは、Google サイト データ API の raw プロトコル(XML と HTTP)の詳細なリファレンス ドキュメントを提供します。
このドキュメントには、プログラミング言語のクライアント ライブラリに関する情報は含まれていません。クライアント ライブラリのリファレンス情報については、デベロッパー ガイドのプログラミング言語固有のセクションのリンクをご覧ください。
オーディエンス
このドキュメントは、Google サイトとやり取りできるクライアント アプリケーションを作成するプログラマーを対象としています。
このドキュメントはリファレンス ドキュメントです。プロトコル ガイドで説明されている概念と、Google Data APIs プロトコルの背後にある一般的な考え方を理解していることを前提としています。
Google サイトのフィードタイプ
Google サイト データ 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
Sites Data API では、標準の 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-resultspublished-max(コンテンツ フィードのみ)published-min(コンテンツ フィードのみ)start-indexupdated-maxupdated-minq(全文クエリ)
フィード固有のパラメータの一覧については、上記の各フィードをご覧ください。