=========================== レスポンス =========================== .. _responses-user: ------------------- ユーザーレスポンス ------------------- http://developer.foursquare.com/docs/responses/user.html .. list-table:: :stub-columns: 1 :widths: 10 90 * - id - このユーザの一意な識別子 * - firstName - このユーザの名前 * - lastName - このユーザの苗字 * - homeCity - このユーザの都市 * - photo - このユーザのプロファイル写真へのURL * - gender - 性別。 `male` か `famale` です * - relationship - **オプション** 現在有効なユーザ(me)とこのユーザ(them)との関係を示 します。 以下のうちのどれかです。 - `self` - `friend` - `pendingMe` 他のユーザがfriend申請を送っているが、承認されて いない状態 - `pendingThem` 現在有効なユーザが他のユーザにfriend申請を送っ ているが、承認されていない状態 - `followingThem` 現在有効なユーザがcelebrityかbrandをfollowしている もし、ユーザ間がなんの関係もなく、friend申請も送っていない場合は、 このフィールドはありません。もし、現在有効なユーザがcelebrityの場 合、誰がfollowしているかという情報は含まれません。 `pendingMe` の場合、アプリケーションは現在有効なユーザに承認/否認 のアクションを要求するでしょう。また、 `pendingThem` の場合、アプ リケーションは "承認待ち"と表示するでしょう ユーザの詳細 .. list-table:: :stub-columns: 1 :widths: 10 90 * - type - `brand` `celebrity` `user` のどれか。ユーザは以下の関係を celebrity と結ぶことが出来ます * - contact - `twitter` `facebook` `email` `phone` あるいは `none` 。全て文字列です * - pings - **オプション** なんらかの関係があれば、このユーザからpingを受け取るかどうかを示します * - badges - このユーザのbadgeの数を示す `count` を含みます。他の選択したbadgeを含む場合もあります。 badgeのリストを得たい場合は:ref:`user/XX/badges` を使ってください。 * - checkins - このユーザのcheckinの数を示す `count` を含みます。もしこのユーザ がfriendの場合、最近のcheckinの履歴を `items` の配列として含みます * - mayorships - このユーザのmayorshipの数を示す `count` を含みます。mayorshipが一 つでもあれば、mayorshipを `items` の配列として含みます。これは空白の場合があります。 * - tips - このユーザのtipsの数を示す `count` を含みます。選択したtipsを `items` の 配列として含みます。これは空白の場合があります。全てのtipsを得た い場合は :ref:`users/XXX/tips` を使ってください。 * - todos - このユーザのtodoの数を示す `count` を含みます。選択したtodoを `items` の配列として含みます。これは空白の場合があります。全ての todoを得たい場合は :ref:`users/XXX/todos` を使ってく ださい。ただし、friendからしか得られません * - friends - このユーザのfriendの数を示す `count` とfriendの `groups` を含みま す。現在のところ `type` が `friend` なグループしか含まれませんが、 将来的に変更される可能性があります。 `self` の場合、グループは省 略されます。全てのfriendを得たい場合は、 :ref:`users/XXX/friends` を使用してください。 * - followers - もし、brandかcelebrityがあれば、このユーザのfollowerの `count` を含みます * - requests - 処理待ちのfriend申請の `count` を含みます .. _responses-venue: --------------- Venueレスポンス --------------- http://developer.foursquare.com/docs/responses/venue.html 主要なvenueフィールド .. list-table:: :stub-columns: 1 :widths: 10 90 * - id - このvenueの一意な文字列 * - name - このvenueの一番知られている名前 * - verified - この場所の事業主が情報が正しいと承認しているかどうか * - contact - none、some、あるいは `twitter` と `phone` 。両方共文字列です * - location - none、some、あるいは以下の情報が含まれます。 `address(通りの住 所)` 、 `crossStreet` 、 `city` 、 `state` 、 `postalCode` 、 `country` 、 `lat` 、 `lng` 、 `distance` 。 geolat、 geolong、 distance以外のフィールドは文字列です * - categories - このvenueが割り当てられたカテゴリーの配列で、空の場合もあります。 カテゴリーの一つには `primary` フィールドがあり、これが一つ目のカ テゴリーになります。全てのカテゴリーは `id` 、 `icon` URL、 `parents` (より詳細な情報を示す親カテゴリの配列)のフィールドを持 ちます。カテゴリーの詳細を見たい場合は、 :ref:`venue/categories` を見てください * - specials - **オプション** このフィールドがある場合は、空の場合もある配列であ り、このvenueのspecialを示します。それぞれのspecialは、文字列で `id` 、 `type` 、 `message` 、 `description` 、さらにもし活動中の ユーザであれば `unlocked` が含まれます * - hereNow - **オプション** 今ここに誰がいるのかという情報を示します。このフィー ルドがある場合は常に、人数を示す `count` が含まれます。もし詳細を 観る場合で、ユーザがログインしている場合は `friends` と`type` と しての `others` フィールドを持つ、 `groups` フィールドも含まれま す venueの詳細を表示するときのフィールドです。 .. list-table:: :stub-columns: 1 :widths: 10 90 * - stats - ここに何回checkinしたかを示す `checkinsCount` とここに今まで何人 のユーザがcheckinしたかを示す `usersCount` が含まれます * - mayor - `user` はここのmayorの :ref:`user` です。mayorが いない場合はありません。 `count` は過去60日間で何回checkinしたか を示します * - tips - tipsの数を示す `count` 、 `friend` を含む `groups` 、 `groupTypes` としての `others` が含まれます。groupは時間と共に変 更されます * - todos - 現在のユーザがこのVenueにつけたtodoです。もしユーザがログインして いない場合はありません * - tags - このVenueに付けられたタグ * - beenHere - 現在のユーザがこのVenueにcheckinした回数です。もしユーザがログイ ンしていない場合はありません。 * - shortUrl - このVenueを表すURL。例: http://4sq.com/Ab123D * - specialsNearby - このVenue近くの :ref:`special` 訳註: このspecialのレスポンスの解説が見つかりません .. _responses-tips: ------------------------- tipsのレスポンス ------------------------- http://developer.foursquare.com/docs/responses/tip.html .. list-table:: :widths: 10 90 :stub-columns: 1 * - id - このtipsの一意な識別子 * - text - 実際のtips * - createdAt - このtipsが作成された時刻のエポックタイムからの秒数 * - status - **オプション** ユーザのtipsに対する関係に応じて `todo` か `done` の どちらかになります。もしもなにも関係がない場合はこのフィールドはありません * - user - **オプション** もし、複数のユーザからのtipsがある場合は、このtipsを 作成した :ref:`responses-user` が返されます * - venue - **オプション** もし、複数のvenueからのtipsがある場合は、このtipsを 作成した :ref:`responses-venue` が返されます tipsの詳細表示時のみ表示されるフィールド .. list-table:: :widths: 10 90 :stub-columns: 1 * - todo - このtipsをTODOにした人の数を示す `count` 、TODOにした `friend` 全 てを含む `groups` を含みます。groupsが含む情報は今後変わる可能性 があります(TODOはfriendにしか見えないことに注意してください) * - done - このtipsをdoneにした人の数を示す `count` 、doneにした `friend` 全 てと `others` を含む `groups` を含みます。groupsが含む情報は今後 変わる可能性があります .. _responses-checkin: ----------------------- checkinレスポンス ----------------------- http://developer.foursquare.com/docs/responses/checkin.html .. list-table:: :widths: 10 90 :stub-columns: 1 * - id - このcheckinを示す一意な識別子 * - type - `checkin` 、 `shout` 、 `venueless` のどれか * - private - **オプション** もしこれがあるならば、このcheckinは private と印が つけられ、friendには送られません。その場合、持ち主がこのデータを 見るときのみ、このcheckinの情報が含まれます * - user - **オプション** コンテキスト(訳註: 状況か)から明らかではない場合、 :ref:`簡略版ユーザレスポンス` が示されます * - venue - **オプション** コンテキスト(訳註: 状況か)から明らかではない場合、 かつ、このcheckinがvenueに対して行われたものである場合、 :ref:`簡略版venueレスポンス` が返されます。 * - location - **オプション** もし、このcheckinの `type` が `shout` か `venueless` の場合、このフィールドが含まれ、 `lat` と `lng` のペ アと、ユーザの現在の位置を表す構造化されていない `name` が含まれます * - shout - **オプション** checkin時のメッセージです。もし、shoutがあり、かつ、 現在のユーザが見ることが出来れば表示されます。 * - createdAt - このcheckinが作られた時間を示す、エポックタイムからの秒数 * - source - **オプション** もしこれがあるならば、このcheckinを作成するのに使 用したアプリケーションの `name` と `url` が含まれます .. _responses-todo: ----------------------- TODOレスポンス ----------------------- http://developer.foursquare.com/docs/responses/todo.html .. list-table:: :widths: 10 90 :stub-columns: 1 * - id - このTODOの一意な識別子。 * - createdAt - このTODOが作られた時間を示す、エポックタイムからの秒数 * - tip - todoであるtipを示します。ユーザが :ref:`venue/XXX/marktodo` を呼び出した場合、ユー ザがそのvenueにいく意図があるというtip は暗黙のうちに作成される点 に注意してください .. _response-notification: ----------------- Notification ----------------- http://developer.foursquare.com/docs/responses/notifications.html .. The notifications field of the response will contain notifications that request just made (such as a checkin, tip, etc.) In the future, the notifications field may contain notifications related to earlier actions. Expect the format of these objects to evolve over time, The field is an array of the form レスポンスの中のnotificationフィールドは、リクエスト(checkinやtipなど) によって作られたことの通知をふくんでいます。将来的に、notificationフィー ルドは以前のアクションに関連する通知を含むようになるかもしれません。こ れらのオブジェクトのフォーマットは徐々に変わっていきますが、以下にその 例を示します。 :: {... "notifications": [ { "type": "sometype", "item": ... },.. ], ... } .. list-table:: :stub-columns: 1 :header-rows: 1 :widths: 10 90 * - type - item * - `badge` - このアクションの結果取得した :ref:`badge` 。 checkinの後、0か1かそれ以上が含まれます。 * - `tip` - 現在有効なユーザのvenueか近隣のvenueにある、推薦された :ref:`tips` * - `score` - `points` 、 `icon` 、 `messages` を持つオブジェクトの配列を示す `scores` を含みます。また、 `total` も含みます * - `mayorship` - 以下の情報を含みます。 - `checkins` : 現在有効なユーザが過去60日以内に行ったcheckinの数 - `type` : `nochange` 、 `new` 、 `stolen` のどれか - `daysBehind` : **オプション** このユーザがmayorではなくなった時からの日数 - `user` : **オプション** 今現在あるいは過去にmayorで、現在有効なユーザではないユーザ - `message` : 現在有効なユーザに表示するためのメッセージ - `image` : 現在のmayorかcrownの画像 * - `message` - ユーザに表示するためのメッセージです。例: "Thanks for the tip!" .. _responses-badge: ------- Badge ------- http://developer.foursquare.com/docs/responses/badge.html .. list-table:: :stub-columns: 1 :widths: 10 90 * - id - このbadgeの一意な識別子です。if locked, or this user's specific unlock of this badge, if unlocked. (訳註: 英文不明) * - badgeId - **オプション** 正規化された一意な識別子 * - name - このbadgeの名前 * - description - このbadgeに関する追加の情報 * - image - 様々なサイズの画像を作成するための情報です。 `prefix` に `size` と `name` をくっつけてください。例: http://foursquare.com/img/badge/57/newbie.png lockされているbadgeの場合、このフィールドはbadgeのlockされている画像を示します * - unlocks - **オプション** もしこのフィールドがある場合、unlockされた情報の配 列が含まれます。さらに、checkinの情報を示す `checkins` の配列が含 まれます。現在のところ両方の配列ともエントリは一つだけです .. _responses-photo: ---------------------- 写真レスポンス ---------------------- http://developer.foursquare.com/docs/responses/photo.html .. list-table:: :stub-columns: 1 :widths: 10 90 * - id - この写真を表す一意な識別子 * - createdAt - この写真が作成された、エポックタイムからの秒数 * - url - オリジナルの写真がuploadされたURL * - sizes - `count` が提供されるサイズ、 `items` がサポートされているサイズの 配列です。それぞれのsizeは `url` 文字列、 `width` 、 `height` の数 値を含みます。最初のアイテムはオリジナルの写真のサイズで、続くア イテムは生成された写真のサイズです。生成された写真のサイズがURL と共に返されますが、そのURLがそのまま有効であるとは限りません * - source - **オプション** このフィールドがある場合、 `name` と `url` はこの 写真を作成するのに使用したアプリケーション名とURLです * - user - **オプション** ユーザが誰か分からない場合、 :ref:`簡易ユーザレスポンス` が含まれます * - tip - **オプション** tipが不明な場合、 :ref:`簡易tipレスポンス` が含まれます * - checkin - **オプション** checkinが不明な場合、 :ref:`簡易checkinレスポンス` が含まれます