ユーザ・友達情報の取得

 

ユーザと友達情報を取得します。

URI Fragment

/people/{-list|,|userId}/{groupId}
/people/{-list|,|userId}/{groupId}/{-list|,|personId}

パラメータ名

説明

userId

文字列/数値ID

現在ログインしているユーザを表す @me、またはユーザID

groupId

文字列

ユーザ情報を取得する場合:@self、友達を取得する場合:@all または @friends。なお、@all と @friends は同じです

persionId

数値ID

友達関係を確認したいユーザ ID、下記実例参照

署名方式

  • 2-legged(Trusted モデル)
  • 3-legged(Proxy モデル)

OAuth 認証についてはこちら、リクエストの署名や Authorization ヘッダーの作成についてはこちらを参照して下さい。

HTTP メソッド

GET

リクエストヘッダー

  • Authorization ヘッダーは必須になります。

URL クエリパラメータ

パラメータ名

説明

必須

fields

リスト

取得したいフィールドのカンマ区きりリスト

No

format

文字列

"json"を指定して下さい

No

filterBy

リスト

"id"、"hasApp" は指定可能

No

filterOp

リスト

"equals" を指定してい下さい

No

filterValue

リスト

filter の値

No

count

数値

1-1000 の整数値。デフォルトは 50 です

No

sortBy

文字列

"id" だけ指定可能

No

sortOrder

文字列

"ascending" または "descending"

No

startIndex

数値

1 以上の整数値

No

リクエスト本文

なし

レスポンスコード

HTTP ステータスコード

HTTP ステータスメッセージ

説明

200

OK

データの取得が成功した場合

400

Bad Request

クライアント側のリクエストデータが不正です

401

Unauthorized

認証エラーです

403

Forbidden

リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です

404

Not Found

存在しないリソースです

500

Internal Server Error

API サーバー側のエラーです

503

Service Unavailable

一時的に API が利用不可となっている場合です

レスポンス本文

  • 下記パラメータを持つユーザ情報
  • Content-Type: application/json; charset=utf-8

パラメータ名

説明

aboutMe

文字列

ユーザの自己紹介文

addresses

文字列

都道府県名

age

数値

ユーザ年齢。なお、Mobage Japan の場合、生年月日を登録しなかった場合または非公開の場合、返されません

birthday

日付

ユーザの生年月日。なお、Mobage Japan の場合、生年月日を登録しなかった場合または非公開の場合、0000-MM-DD が返されます。MM-DD はユーザの登録日になります

bloodType

文字列

ユーザの血液型

displayName

文字列

ユーザのニックネーム(下記 nickname と同じ)

gender

文字列

ユーザの性別。なお、Mobage Japan の場合、性別を登録しなかった場合 undisclosed が返って来ます

grade

数値

ユーザの grade。詳細は「会員区分(Grade)について」を参照して下さい

hasApp

ブーリアン

ユーザはこのアプリをインストールしたかどうか

id

文字列

ユーザ ID

interests

文字列

ユーザの趣味

isFamous

ブーリアン

特別な有名人アカウント。下記制限付き。
Mobage Japan では、「有名人アカウント」というアカウントがレガシーとして存在しています。これらのアカウントは実在しませんので、下記通知の受信はできません。

API よりメッセージや通知をユーザに送信する前に、isFamous フラグを確認して下さい。なお、Mobage Japan 以外のプラットフォームでは常に false になります|
  • 招待
  • ミニメール
  • リモート通知

isVerified

ブーリアン

SMS 認証されたユーザかどうか

jobType

文字列

ユーザの職業

nickname

文字列

ユーザのニックネーム(上記 displayName と同じ)

thumbnailUrl

文字列

ユーザサムネイル画像への URL

実例

現在ログイン中のユーザ情報を取得します(3-legged(Proxy モデル))
Base String
HTTP リクエスト
HTTP レスポンス
指定ユーザの情報を取得します(2-legged(Trusted モデル))
Base String
HTTP リクエスト
HTTP レスポンス

 

現在ログイン中のユーザの友達リストを取得します(3-legged(Proxy モデル))
Base String
HTTP リクエスト
HTTP レスポンス

 

指定ユーザは現在ログイン中のユーザの友達かどうか確認します(3-legged(Proxy モデル))
Base String
HTTP リクエスト
HTTP レスポンス

PREVIOUS

People

NEXT

AppData