mixi Connect » mixi Graph API » 技術仕様 » Voice API
Voice API
mixiボイスは、多くのユーザが利用しているライトなコミュニケーションサービスとしてその地位をしっかりと固めました。今までmixiボイスを利用するための場所は、mixi.jpや一部の携帯端末などに限定されてきました。このVoice APIを利用することで、特定のユーザや友人の発言一覧の取得、つぶやきの投稿、そしてイイネ!やコメントをAPIを通じて行うことが可能となります。
ここでは、Voice APIについて、その使用方法を説明します。
事前に必要なもの
Voice APIを利用するためには、以下の情報をすでに入手している必要があります。
- "r_voice"または"w_voice"スコープおよびその両方について認可されたアクセストークン
上記以外のスコープで認可されたアクセストークンを使用して、Voice APIにアクセスすることはできません。アクセストークンの入手方法については、認証認可手順のページをご覧ください。
Voice APIで提供される機能とスコープ
Voice APIでは様々な機能が提供されますが、それらは大きく「参照系」「投稿系」の2つに分類されます。この分類は、そのままVoice APIを利用するためのスコープに対応します。以下に、スコープと各機能の対応を示します。
スコープ | 機能 |
---|---|
r_voice | ユーザのつぶやき一覧、友人のつぶやき一覧の取得 あるつぶやきにイイネ!をしたユーザの一覧取得 あるつぶやきのコメント一覧の取得 |
w_voice | つぶやき投稿、削除 あるつぶやきにイイネ!投稿、削除 あるつぶやきにコメント投稿、削除 |
つぶやきの取得
Voice APIにより提供されるつぶやきの取得機能は、以下の3つがあります。
- あるユーザのつぶやき一覧の取得
- 友人のつぶやき一覧の取得
- ある特定のつぶやき情報の取得
つぶやき情報の取得を行うために、クライアントプログラムは"https://api.mixi-platform.com/2/voice/statuses"にアクセスします。上記3つを取得するためのURIは、それぞれ異なります。
あるユーザのつぶやき一覧の取得
あるユーザのつぶやき一覧を取得するためのURIは以下となります。
GET https://api.mixi-platform.com/2/voice/statuses/[User-ID]/user_timeline?since_id=[つぶやきのID]
パラメータ名 | 指定する値 |
---|---|
User-ID | 取得したいユーザのID、もしくは認可ユーザ自身を示す"@me" |
since_id | このパラメータ値として、あるつぶやきのIDを指定することで、そのつぶやきよりも新しく投稿されたつぶやきの一覧に限定することができます(since_idは省略可) また、results_directionをあわせて指定することでsince_idを基点としたつぶやき一覧の取得が可能です(※「ページングの指定方法」を参照)。 |
trim_user | このパラメータに"1", "true", "t"のいずれかが指定された場合、ユーザの情報(userプロパティ)として、id以外の情報が除外されます。よって、idのみが結果として取得できます。 また、このパラメータに"exclude_screen_name"が指定された場合は、ユーザの情報として、idおよびscreen_name以外の情報が除外されます。よってidおよびscreen_nameが結果として取得できます。 |
attach_photo | このパラメータに"1″, "true", "t"のいずれかが指定された場合、取得したつぶやきの文字列に含まれるフォト情報について、photoプロパティとしてつぶやき本文から切り出して取得されます。 |
User-IDパラメータとして指定可能なIDは、アクセストークンを認可したユーザのIDまたは"@me"、もしくはそのユーザの友人のユーザのIDとなります。
since_idパラメータを指定した場合について、指定IDよりも新しいつぶやきの一覧が必ず全て取得できるとは限らないことに注意してください(countパラメータの指定もしくは初期件数20件、または最大取得可能件数200件の範囲に依存します)。
友人のつぶやき一覧の取得
友人のつぶやき一覧を取得するためのURIは以下となります。
GET https://api.mixi-platform.com/2/voice/statuses/friends_timeline/[Group-ID]?since_id=[つぶやきのID]
パラメータ名 | 指定する値 |
---|---|
Group-ID | グループのID、省略可 |
since_id | このパラメータ値として、あるつぶやきのIDを指定することで、そのつぶやきよりも新しく投稿されたつぶやきの一覧に限定することができます(since_idは省略可) また、results_directionをあわせて指定することでsince_idを基点としたつぶやき一覧の取得が可能です(※「ページングの指定方法」を参照)。 |
trim_user | このパラメータに"1", "true", "t"のいずれかが指定された場合、ユーザの情報(userプロパティ)として、id以外の情報が除外されます。よって、idのみが結果として取得できます。 また、このパラメータに"exclude_screen_name"が指定された場合は、ユーザの情報として、idおよびscreen_name以外の情報が除外されます。よってidおよびscreen_nameが結果として取得できます。 |
attach_photo | このパラメータに"1″, "true", "t"のいずれかが指定された場合、取得したつぶやきの文字列に含まれるフォト情報について、photoプロパティとしてつぶやき本文から切り出して取得されます。 |
これにより、アクセストークンを認可したユーザの友人のつぶやき一覧を取得することができます。その際、Group-IDパラメータを指定することで、特定のグループに所属するユーザのみのつぶやき一覧に限定することが可能です。
「あるユーザのつぶやき一覧の取得」と同じように、since_idパラメータを指定した場合について、指定IDよりも新しいつぶやきの一覧が必ず全て取得できるとは限らないことに注意してください(countパラメータの指定もしくは初期件数20件、または最大取得可能件数200件の範囲に依存します)。
ある特定のつぶやき情報の取得
ある特定のつぶやきのみの情報を取得するためのURIは以下となります。2つのURIがあり、どちらも機能的には同じです。
GET https://api.mixi-platform.com/2/voice/statuses/show/[Post-ID] GET https://api.mixi-platform.com/2/voice/statuses/[Post-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | 取得したいつぶやきを特定するためのID |
trim_user | このパラメータに"1", "true", "t"のいずれかが指定された場合、ユーザの情報(userプロパティ)として、id以外の情報が除外されます。よって、idのみが結果として取得できます。 また、このパラメータに"exclude_screen_name"が指定された場合は、ユーザの情報として、idおよびscreen_name以外の情報が除外されます。よってidおよびscreen_nameが結果として取得できます。 |
attach_photo | このパラメータに"1″, "true", "t"のいずれかが指定された場合、取得したつぶやきの文字列に含まれるフォト情報について、photoプロパティとしてつぶやき本文から切り出して取得されます。 |
取得結果
つぶやき情報の取得結果は、以下のようになります。下記の例は、JSON形式です。
つぶやきはcreated_atで降順にソートされます。
[ { "id" : "1FZ3P4ACUWBBC-2010061010321", "created_at" : "Thu Jun 10 01:32:13 +0000 2010", "text" : "つぶやきの本文", "user" : { "id" : "1FZ3P4ACUWBB", "screen_name" : "Becky", "profile_image_url" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg", "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx" }, "reply_count" : "3", "favorite_count" : "5", "favorited" : true }, ・・・ ]
個々のエントリに含まれる情報は、以下となります。
属性名 | 説明 |
---|---|
id | つぶやきを特定するためのID (Post-ID) |
created_at | つぶやきが投稿された日時 |
text | つぶやきの本文 |
user.id | つぶやきを投稿したユーザのID |
user.screen_name | つぶやきを投稿したユーザのニックネーム |
user.profile_image_url | つぶやきを投稿したユーザのプロフィール画像のURL |
user.url | つぶやきを投稿したユーザのプロフィールページのURL |
reply_count | このつぶやきに対してのコメントの件数 |
favorite_count | このつぶやきに対してのイイネ!の件数 |
source | このつぶやきがTwitterからmixiボイスに取り込まれたものである場合に、このsourceプロパティが結果に含まれます。プロパティ値は"twitter"となります。 |
favorited | 認可ユーザがこのつぶやきに対してすでに"イイネ!"している場合 true。そうでなければ false。 |
userプロパティについて、そのユーザがアクセストークンの認可ユーザと友人関係ではなかった場合は、user.idプロパティ、user.screen_name、user.profile_image_urlプロパティのみが結果として返却されます。
もしattach_photoパラメータを使用してAPIアクセスを行った場合は、APIの取得結果にphotoプロパティが追加されます。例えば、つぶやきの本文が、
http://photo.mixi.jp/view_photo.pl?photo_id=3535&owner_id=3535 今日のごはん
という文字列だった場合、APIの取得結果は以下のようになります。
[ { "id" : "1FZ3P4ACUWBBC-2010061010321", "created_at" : "Thu Jun 10 01:32:13 +0000 2010", "text" : "今日のごはん", "user" : { ・・・ }, "photo" : [ { "thumbnail_url" : "http://id.photo.mixi.jp/....", "image_url" : "http://id.photo.mixi.jp/....", } ], ・・・ }, ・・・ ]
属性名 | 説明 |
---|---|
photo | つぶやきの本文に含まれるフォト情報の配列。つぶやきにフォト情報が含まれていない場合は、0件の配列となります。 |
photo.thumbnail_url | フォトのサムネイルURL |
photo.image_url | フォトのURL |
attach_photoパラメータを利用した場合、つぶやき本文中に含まれるフォト情報として認識されるものは、以下の条件を満たすものとなります。
- "http://photo.mixi.jp/view_photo.pl?photo_id=***&owner_id=***"という形式のURLであること。
- 対象のつぶやきの投稿者と、上記のURLが指すフォトの所有者が同じユーザであること。
上記の条件を満たす場合は、そのフォトが所属するアルバムの公開範囲に関わらず、photoプロパティとして結果に含まれます。
あるつぶやきのコメント一覧取得
あるつぶやきに対して投稿されたコメントの一覧を取得するために、クライアントプログラムは"https://api.mixi- platform.com/2/voice/replies"にアクセスします。具体的なURIは、以下となります。2種類ありますが、どちらを使っても結果は同様となります。
GET https://api.mixi-platform.com/2/voice/replies/show/[Post-ID] GET https://api.mixi-platform.com/2/voice/replies/[Post-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | 1コメント一覧を取得したいつぶやきを特定するためのID |
trim_user | このパラメータに"1", "true", "t"のいずれかが指定された場合、ユーザの情報(userプロパティ)として、id以外の情報が除外されます。よって、idのみが結果として取得できます。 |
コメント一覧の取得結果は、以下のようになります。下記の例は、JSON形式となります。
[ { "id" : "1FZ3P4ACUWBBC-20090520180336-1FZ3P4ACUWBBC-2009052112112", "created_at" : "Thu May 21 03:11:23 +0000 2009", "text" : "コメントの本文", "user" : { "profile_image_url" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg", "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx", "id" : "1FZ3P4ACUWBB", "screen_name" : "Becky" } }, ・・・ ]
個々のエントリに含まれる情報は、以下となります。
属性名 | 説明 |
---|---|
id | コメントを特定するためのID (Comment-ID) |
created_at | コメントが投稿された日時 |
text | コメントの本文 |
user.id | コメントを投稿したユーザのID |
user.screen_name | コメントを投稿したユーザのニックネーム |
user.profile_image_url | コメントを投稿したユーザのプロフィール画像のURL |
user.url | コメントを投稿したユーザのプロフィールページのURL |
userプロパティについて、そのユーザがアクセストークンの認可ユーザと友人関係ではなかった場合は、user.idプロパティ、
user.screen_nameプロパティ、user.profile_image_urlプロパティのみが結果として返却されます。
あるつぶやきのイイネ!一覧取得
あるつぶやきをイイネ!したユーザの一覧を取得するために、クライアントプログラムは"https://api.mixi-platform.com/2/voice/favorites"にアクセスします。具体的なURIは、以下となります。2種類ありますが、どちらも結果は同じです。
GET https://api.mixi-platform.com/2/voice/favorites/show/[Post-ID] GET https://api.mixi-platform.com/2/voice/favorites/[Post-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | 1コメント一覧を取得したいつぶやきを特定するためのID |
trim_user | このパラメータに"1", "true", "t"のいずれかが指定された場合、ユーザの情報(userプロパティ)として、id以外の情報が除外されます。よって、idのみが結果として取得できます。 |
イイネ!一覧の取得結果は以下のようになります。下記の例は、JSON形式です。
[ { "created_at" : "Wed Dec 07 01:09:54 +0000 2011", "profile_image_url" : "http://profile.img.mixi.jp/photo/user/C8A4ICPZF1EQ_301280930.jpg", "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx", "id" : "C8A4ICPZF1E", "screen_name" : "Taro" }, ・・・ ]
個々のエントリに含まれる情報は、以下となります。
属性名 | 説明 |
---|---|
id | イイネ!をしたユーザのID |
screen_name | イイネ!をしたユーザのニックネーム |
profile_image_url | イイネ!をしたユーザのプロフィール画像のURL |
url | イイネ!をしたユーザのプロフィールページのURL |
created_at | イイネ!が投稿された日時 |
イイネ!をしたユーザがアクセストークンの認可ユーザと友人関係ではなかった場合は、idプロパティ、screen_nameプロパティ、profile_image_urlプロパティのみが結果として返却されます。
つぶやきの投稿と削除
つぶやきの投稿および削除を行うために、クライアントプログラムは"https://api.mixi-platform.com/2/voice/statuses"にアクセスします。
つぶやきの投稿
つぶやきを新規に投稿するためのURIは以下となります。2種類ありますが、どちらも結果は同じです。
POST https://api.mixi-platform.com/2/voice/statuses/update POST https://api.mixi-platform.com/2/voice/statuses
リクエストボディとして、つぶやきの本文をapplication/x-www-form-urlencoded形式で指定します。
status=%E3%81%A4%E3%81%B6%E3%82%84%E3%81%8D%E3%81%AE%E6%9C%AC%E6%96%87
パラメータ名 | 指定する値 |
---|---|
status | つぶやきの本文 |
statusパラメータに指定する文字列の文字コードはUTF-8とし、それをURIエンコードした結果を指定します。
フォト付きつぶやきの投稿
つぶやきを投稿する際に、そのつぶやきに関するフォトも同時に投稿することができます。その方法は2種類提供されています。
- multipart/form-data形式のリクエストを送信する。
- image/jpeg, image/png形式のリクエストを送信する。
multipart/form-data形式を利用する場合のURIは以下となります。どちらも機能的には同じです。
POST https://api.mixi-platform.com/2/voice/statuses/update POST https://api.mixi-platform.com/2/voice/statuses
Content-Typeリクエストヘッダには"multipart/form-data"を指定し、リクエストボディには以下の2つのパラメータを指定します。
パラメータ名 | 指定する値 |
---|---|
status | つぶやきの本文。文字コードはUTF-8とし、それをURLエンコードした値を指定します。下記photoパラメータが指定されている場合には、省略可能です。 |
photo | フォトのバイナリデータ。 |
image/jpegまたはimage/png形式を利用する場合のURIは以下となります。どちらも機能的には同じです。
POST https://api.mixi-platform.com/2/voice/statuses/update POST https://api.mixi-platform.com/2/voice/statuses
つぶやきの本文は、以下のクエリパラメータを利用して指定します。
パラメータ名 | 指定する値 |
---|---|
status | つぶやきの本文。文字コードはUTF-8とし、それをURLエンコードした値を指定します。省略可能です。 |
Content-Typeリクエストヘッダには、"image/jpeg"または"image/png"を、それぞれ画像の形式ごとに選択して指定します。また、実際のフォトのバイナリデータを、リクエストボディとして指定します。
正常に投稿処理が行われた際には、以下のようなレスポンスが返却されます。各項目については、つぶやきの一覧取得にてattach_photoパラメータを指定してAPIアクセスした際に返却される内容と基本的に同じです。
[ { "id" : "1FZ3P4ACUWBBC-2010061010321", "created_at" : "Thu Jun 10 01:32:13 +0000 2010", "text" : "つぶやきの本文", "user" : { "id" : "1FZ3P4ACUWBB", "screen_name" : "Becky", "profile_image_url" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg", "url" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx" }, "photo" : [ { "thumbnail_url" : "http://id.photo.mixi.jp/....", "image_url" : "http://id.photo.mixi.jp/....", } ], "favorited" : false } ]
公開範囲の指定
つぶやきの公開範囲は、リクエストボディにprivacyパラメータを設定することで指定可能です(省略した場合は標準設定されている公開範囲に投稿されます)。
Content-Typeリクエスト・ヘッダに"application/json"を指定し、リクエスト・ボディにて以下の内容をJSON形式で送信します。
パラメータ名 | 指定する値 |
---|---|
status | つぶやきの本文。 |
privacy | 公開範囲を指定する値 |
visibilityパラメータの詳細は下記のようになります。
指定値 | 意味 |
---|---|
everyone | 全体に公開 |
friends | 友人まで公開 |
friends_of_friends | 友人の友人まで公開 |
top_friends | 仲良しに公開 |
group | 特定のグループにのみ公開 |
{ "status" : " "つぶやきの本文", "privacy":{ "visibility":"frineds", } }
groupパラメータ値の形式
visibilityに「特定のグループにのみ公開」と指定する際は下記のように、
privacy内に別途でgroupというパラメータが必須となります
{ "status" : " "つぶやきの本文", "privacy":{ "visibility":"group", "group":"5" } }
group値には、公開を許可するグループIDを指定してください。
※グループIDについては、Groups APIにて取得したIDを指定する事となります。
公開範囲を指定したフォト付きつぶやき
Content-Typeリクエスト・ヘッダに"multipart/form-data"を指定し、リクエストボディには以下のパラメータを指定します。
パラメータ名 | 指定する値 |
---|---|
request | 上述のstatus,privacyパラメータを含むJSON文字列 |
photo | 写真のバイナリデータ |
リクエストは下記のようになります。
boundary文字列 Content-Disposition: form-data; name="request" { "status": "つぶやきの本文", "privacy" : { "visibility" : "friends_of_friends", } } boundary文字列 Content-Disposition: form-data; name="photo"; filename="添付画像.jpg" Content-Type: image/jpeg .......添付画像のバイナリデータ]]>
あるつぶやきの削除
ある特定のつぶやきを削除するためのURIは以下となります。2種類ありますが、どちらも結果は同じです。
POST or DELETE https://api.mixi-platform.com/2/voice/statuses/destroy/[Post-ID] DELETE https://api.mixi-platform.com/2/voice/statuses/[Post-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | 削除したいつぶやきを特定するためのID |
つぶやきの削除は、対象のつぶやきがアクセストークンを認可したユーザによる投稿だった場合にのみ成功します。
コメントの投稿と削除
あるつぶやきへのコメント投稿や、あるコメントの削除を行うために、クライアントプログラムは"https://api.mixi-platform/2/voice/replies"にアクセスします。
コメントの投稿
あるつぶやきに対してコメントを投稿するためのURIは以下となります。2種類ありますが、どちらも結果は同じです。
POST https://api.mixi-platform.com/2/voice/replies/create/[Post-ID] POST https://api.mixi-platform.com/2/voice/replies/[Post-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | コメントを投稿したいつぶやきを特定するためのID |
リクエストボディとして、コメントの本文をapplication/x-www-form-urlencoded形式で指定します。
text=%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E6%9C%AC%E6%96%87
パラメータ名 | 指定する値 |
---|---|
text | コメントの本文 |
textパラメータに指定する文字列の文字コードはUTF-8とし、それをURIエンコードした結果を指定します。
あるコメントの削除
ある特定のコメントを削除するためのURIは以下となります。2種類ありますが、どちらも結果は同じです。
POST or DELETE https://api.mixi-platform.com/2/voice/replies/destroy/[Post-ID]/[Comment-ID] DELETE https://api.mixi-platform.com/2/voice/replies/[Post-ID]/[Comment-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | 削除したいコメントが属するつぶやきを特定するためのID |
Comment-ID | 削除したいコメントを特定するためのID |
コメントの削除は、対象のコメントがアクセストークンを認可したユーザによる投稿だった場合にのみ成功します。
イイネ!の投稿と削除
あるつぶやきへのイイネ!投稿、およびイイネ!の削除を行うために、クライアントプログラムは"https://api.mixi-platform.com/voice/favorites"にアクセスします。
イイネ!の投稿
あるつぶやきに対してイイネ!を投稿するためのURIは以下となります。2種類ありますが、どちらも結果は同じです。
POST https://api.mixi-platform.com/2/voice/favorites/create/[Post-ID] POST https://api.mixi-platform.com/2/voice/favorites/[Post-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | イイネ!を投稿したいつぶやきを特定するためのID |
リクエストボディには何も指定する必要はありません。
あるイイネ!の削除
ある特定のイイネ!を削除するためのURIは以下となります。2種類ありますが、どちらも結果は同じです。
POST or DELETE https://api.mixi-platform.com/2/voice/favorites/destroy/[Post-ID]/[User-ID] DELETE https://api.mixi-platform.com/2/voice/favorites/[Post-ID]/[User-ID]
パラメータ名 | 指定する値 |
---|---|
Post-ID | イイネ!を削除したいつぶやきを特定するためのID |
User-ID | 削除したいイイネ!の投稿者のユーザのID |
イイネ!の削除は、そのつぶやきの投稿者がアクセストークンを認可したユーザ自身だった場合、そのつぶやきに紐尽く全てのイイネ!の削除を行うことができます。それに対して、そのつぶやきの投稿者がアクセストークンを認可したユーザではなかった場合、そのつぶやきに紐尽くイイネ!の中で、そのユーザ自身が投稿したイイネ!のみを削除することが可能です。
ページング、表現形式
Voice APIは、リクエスト時に下記のページングパラメータをサポートします。
つぶやき取得時 | つぶやきのコメント取得時 | |
---|---|---|
パラメータ | startIndex count since_id results_direction |
startIndex count startIndexCriteria sortOrder |
レスポンスにはページング関連の情報は付加されません。サポートされる表現形式は、JSON形式のみとなります。 ページングに関しては、APIでの取得件数として、countパラメータ無指定の場合は20件、最大指定可能件数は200件となります。200件以上指定しても、取得件数の上限は200件です。
つぶやき取得時におけるページングの指定方法
あるつぶやきを基点としたページング(推奨)
パラメータ名 | 指定する値 |
---|---|
since_id | つぶやき一覧取得の基点となるidです。 |
results_direction | あるつぶやきのID(since_id)を基点として、古いつぶやき(next)を取るか新しいつぶやき(previous)を取るかを指定します。 |
count | 取得最大件数です。省略した場合は20件となります。指定値の上限は200です。 |
※since_idのつぶやきは取得結果に含まれません。
インデックスによるページング
従来通り、startIndexとcountによる指定も可能です。
パラメータ名 | 指定する値 |
---|---|
startIndex | 開始インデックス |
count | 取得最大件数です。省略した場合は20件となります。指定値の上限は200です。 |
since_idの使い方
since_idの使い方について、図を用いて説明します。
since_idのみ指定した場合
リクエスト
since_id | hfkgjgkre-20111209103055 |
---|---|
count | 3 |
上記のようなクエリを発行すると、最新のつぶやきから取得して、取得結果をsince_idでフィルタリングします。
投稿日時 | 12/15 ...... |
12/14 ...... |
12/13 ...... |
12/12 ...... |
12/11 ...... |
12/10 ...... |
12/9 10:30:55 |
12/8 ...... |
12/7 ...... |
---|---|---|---|---|---|---|---|---|---|
有効/無効 | ■ | ■ |
■ | ■ | ■ | ■ |
■ |
■ |
■ |
タイムラインを更新する際に、フィードの重複を防ぐことが出来ます。
results_directionを合わせて指定した場合
リクエスト
since_id | hfkgjgkre-20111209103055 |
---|---|
results_direction | previous |
count | 3 |
上記のようなクエリを発行すると、2011-12-09 10:30:55のつぶやきを起点に、それより新しいつぶやきが3件取得されます。
投稿日時 | 12/15 ...... |
12/14 ...... |
12/13 ...... |
12/12 ...... |
12/11 ...... |
12/10 ...... |
12/9 10:30:55 |
12/8 ...... |
12/7 ...... |
---|---|---|---|---|---|---|---|---|---|
有効/無効 | ■ | ■ |
■ | ■ | ■ | ■ |
■ |
■ |
■ |
こちらはページング処理の実装に有効です。
コメント取得時におけるページングの指定方法
つぶやきに対して投稿されたコメントの一覧を取得する時は、startIndex、countパラメータに加えて、以下のクエリパラメータをサポートしています。
パラメータ名 | 説明 |
---|---|
startIndexCriteria | このパラメータ値として"oldest"を指定した場合は、startIndexが最古コメントからカウントした開始インデックスとなり、"newest"を指定した場合は、startIndexが最新のコメントからカウントした開始インデックスとなります。このパラメータを省略した場合は、startIndexが最新のコメントからカウントした開始インデックス(newest)となります。 |
sortOrder | このパラメータ値として"ascending"を指定した場合は昇順、"descending"を指定した場合は降順に取得結果が並び替えされます。このパラメータを省略した場合は、昇順(ascending)となります。 |