リファレンス ガイド

このドキュメントは、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 は「サイト」または G Suite ドメインです。

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

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

サポートされているリクエストの種類: GET

コンテンツ フィード

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

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

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

domainName は「サイト」または G Suite ドメインです。

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

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

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

標準の Data API クエリ パラメータに加えて、Sites 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

リビジョン フィード

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

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

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

domainName は「サイト」または G Suite ドメインです。

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

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

サポートされているリクエストの種類: GET

サイトフィード

サイトフィードは、ユーザーが所有する、または閲覧権限がある Google サイトをリストするために使用できます。また、新しいサイトの作成、サイトのコピー、既存のサイト名の変更にも使用できます。

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

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

domainName は「サイト」または 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 は「サイト」または G Suite ドメインです。

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

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

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

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

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

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

トップへ戻る