Xsolla-logo

サーバーから属性別にユーザーを取得する

post/attributes/users/get

Gets a list of users by an attribute. Returns a list of the users’ IDs, their emails, and the attributes that were specified in the ‘key’ object of the request.

SecurityAttributesServer
Request
Request Body schema: application/json
required
object

属性は、ユーザーのリストを取得するために使用されます。

after
string or null

ユーザー属性の更新日、およびkeysリスト内の最新属性のID。初期設定はしないでください 属性でユーザーを取得した場合、更新日順にソートされます。複数の属性で更新日が同じ場合は、属性IDでソートされます。 APIページネーションに使用されます。

attr_type
string
Default: "client"

サービス属性へのユーザーのアクセスレベルの定義。

Enum: "client" "server"
keys
Array of strings <= 5 items

取得する属性のキーのリスト。指定しない場合は、ユーザーIDのリストのみを返します。

limit
integer [ 0 .. 20 ]
Default: 20

属性で検索した際に返されるユーザー数。

login_project_id
string

Login ID from Publisher Account which you want to get user’s attributes for. If you do specify it, it is use instead your merchant ID and project ID from Publisher Account.

publisher_id
integer or null

リクエストの対象となるマーチャントID。リクエストの認証に必要です。

publisher_project_id
integer

ユーザーを取得するパブリッシャーアカウントのプロジェクトID。指定しない場合、このパラメータの値なしでユーザーを返します。

search_type
string
Default: "equal"

Сomparison condition that defines search criteria.

Enum: "equal" "like"
Responses
200

OK

400

無効なリクエスト

403

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

422

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

429

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

Request samples
application/json
{
  • "after": "string",
  • "attr_type": "client",
  • "attribute": {
    },
  • "keys": [
    ],
  • "limit": 20,
  • "login_project_id": "string",
  • "publisher_id": 0,
  • "publisher_project_id": 0,
  • "search_type": "equal"
}
Response samples
application/json
[
  • {
    }
]