ユーザーの友達を取得する

ユーザーの友達を取得するClient-side

get/users/me/relationships

認証されたユーザーの友人として追加されたユーザーのリストを取得します。

SecurityBearer or APIKey

Request

query Parameters

type required	string 友達のタイプ。以下の値を指定できます： `friends`は、友達リストに追加されたユーザーのリストを取得します `friend_requested`は、友達リクエストを取得したユーザーのリストを取得します `friend_requested_by`は、友達リクエストを送信したユーザーのリストを取得します `blocked`は、友達リストに追加されてブロックされたユーザーのリストを取得します *`blocked_by`は、このユーザーをブロックしたユーザーのリストを取得します Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by required	string ユーザーをソートする条件。以下の値を指定できます： `by_nickname`は、リストをニックネームのアルファベット順に並べ替えます `by_updated`は、ユーザーが最近友達リストに誰かを追加またはブロックした日付でリストを並べ替えます Enum: "by_nickname" "by_updated"
sort_order required	string ユーザーのリストをソートする条件。以下の値を指定できます： `asc` は、`sort_by`値を昇順で適用します `desc`は`sort_by`値を降順で適用します Enum: "asc" "desc"
after	string APIページネーションに使用されるパラメータ。
limit	integer [ 1 .. 50 ] Default: 20 一度に返されるユーザー数の最大値。

Responses

200

400

無効なリクエスト

401

アクセス拒否

403

アクセス拒否

404

見つかりません

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/users/me/relationships?after=SOME_STRING_VALUE&limit=20&type=SOME_STRING_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer BEARER_TOKEN'

Response samples

application/json

{"next_after": "string",
"next_url": "string",
"relationships": [{"next_after": "bmFtZS0ydXNlci0y",
"next_url": "https://login.xsolla.com/api/users/by_access_key/access-key-1/relationships?type=friend_requests&sort_by=by_name&limit=2&after=bmFtZS0ydXNlci0y",
"relationships": [{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499214.3501,
"user": {"id": "user-3",
"name": "name-3",
"nickname": "nick-2",
"picture": "",
"tag": "423432"
}
},
{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499213.4718,
"user": {"id": "user-2",
"name": "name-2",
"nickname": "nick-2",
"picture": "",
"tag": "3100"
}
}
]
}
]
}