登録者情報一覧取得 API

概要

登録ユーザーの一覧を返却します。

URL

https://${hostname}/mapi/3.1/user/${device_type}/

キー名 必須 タイプ 説明
device_type o 文字列 以下のいずれかを指定
android, iphone

メソッド

GET/POST

結果タイプ

複数を返却する

リクエストパラメータ

キー名 必須 タイプ 説明
fields o 配列 受け取りたいパラメータ名
以下のいずれかを指定。
registered
popinfo_id
token_enabled
push_enabled
location_enabled
wifi_enabled
segmentlist
app_type
flat x 真偽値 レスポンスの形式
fieldsに１つだけ指定された場合は、flat=true とすることで１次元の配列で返却されるデフォルトは、flat=false。
filter x 配列 絞り込み
絞り込みパラメータは、後述。
count x 整数 結果件数
(省略時は10,000とみなす) 最大は、100,000
page x 整数 ページ番号(countと組み合わせて利用する)

リクエストのサンプル (flat=false)

{
  "fields": [
    "popinfo_id",
    "registered"
  ]
}

リクエストのサンプル (flat=true)

{
  "fields": [
    "popinfo_id"
  ],
  "flat": true,
  "filter": [
    {
      "registered": {
        "$gte": "2013-01-01 11:12:14"
      }
    }
  ]
}

filter による絞り込み

結果対象のユーザーを、指定された条件で絞り込みます。

Mongo Query Language のサブセットを条件指定に用います。 また、Arrayとして、MQLを渡すことで、

mongo > db.user.find({...}).find({...})

へと展開されます。

利用可能なパラメーター名

name 型 説明
registered 文字列 “YYYY-MM-DD hh:mm:ss” 登録日時
popinfo_id 文字列 popinfoID を表す。
id 整数 登録ID
token_enabled 真偽値 プッシュ通知トークン登録の有無
push_enabled 真偽値 お知らせ受信の可否
location_enabled 真偽値 位置情報送信の有効
wifi_enabled 真偽値 wifi情報送信の有効
test_send 真偽値 テスト送信受信の可否
segment_id 整数 選択された属性

利用可能なオペレーター

name 説明
$gt より大きい・最近
$gte より大きい・最近 (指定の値を含む)
$lt より小さい・過去
$lte より小さい・過去 (指定の値を含む)
$in 配列を取り、含まれるを表す。
$or 配列をとり、いずれか の条件とします。
$and 配列をとり、いずれも の条件とします。

レスポンスパラメータ

キー名 タイプ 説明
total_results 整数 ユーザーの合計数
page 整数 現在何ページ目を表示しているか
pages 整数 合計ページ数
result 配列 以下参照
キー名 タイプ 説明
result 配列 flat=falseの場合、fields に指定した順番で、配列の配列が返される。 flat=trueの場合、配列が返される。

レスポンス項目 wifi_enabled について

wifi_enabledは現在未使用の項目です。
将来廃止される予定ですのでご注意ください。

レスポンスのサンプル (flat=false)

{
  "status": "OK",
  "total_results": 3,
  "page": 1,
  "pages": 1,
  "result": [
    [
      "aaaa-bbbb-cccc-0",
      "2013-01-01 11:12:13"
    ],
    [
      "aaaa-bbbb-cccc-1",
      "2013-01-01 11:12:14"
    ],
    [
      "aaaa-bbbb-cccc-2",
      "2013-01-01 11:12:15"
    ]
  ]
}

レスポンスのサンプル (flat=true)

{
  "status": "OK",
  "total_results": 2,
  "page": 1,
  "pages": 1,
  "result": [
    "aaaa-bbbb-cccc-1",
    "aaaa-bbbb-cccc-2"
  ]
}