ソーシャルPLUS ID 一覧の取得
ソーシャルPLUS ID の一覧を取得します。
GET /api/users
リクエストパラメータ
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| key | string | ○ | API キー |
| page | number | ページ番号。最初のページは 0 | |
| limit | number | 1 ページあたりの最大件数（デフォルト 20、最大 100） | |
| last_login_within | string | 検索条件。最終ログイン日時から指定の期間内のユーザに絞ります | |
| created_within | string | 検索条件。ユーザの作成日時から指定の期間内のユーザに絞ります | |
| mapped | string | 検索条件。mapped_only の場合「お客様サービス側のユーザID」が紐付けされたユーザのみに絞ります。not_mapped_only の場合は逆に「お客様サービス側のユーザID」が紐付けされていないユーザのみに絞ります |
期間の指定
last_login_within および created_within は以下の書式になります。
[数値][s/m/h/d]
s = 秒、m = 分、h = 時間、d = 日 を意味します。
書式に誤りがある場合は "Invalid Parameter." エラーとなります。
例）
last_login_within=1h- 最終ログイン日時が 1 時間以内のユーザのソーシャルPLUS ID 一覧を取得
created_within=7d- 1 週間以内に作成されたユーザのソーシャルPLUS ID 一覧を取得
エラーコード
| HTTP Status | Code | Message | 説明 |
|---|---|---|---|
| 401 | 1 | Invalid API key or key not found. | API キーが指定されていないか、存在しないAPIキーです |
| 400 | 5 | Required parameter not found. | 必須のパラメーターが指定されていません |
| 400 | 6 | Invalid parameter. | パラメーターに間違いがあります |
レスポンス
| キー | 型 | 最大長 | 説明 |
|---|---|---|---|
| status | string | 15 | リクエストが成功したかどうか（ok または failed） |
| users | array of string | 40 | ソーシャルPLUS ID の一覧 |
| total | number | - | 指定された条件に一致するユーザの総数 |
| size | number | - | 今回のリクエストで取得された件数 |
| next_page | number | - | 次のページが存在する場合に、次のページ番号 |
| next_uri | string | 2083 | 次のページが存在する場合に、次のページ URI |
ヒント
複数ページを辿ってデータを取得する場合、次ページの取得に next_uri で返された URI をご利用いただくと応答の高速化が行われます。
レスポンス例
{
"status": "ok",
"users": [
"9a8fda8c687bafc63f36dda6182295c5650083a2",
"c163ec187e38238dd5bcc2597761bec09b1dc42e",
"0cd78a8051c71c810c69813a0e843694fb6d4ea1",
"ee14a0c201c73f56260f007b22a64a72d15fb3c6",
"381436c1296d657f637df7bd87c72e047eb12214"
],
"total": 14,
"size": 5,
"next_page": 1,
"next_uri": "https://api.socialplus.jp/api/users?key={API Key}&last_login_within=7d&last_user_id=12345678&limit=5&page=1&total=14"
}
実行サンプル
curl -X GET https://api.socialplus.jp/api/users -G \
-d key={API Key} \
-d mapped=mapped_only \
-d limit=5