月別: 2011年3月

Reference Guide (v1.2)(Google Sites Data API)

http://code.google.com/intl/ja/apis/sites/docs/1.0/reference.html

 Reference Guide (v1.2)

このドキュメントはGoogle Site Data APIの生のプロトコル(XMLとHTTP)についての詳しい参考文書(リファレンス文書)を提供します。このドキュメントはプログラミング言語用クライアントライブラリについての情報を含んでいません。クライアントライブラリのリファレンス情報については、デベロッパガイドのプログラミング言語別のセクションのリンク先を見てください。

 内容

 対象読者

このドキュメントはGoogleサイトと対話することが出来るクライアントアプリケーションを作成したいプログラマーを対象としています。
参考文書です; Developer’s Guideで示される概念と Google Data APIs protocolの背後にある大まかな考えを理解していると仮定します。

 Google サイト フィード タイプ

Google Sites Data API は以下のタイプのフィードを提供します:

アクティビティフィード

アクティビティフィードはサイト内の全てのアクティビティ(活動)を包含するフィードです。
特定のドメイン内にあるサイト用のこのフィードの GET URI は:

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

domainName は”site”またはGoogle Apps ドメインのどちらかです。
siteName はサイトのランディングページのURLに現れるサイトの名前です。: http://sites.google.com/a/domainName/siteName/.
このフィードへの全てのリクエストは認証されていないといけません。
サポートされているリクエストタイプ: GET

コンテントフィード

コンテントフィードは現在の編集可能なサイトのコンテント(内容)を包含するフィードです。
特定のドメイン内にあるサイト用のこのフィードの GET URI は:

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

domainName は”site”またはGoogle Apps ドメインのどちらかです。
siteName はサイトのランディングページのURLに現れるサイトの名前です。: http://sites.google.com/a/domainName/siteName/.
このフィードへのリクエストはサイトの(公開)設定によっては認証が必要です。
サポートされているリクエストタイプ:  GETPOSTPUTDELETE
標準データAPIクエリパラメータに加えて、SiteデータAPIは以下のオプションパラメータがコンテントフィードを使用して  GET リクエストを出すことを可能にします?
パラメータ 説明 Notes
ancestor 指定したアンセスター(祖先)を持つエントリのみをリクエストします。 string 希望のアンセスターエントリのIDを提供します。
例えば:0123456789。ペアレント(親)、ペアレントの
ペアレントのように、指定したアンセスターを持つ
全てのエントリを返します。
include-deleted 削除されたエントリを含むかどうか指定します。 boolean 指定可能な値はtrue または falseです。
デフォルトではfalseです。
include-draft ドラフト(下書き)エントリを含むかどうかを指定します。 boolean 指定可能な値はtrue または falseです。
デフォルトではfalseです。
対象となるドラフトの所有者か著作者(author)
である必要があります。
kind 返されるコンテントエントリの種類を指定します。これらは右に挙げるGoogleサイト内のページタイプです。 カンマで区切られた文字列のリスト 指定可能な値は announcement,
announcementspage,attachment,
commentfilecabinet,
listitemlistpage,webpage,
webattachmenttemplateです。
parent 指定したペアレントを持つエントリのみをリクエストします。 string ペアレントエントリのIDを
提供します。例えば: 0123456789.
path あるページ階層下にある内容をリクエストします。 string 内容を取得して来るサイト内の
サブページへのパス。
例えば: path=/path/to/page.

リビジョンフィード

リビジョンフィードはサイトコンテントの改訂(リビジョン)履歴を包含したフィードです。
特定のドメイン内にあるサイト用のこのフィードの GET URI は:

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



domainName は”site”またはGoogle Apps ドメインのどちらかです。


siteName はサイトのランディングページのURLに現れるサイトの名前です。: http://sites.google.com/a/domainName/siteName/.

このフィードへの全てのリクエストは認証されていないといけません。
サポートされているリクエストタイプ: GET



サイトフィード

サイトフィードはユーザーが所有または閲覧許可を持つGoogleサイトを一覧にするために使用できます。更にサイトフィードは既存サイトの名前変更、サイトのコピー、新しいサイトの作成のために使用できます。
サイト一覧用のフィードURIは:

https://sites.google.com/feeds/site/domainName/[siteName]
domainName は”site”またはGoogle Apps ドメインのどちらかです。

このフィードへの全てのリクエストは認証されていないといけません。

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

サイトフィードはサイトを一覧するための GET リクエストを発生させる時、以下の(任意の)パラメータをサポートします:
パラメータ 説明 Notes
include-all-sites 少なくともGoogle Appsドメイン内でユーザーが観ることが出来る全てのサイトを一覧にします。 boolean GoogleAppsドメインのサイトを一覧にする場合にのみ
このパラメータは利用出来ます。
指定可能な値はtrueまたはfalseです。
デフォルトではfalseです。
with-mappings サイトエントリ内にwebアドレスマッチングを含むかどうか。 boolean 指定可能な値はtrueまたはfalseです。
デフォルトで
falseです。

ACL フィード

ACLフィードはGoogleサイトの共有パーミッション(ACLs)を変更するためや一覧にするために使用できます。
サイト一覧用のフィードURIは:

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



domainName は”site”またはGoogle Apps ドメインのどちらかです。

このフィードへの全てのリクエストは認証されていないといけません。

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

 Google Sites クエリパラメータリファレンス

Google Data API プロトコルのクエリパラメータをサポートします:
  • author
  • max-results
  • published-max (only content feed)
  • published-min (only content feed)
  • start-index
  • updated-max
  • updated-min
  • q (full text-queries)
フィード特有のパラメータのリストについては上記のそれぞれのフィード を見てください。.