Xsolla-logo

ニックネームでユーザーを検索する

get/users/search/by_nickname

nicknameパラメータでユーザーを検索し、リストを取得します。ユーザーが検索パラメータの入力を開始すると、検索を即座に実行できます。

このコールを使用するワークフロー:

  1. ユーザーは、ニックネームやタグ、またはニックネームとタグを入力します。
  2. エクソラログインサーバーは、検索を開始したユーザーのログインプロジェクトデータでユーザーを検索します。

現在のユーザーは、このコールを1秒間に1回だけ実行することができます。

SecurityBearer
Request
query Parameters
nickname
required
string [ 3 .. 255 ] characters

含まれる可能性のある検索文字列は: *ニックネームのみ。検索はニックネームの先頭の部分文字列で実行されます。 *タグのみ。先頭に「#」をつけて使用します。検索は、タグの先頭の部分文字列で実行されます。 *ニックネームとタグを同時に使う。"#" と共に、スペースを入れずに使用します。検索は完全なニックネームとタグの先頭の部分文字列で実行されます。

offset
integer [ 0 .. 100 ]
Default: 0

リストが生成される要素の数。

limit
integer [ 1 .. 100 ]
Default: 100

一度に返されるユーザー数の最大値。

Responses
200

OK

401

未認証

422

処理不可能なエンティティー

429

リクエストの回数が多すぎます

Request samples
Response samples
application/json
{
  • "offset": 0,
  • "total_count": 0,
  • "users": [
    ]
}