レスポンス

ユーザーレスポンス

http://developer.foursquare.com/docs/responses/user.html

id このユーザの一意な識別子
firstName このユーザの名前
lastName このユーザの苗字
homeCity このユーザの都市
photo このユーザのプロファイル写真へのURL
gender 性別。malefamaleです
relationship
オプション 現在有効なユーザ(me)とこのユーザ(them)との関係を示

します。 以下のうちのどれかです。

  • self
  • friend
  • pendingMe他のユーザがfriend申請を送っているが、承認されていない状態
  • pendingThem現在有効なユーザが他のユーザにfriend申請を送っているが、承認されていない状態
  • followingThem現在有効なユーザがcelebrityかbrandをfollowしている

もし、ユーザ間がなんの関係もなく、friend申請も送っていない場合は、このフィールドはありません。もし、現在有効なユーザがcelebrityの場合、誰がfollowしているかという情報は含まれません。

pendingMeの場合、アプリケーションは現在有効なユーザに承認/否認のアクションを要求するでしょう。また、pendingThemの場合、アプリケーションは “承認待ち”と表示するでしょう

ユーザの詳細

type brandcelebrityuserのどれか。ユーザは以下の関係をcelebrity と結ぶことが出来ます
contact twitterfacebookemailphoneあるいはnone。全て文字列です
pings オプションなんらかの関係があれば、このユーザからpingを受け取るかどうかを示します
badges このユーザのbadgeの数を示すcountを含みます。他の選択したbadgeを含む場合もあります。badgeのリストを得たい場合は:ref:user/XX/badges<users-badges>を使ってください。
checkins このユーザのcheckinの数を示すcountを含みます。もしこのユーザがfriendの場合、最近のcheckinの履歴をitemsの配列として含みます
mayorships このユーザのmayorshipの数を示すcountを含みます。mayorshipが一つでもあれば、mayorshipをitemsの配列として含みます。これは空白の場合があります。
tips このユーザのtipsの数を示すcountを含みます。選択したtipsをitemsの配列として含みます。これは空白の場合があります。全てのtipsを得たい場合はusers/XXX/tipsを使ってください。
todos このユーザのtodoの数を示すcountを含みます。選択したtodoをitemsの配列として含みます。これは空白の場合があります。全てのtodoを得たい場合はusers/XXX/todosを使ってください。ただし、friendからしか得られません
friends このユーザのfriendの数を示すcountとfriendのgroupsを含みます。現在のところtypefriendなグループしか含まれませんが、将来的に変更される可能性があります。selfの場合、グループは省略されます。全てのfriendを得たい場合は、users/XXX/friendsを使用してください。
followers もし、brandかcelebrityがあれば、このユーザのfollowerのcountを含みます
requests 処理待ちのfriend申請のcountを含みます

Venueレスポンス

http://developer.foursquare.com/docs/responses/venue.html

主要なvenueフィールド

id このvenueの一意な文字列
name このvenueの一番知られている名前
verified この場所の事業主が情報が正しいと承認しているかどうか
contact none、some、あるいはtwitterphone。両方共文字列です
location none、some、あるいは以下の情報が含まれます。address(通りの住 所)crossStreetcitystatepostalCodecountrylatlngdistance。 geolat、 geolong、distance以外のフィールドは文字列です
categories このvenueが割り当てられたカテゴリーの配列で、空の場合もあります。カテゴリーの一つにはprimaryフィールドがあり、これが一つ目のカテゴリーになります。全てのカテゴリーはidiconURL、parents(より詳細な情報を示す親カテゴリの配列)のフィールドを持ちます。カテゴリーの詳細を見たい場合は、venue/categoriesを見てください
specials オプションこのフィールドがある場合は、空の場合もある配列であり、このvenueのspecialを示します。それぞれのspecialは、文字列でidtypemessagedescription、さらにもし活動中のユーザであればunlockedが含まれます
hereNow オプション今ここに誰がいるのかという情報を示します。このフィールドがある場合は常に、人数を示すcountが含まれます。もし詳細を観る場合で、ユーザがログインしている場合はfriendsと`type` としてのothersフィールドを持つ、groupsフィールドも含まれます

venueの詳細を表示するときのフィールドです。

stats ここに何回checkinしたかを示すcheckinsCountとここに今まで何人のユーザがcheckinしたかを示すusersCountが含まれます
mayor userはここのmayorのuserです。mayorがいない場合はありません。countは過去60日間で何回checkinしたかを示します
tips tipsの数を示すcountfriendを含むgroupsgroupTypesとしてのothersが含まれます。groupは時間と共に変更されます
todos 現在のユーザがこのVenueにつけたtodoです。もしユーザがログインしていない場合はありません
tags このVenueに付けられたタグ
beenHere 現在のユーザがこのVenueにcheckinした回数です。もしユーザがログインしていない場合はありません。
shortUrl このVenueを表すURL。例:http://4sq.com/Ab123D
specialsNearby このVenue近くのspecial訳註: このspecialのレスポンスの解説が見つかりません

tipsのレスポンス

http://developer.foursquare.com/docs/responses/tip.html

id このtipsの一意な識別子
text 実際のtips
createdAt このtipsが作成された時刻のエポックタイムからの秒数
status オプションユーザのtipsに対する関係に応じてtododoneのどちらかになります。もしもなにも関係がない場合はこのフィールドはありません
user オプションもし、複数のユーザからのtipsがある場合は、このtipsを作成したユーザーレスポンスが返されます
venue オプションもし、複数のvenueからのtipsがある場合は、このtipsを作成したVenueレスポンスが返されます

tipsの詳細表示時のみ表示されるフィールド

todo このtipsをTODOにした人の数を示すcount、TODOにしたfriend全てを含むgroupsを含みます。groupsが含む情報は今後変わる可能性があります(TODOはfriendにしか見えないことに注意してください)
done このtipsをdoneにした人の数を示すcount、doneにしたfriend全てとothersを含むgroupsを含みます。groupsが含む情報は今後変わる可能性があります

checkinレスポンス

http://developer.foursquare.com/docs/responses/checkin.html

id このcheckinを示す一意な識別子
type checkinshoutvenuelessのどれか
private オプションもしこれがあるならば、このcheckinは private と印がつけられ、friendには送られません。その場合、持ち主がこのデータを見るときのみ、このcheckinの情報が含まれます
user オプションコンテキスト(訳註: 状況か)から明らかではない場合、簡略版ユーザレスポンスが示されます
venue オプションコンテキスト(訳註: 状況か)から明らかではない場合、かつ、このcheckinがvenueに対して行われたものである場合、簡略版venueレスポンスが返されます。
location オプションもし、このcheckinのtypeshoutvenuelessの場合、このフィールドが含まれ、latlngのペアと、ユーザの現在の位置を表す構造化されていないnameが含まれます
shout オプションcheckin時のメッセージです。もし、shoutがあり、かつ、現在のユーザが見ることが出来れば表示されます。
createdAt このcheckinが作られた時間を示す、エポックタイムからの秒数
source オプションもしこれがあるならば、このcheckinを作成するのに使用したアプリケーションのnameurlが含まれます

TODOレスポンス

http://developer.foursquare.com/docs/responses/todo.html

id このTODOの一意な識別子。
createdAt このTODOが作られた時間を示す、エポックタイムからの秒数
tip todoであるtipを示します。ユーザがvenue/XXX/marktodoを呼び出した場合、ユーザがそのvenueにいく意図があるというtip は暗黙のうちに作成される点に注意してください

Notification

http://developer.foursquare.com/docs/responses/notifications.html

レスポンスの中のnotificationフィールドは、リクエスト(checkinやtipなど)によって作られたことの通知をふくんでいます。将来的に、notificationフィールドは以前のアクションに関連する通知を含むようになるかもしれません。これらのオブジェクトのフォーマットは徐々に変わっていきますが、以下にその例を示します。

{...
  "notifications": [
    { "type": "sometype",
      "item": ...
    },..
  ],
  ...
}
type item
badge このアクションの結果取得したbadge。checkinの後、0か1かそれ以上が含まれます。
tip 現在有効なユーザのvenueか近隣のvenueにある、推薦されたtips
score pointsiconmessagesを持つオブジェクトの配列を示すscoresを含みます。また、totalも含みます
mayorship

以下の情報を含みます。

  • checkins: 現在有効なユーザが過去60日以内に行ったcheckinの数
  • type:nochangenewstolenのどれか
  • daysBehind:オプションこのユーザがmayorではなくなった時からの日数
  • user:オプション今現在あるいは過去にmayorで、現在有効なユーザではないユーザ
  • message: 現在有効なユーザに表示するためのメッセージ
  • image: 現在のmayorかcrownの画像
message ユーザに表示するためのメッセージです。例: “Thanks for the tip!”

Badge

http://developer.foursquare.com/docs/responses/badge.html

id このbadgeの一意な識別子です。if locked, or this user’s specificunlock of this badge, if unlocked. (訳註: 英文不明)
badgeId オプション正規化された一意な識別子
name このbadgeの名前
description このbadgeに関する追加の情報
image 様々なサイズの画像を作成するための情報です。prefixsizenameをくっつけてください。例:http://foursquare.com/img/badge/57/newbie.pnglockされているbadgeの場合、このフィールドはbadgeのlockされている画像を示します
unlocks オプションもしこのフィールドがある場合、unlockされた情報の配列が含まれます。さらに、checkinの情報を示すcheckinsの配列が含まれます。現在のところ両方の配列ともエントリは一つだけです

写真レスポンス

http://developer.foursquare.com/docs/responses/photo.html

id この写真を表す一意な識別子
createdAt この写真が作成された、エポックタイムからの秒数
url オリジナルの写真がuploadされたURL
sizes countが提供されるサイズ、itemsがサポートされているサイズの配列です。それぞれのsizeはurl文字列、widthheightの数値を含みます。最初のアイテムはオリジナルの写真のサイズで、続くアイテムは生成された写真のサイズです。生成された写真のサイズがURLと共に返されますが、そのURLがそのまま有効であるとは限りません
source オプションこのフィールドがある場合、nameurlはこの写真を作成するのに使用したアプリケーション名とURLです
user オプションユーザが誰か分からない場合、簡易ユーザレスポンスが含まれます
tip オプションtipが不明な場合、簡易tipレスポンスが含まれます
checkin オプションcheckinが不明な場合、簡易checkinレスポンスが含まれます

Table Of Contents

Previous topic

Multi

Next topic

更新履歴

This Page