リファレンス ガイド

このドキュメントでは、Google Sites Data API の RAW プロトコル(XML と HTTP)の詳細なリファレンス ドキュメントを提供します。

このドキュメントには、プログラミング言語のクライアント ライブラリに関する情報は含まれていません。クライアント ライブラリのリファレンス情報については、デベロッパー ガイドのプログラミング言語固有のセクションにあるリンクをご覧ください。

対象

このドキュメントは、Google サイトと連携するクライアント アプリケーションを作成するプログラマーを対象としています。

これはリファレンス ドキュメントです。プロトコル ガイドに示されているコンセプトと、Google Data API プロトコルの一般的なコンセプトを理解していることを前提としています。

Google サイトのフィードタイプ

Google Sites Data API には、次のタイプのフィードが用意されています。

アクティビティ フィード

アクティビティ フィードは、サイト内のすべてのアクティビティの説明を含むフィードです。

特定のドメイン内のサイトのフィード URI GET は次のようになります。

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

domainName は &site または G Suite ドメインです。

siteName は、サイトのランディング ページ URL に表示されるサイト名です(http://sites.google.com/a/domainName/siteName/)。

このフィードへのリクエストはすべて認証を受ける必要があります。

サポートされているリクエスト タイプ: GET

コンテンツ フィード

コンテンツ フィードは、現在の編集可能なサイト コンテンツを含むフィードです。

特定のドメイン内のサイトのフィード URI GET は次のようになります。

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

domainName は &site または G Suite ドメインです。

siteName は、サイトのランディング ページ URL(http://sites.google.com/a/domainName/siteName)に表示されるサイト名です。

このフィードへのリクエストは、サイト(公開済み)の設定によって認証が必要になる場合とそうでない場合があります。

サポートされているリクエスト タイプ: GETPOSTPUTDELETE

標準の Data API クエリ パラメータに加えて、Site Data API では、コンテンツ フィードを使用して GET リクエストを発行する次のオプション パラメータも使用できます。

パラメータ 説明 種類 備考
ancestor 指定された祖先を持つエントリのみをリクエストします。 文字列 目的の祖先エントリの ID を指定します。例: 0123456789指定した祖先を親や、親の親などとするすべてのエントリを返します。
include-deleted 削除されたエントリを含めるかどうかを指定します。 boolean 有効な値は true または false です。デフォルトは false です。
include-draft 下書きのエントリを含めるかどうかを指定します。 boolean 有効な値は true または false です。デフォルトは false です。下書きを表示するには、下書きのオーナーまたは作成者である必要があります。
kind 返されるコンテンツ エントリの種類を指定します。Google サイトのページの種類と同じです。 カンマ区切りの文字列リスト 有効な値は announcementannouncementspageattachmentcommentfilecabinetlistitemlistpagewebpagewebattachmenttemplate です。
parent 指定した親を持つエントリのみをリクエストします。 文字列 親エントリの ID を指定します。例: 0123456789
path 特定のページ階層でコンテンツがリクエストされる 文字列 コンテンツを取得するサイト内のサブページへのパス。例: path=/path/to/page

リビジョン フィード

リビジョン フィードは、サイト コンテンツの過去のリビジョンを含むフィードです。

特定のドメイン内のサイトのフィード URI GET は次のようになります。

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 サイトを一覧表示できます。新しいサイトの作成、サイトのコピー、既存のサイト名の変更にも使用できます。

サイト リスティングのフィード URI は次のとおりです。

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

domainName は &site または G Suite ドメインです。

このフィードへのリクエストはすべて認証を受ける必要があります。

サポートされているリクエスト タイプ: GETPOSTPUT

サイトフィードでは、リスティングのサイトに関する GET リクエストを発行する際に、次の(オプション)パラメータがサポートされます。

パラメータ 説明 種類 備考
include-all-sites 少なくとも G Suite ドメインのユーザーが表示できるすべてのサイトを一覧表示します。 boolean このパラメータは、G Suite ドメインのサイトを一覧表示する場合にのみ適用されます。有効な値は true または false です。デフォルトは false です。
with-mappings サイト エントリにウェブアドレスのマッピングを含めます。 boolean 有効な値は true または false です。デフォルトは false です。

ACL フィード

ACL フィードを使用して、Google サイトの共有権限(ACL)の一覧表示や変更を行うことができます。

サイト リスティングのフィード URI は次のとおりです。

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

domainName は &site または G Suite ドメインです。

このフィードへのリクエストはすべて認証を受ける必要があります。

サポートされているリクエスト タイプ: GETPOSTPUTDELETE

Google サイトのクエリ パラメータ リファレンス

Google Data API プロトコルでサポートされるクエリ パラメータ:

  • max-results
  • published-max(コンテンツ フィードのみ)
  • published-min(コンテンツ フィードのみ)
  • start-index
  • updated-max
  • updated-min
  • q(全文クエリ)

各フィードに固有のパラメータのリストについては、上記の各フィードをご覧ください。

トップへ戻る