mixi Connect » mixi Graph API » 技術仕様 » Updates API
Updates API
ユーザがmixiに訪れる目的、それは友人の近況を知るためです。友人がどこに行き、何を考え、そして何に心を動かされたのか、mixi.jpにはそういった友人の情報が集まってきます。それらの情報は、フィードという形でmixi.jpのトップページに一覧表示されます。Updates APIは、友人の近況であるフィードを取得するためのAPIです。ポータルサイトやスマートフォンなど、ユーザが毎日訪れるメディアにてフィードが表示されれば、ユーザは友人の近況をより身近に感じることができるようになるでしょう。Updates APIは、そのような要望に応えてくれます。
ここでは、フィードを取得するためのUpdates APIについて、その使用方法を説明します。
事前に必要なもの
Updates APIを利用するためには、以下の情報をすでに入手している必要があります。
- “r_updates”スコープについて認可されたアクセストークン
上記以外のスコープで認可されたアクセストークンを使用して、Updates APIにアクセスすることはできません。アクセストークンの入手方法については、認証認可手順のページをご覧ください。
Updates APIにて取得可能なフィード
Updates APIを利用して取得することができるフィードの種類は、以下となります。
| 種別 | 名称 | Field name |
|---|---|---|
| コンテンツ | ボイス | voice |
| 日記 | diary | |
| カレンダー | calendar | |
| レビュー | review | |
| 動画 | video | |
| mixiアプリ | application | |
| フォト | photo | |
| チェック | share | |
| 近況 | プロフィール情報変更 ミクコレ変更 |
profile |
これらのフィードを新しい順に取得することができます。
フィード一覧の取得
フィードの一覧を取得するために、クライアントプログラムは”https://api.mixi-platform.com/2/updates”にアクセスします。
取得要求
フィードの一覧を取得するためのURIは、以下の仕様となります。
GET https://api.mixi-platform.com/2/updates/[User-ID]/[Group-ID]
| パラメータ名 | 指定する値 |
|---|---|
| User-ID | 基準となるユーザのID（友人のユーザID、認可ユーザのIDまたは”@me”） |
| Group-ID | フィードを取得したいユーザの集合を特定するためのID（グループIDまたは”@self”、”@friends”） |
User-IDパラメータ値として、アクセストークンを認可したユーザのID(@meも可)、もしくはそのユーザの友人のIDのみ指定可能です。もし User-IDパラメータにアクセストークンを認可したユーザのIDが指定された場合、Group-IDパラメータの指定によって、フィードの取得対象のユーザの集合が異なってきます。
| User-IDパラメータ値 | 指定可能なGroup-IDパラメータ値 | 取得されるフィード |
|---|---|---|
| アクセストークンを認可したユーザのID | “@self” | User-IDパラメータにて指定したユーザのフィード一覧 |
| “@friends” |
User-IDパラメータにて指定したユーザの友人のフィード一覧 | |
| グループのID |
User-IDパラメータにて指定したユーザが登録するグループに所属しているユーザのフィード一覧 | |
| アクセストークンを認可したユーザの友人のID | “@self” | User-IDパラメータにて指定されたユーザのフィード一覧 |
Updates APIでは、取得したいフィードの種別や取得件数の制限などを行うためのパラメータをいくつかサポートしています。以下はサポートしているパラメータとその説明です。
| パラメータ名 | 説明 |
|---|---|
| fields | 取得したいフィードの種別を指定するためのパラメータ。 省略時はコンテンツに属する全てのフィードが取得対象となる。複数指定する場合は、「,」区切りでField nameを列挙する。 |
| count | APIの結果として取得したいフィードの件数の上限値を指定するためのパラメータ。 最大指定可能件数は100件。省略時は20件となる。 必ずcountで指定した件数が返却されるとは限りません。 |
| updatedSince | このパラメータ値として指定された日時よりも新しいフィードに結果を限定します。日時の書式は「yyyy-mm-ddThh:mm:ssZ」や「yyyy-mm-ddThh:mm:ss+09:00」となります（詳しくは[XSdateTime]を参照、URIエスケープが必要）。 |
| device | mixi 上のページを指すURIについて、PC向けのページを指定する場合 “pc” を、モバイル向けのページを指定する場合 “mobile” を指定してください。省略された場合は “pc” が指定されたものとみなします。また、このパラメータ値によって、PCに特化した情報、あるいはモバイルに特化した情報がそれぞれ個別に取得結果に含まれる場合があります。 |
例えば、友人のフィード一覧として、mixiボイス、日記および近況に限定したフィードの一覧を上限50件として取得したい場合は、以下となります。
GET https://api.mixi-platform.com/2/updates/@me/@friends?fields=voice,diary,profile&count=50
取得結果
Updates APIの取得結果は、ActivityStreams仕様(http://activitystrea.ms/)に準拠したものとなります。各フィードは、Atom Activity Base Schema仕様(http://activitystrea.ms/head/activity-schema.html)にて規定された各Object Typeにマッピングされて表現されます。フィードの種別とObject Typeとのマッピングは以下となります。
| フィードの種別 | Object Type | 仕様 |
|---|---|---|
| ボイス | “status” | http://activitystrea.ms/head/activity-schema.html#status http://activitystrea.ms/head/activity-schema.html#note |
| 日記 | “article” | http://activitystrea.ms/head/activity-schema.html#article |
| カレンダー | “event” | http://activitystrea.ms/head/activity-schema.html#event |
| レビュー | “review” | http://activitystrea.ms/head/activity-schema.html#review |
| 動画 | “video” | http://activitystrea.ms/head/activity-schema.html#video |
| mixiアプリ | “service” | http://activitystrea.ms/head/activity-schema.html#service |
| フォト | “photo” “photo-album” |
http://activitystrea.ms/head/activity-schema.html#photo http://activitystrea.ms/head/activity-schema.html#photo-album |
| チェック | “bookmark” | http://activitystrea.ms/head/activity-schema.html#bookmark |
| 近況 | “person” | http://activitystrea.ms/head/activity-schema.html#person |
ページング、表現形式
Updates APIは、ページングは未サポートとなります。サポートされる表現形式は、JSON形式およびAtom形式となります。