Skip to content

RepositoryFeedJapanese

Jump to bottom
Ryo Kawaguchi edited this page Mar 14, 2015 · 2 revisions

以下は Person Finder Repository Feed の日本語訳です。

アクティブなレポジトリーのリストを Atom フィード経由で取得することができます。このフィードを使うことで、新しいレポジトリーが追加されたことや、既存のレポジトリーが閉じられたことを自動的に知ることができます。

フィード URL

すべてのアクティブなレポジトリーのリストを含むグローバルフィードは以下から取得できます。

http://www.google.org/personfinder/global/feeds/repo

また個別のレポジトリーのみについて知りたい場合は、以下の単一レポジトリーフィードを利用してください。

http://www.google.org/personfinder/repository/feeds/repo

これらのフィードはすべて Atom 形式です。グローバルフィードはアクティブなレポジトリー当たり 1 つのエントリーを持っています。単一レポジトリーフィードは指定されたレポジトリーに対応するエントリーを 1 つだけ持ちます。

Atom フィードのエントリーは以下に列挙されているカスタム要素によって構成されています。カスタム要素の XML 名前空間は以下の通りです。

http://schemas.google.com/personfinder/2012 (名前空間接頭辞には gpf を用います).

新しいレポジトリーが追加された際には、新しいエントリーがフィードにも追加されます。既存のレポジトリーが閉じられた際には、対応するエントリーがフィードから削除されます。

エントリーの詳細

Atom エントリーはそれぞれ以下の標準要素を含みます。

  • <id> 要素はレポジトリーのスタートページの URL を表します。これは該当するレポジトリーの固有識別子として使うことができます。
  • <title> 要素は既定の言語におけるレポジトリーのタイトルを表します。この要素は xml:lang 属性を持ち、既定言語が何であるかを表します。
  • <published> 要素はレポジトリーが最初にアクティブになった日時を表します。
  • <updated> 要素はレポジトリーの有効・無効、またはテストモード・リアルモードが最後に切り替わった日時を表します。これは基本的には <published> と同じ値ですが、レポジトリーがテストモードで立ち上げられ、その後リアルモードに切り替えられた場合、切り替えの日時を表します。

Atom エントリーの <content> 要素は唯一の要素である <gpf:repo> で構成されます。<gpf:repo> 要素は以下のカスタム要素で構成されます。

  • <gpf:title>: レポジトリーのタイトルを表します。レポジトリーが対応している言語ごとに、1 つの <gpf:title> があり、xml:lang 属性がその言語を表します。そのため、複数の言語に対応している場合は複数の <gpf:title> が存在します。
  • <gpf:read_auth_key_required>: API 経由でレコードを読み込む際に API キーが必要な場合、文字列の true を含みます。
  • <gpf:search_auth_key_required>: API 経由でレコードを検索する際に API キーが必要な場合、文字列の true を含みます。
  • <gpf:location>: レポジトリーに関連した災害・事故のおおよその位置を GeoRSS point 形式で表します。GeoRSS point は <georss:point> 要素で表され、緯度経度を半角スペースで区切ったフォーマットとなります。
  • <gpf:test_mode>: レポジトリーがテストモードに設定されている場合は、文字列の true を含みます。テストモードでは、レコードは 6 時間を経過すると自動的に削除されます。
Clone this wiki locally