プロパティ分析モデル API

最終更新 2026/10/03

呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。

利用シーンについては、マニュアルのプロパティ分析を参照してください。

1. ユーザープロパティ分析のクエリ

インターフェースURL

/open/user-prop-analyze?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー

リクエストBodyパラメータ

{
  "eventView": {
    "userCrowds": [
      {
        "crowdName": "女性",
        "filts": [
          {
            "columnDesc": "性別",
            "columnName": "gender",
            "comparator": "equal",
            "filterType": "SIMPLE",
            "ftv": [
              "女性"],
            "specifiedClusterDate": "2022-01-27",
            "tableType": "user",
            "timeUnit": ""
          }],
        "relation": "and"
      },
      {
        "crowdName": "男性",
        "filts": [
          {
            "columnDesc": "性別",
            "columnName": "gender",
            "comparator": "equal",
            "filterType": "SIMPLE",
            "ftv": [
              "男性"],
            "specifiedClusterDate": "2022-01-27",
            "tableType": "user",
            "timeUnit": ""
          }],
        "relation": "and"
      },
      {
        "crowdName": "性別不明",
        "filts": [
          {
            "columnDesc": "性別",
            "columnName": "gender",
            "comparator": "equal",
            "filterType": "SIMPLE",
            "ftv": [
              "不明"],
            "specifiedClusterDate": "2022-01-27",
            "tableType": "user",
            "timeUnit": ""
          }],
        "relation": "and"
      }]
  },
  "events": [
    {
      "analysis": "SUM",
      "analysisDesc": "合計",
      "eventNameDisplay": "残高合計",
      "filts": [
        {
          "columnDesc": "残高",
          "columnName": "accountbalance",
          "comparator": "greater",
          "filterType": "SIMPLE",
          "ftv": [
            "1"],
          "specifiedClusterDate": "2022-01-27",
          "tableType": "user",
          "timeUnit": ""
        }],
      "quota": "accountbalance",
      "relation": "and",
      "tableType": "user"
    }],
  "projectId": 377,
  "limit": 10,
  "timeoutSeconds": 10,
  "useCache": true
}

リクエストパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
eventView	-	Object	はい	グループプロパティ
eventView.userCrowds	-	Object	いいえ	ユーザーグループ
eventView.userCrowds.crowdName	女性	String	はい	ユーザーグループ名
eventView.userCrowds.filts	-	List	はい	フィルター対象
eventView.userCrowds.filts.columnDesc	性別	String	いいえ	フィールドの表示名
eventView.userCrowds.filts.columnName	gender	String	はい	フィールド名
eventView.userCrowds.filts.comparator	equal	String	はい	参考：モデルクエリAPIのフィルター式
eventView.userCrowds.filts.filterType	SIMPLE	String	いいえ	フィルターモード。SIMPLE：シンプル、COMPOUND：複合
eventView.userCrowds.filts.ftv	["女性"]	List	いいえ	プロパティ比較の境界に使用するリテラル定数
eventView.userCrowds.filts.specifiedClusterDate	2022-01-27	String	いいえ	指定した日付に対応するタグの履歴バージョン
eventView.userCrowds.filts.tableType	user	String	はい	テーブルタイプの列挙値
eventView.userCrowds.filts.timeUnit		String	いいえ	フィルターの時間単位
eventView.userCrowds.relation	and	String	はい	論理関係。and：論理積、or：論理和
events	-	List	はい	イベント指標のリスト
events.analysis	SUM	String	はい	分析の観点
events.analysisDesc	合計	String	いいえ	分析の観点の説明（表示名）
events.eventNameDisplay	残高合計	String	いいえ	イベント表示名
events.filts	-	List	いいえ	条件リスト
events.filts.columnDesc	残高	String	いいえ	フィールドの表示名
events.filts.columnName	accountbalance	String	はい	フィールド名
events.filts.comparator	greater	String	はい	参考：モデルクエリAPIのフィルター式
events.filts.filterType	SIMPLE	String	いいえ	フィルターモード。SIMPLE：シンプル、COMPOUND：複合
events.filts.ftv	["1"]	List	いいえ	プロパティ比較の境界に使用するリテラル定数
events.filts.specifiedClusterDate	2022-01-27	String	いいえ	指定した日付に対応するタグの履歴バージョン
events.filts.tableType	user	String	はい	テーブルタイプの列挙値
events.filts.timeUnit		String	いいえ	フィルターの時間単位
events.quota	accountbalance	String	いいえ	論理関係。and：論理積、or：論理和
events.relation	and	String	いいえ	論理関係。and：論理積、or：論理和
events.tableType	user	String	はい	テーブルタイプの列挙値
projectId	377	Integer	はい	プロジェクトID
limit	10	Integer	いいえ	分析対象ごとのグループ数の上限。任意パラメータで、デフォルトは1000、最大は10000
timeoutSeconds	10	Integer	いいえ	リクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
useCache	true	Boolean	はい	trueの場合はキャッシュを使用

成功レスポンスの例

{
  "data": {
    "data_list": [
      {
        "group_cols": [
          "女性"
        ],
        "values": 1140523491
      },
      {
        "group_cols": [
          "男性"
        ],
        "values": 1141720850
      },
      {
        "group_cols": [
          "性別不明"
        ],
        "values": 227565607
      }
    ],
    "group_cols_sorted": [
      [
        "女性",
        "男性",
        "性別不明"
      ]
    ],
    "group_num": 0,
    "result_generate_time": "2022-01-27 15:01:51",
    "unit": ""
  },
  "return_code": 0,
  "return_message": "success"
}

レスポンスパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ
data	-	Object	戻り値
data.data_list	-	List	データのリスト
data.data_list.group_cols	["女性"]	List	グループまたはユーザーグループのリスト
data.data_list.values	1140523491	Integer	ユーザー数
data.group_cols_sorted	["女性"]	List	すべてのグループまたはユーザーグループの順序リスト
data.group_num	0	Integer	グループ数
data.result_generate_time	2022-01-27 15:01:51	String	結果の生成日時
data.unit		String	数値プロパティの単位

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1008	Integer	リターンコード
return_message	パラメータ(token)が空です	String	リターンメッセージ

2. ユーザープロパティ分析のフルダウンロード

インターフェースURL

/open/streaming-download/user-prop-analyze?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー

リクエストBodyパラメータ

{
        "eventView": {
                "groupBy": [{
                        "columnDesc": "チャネル",
                        "columnName": "channel",
                        "propertyRange": "",
                        "specifiedClusterDate": "2022-03-10",
                        "tableType": "user"
                }],
                "userCrowds": []
        },
        "events": [{
                "analysis": "TRIG_USER_NUM",
                "analysisDesc": "ユーザー数",
                "eventNameDisplay": "",
                "filts": [{
                        "columnDesc": "アカウントID",
                        "columnName": "#account_id",
                        "comparator": "notNull",
                        "filterType": "SIMPLE",
                        "ftv": [],
                        "specifiedClusterDate": "2022-03-10",
                        "tableType": "user",
                        "timeUnit": ""
                }],
                "quota": "",
                "relation": "and",
                "tableType": "user"
        }],
        "projectId": 390
}

リクエストパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
eventView	-	Object	はい	パラメータの内容はユーザープロパティ分析のクエリAPIと同じです
events	-	List	はい	パラメータの内容はユーザープロパティ分析のクエリAPIと同じです
projectId	377	Integer	はい	プロジェクトID

レスポンス

AEシステムのプロパティ分析のフルダウンロードと同じです

3. ユーザープロパティ分析のユーザーリスト

インターフェースURL

/open/user-prop-user-list?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID

リクエストBodyパラメータ

{
  "projectId": 0,
  "events": [{
    "analysis": "AVG",
    "filts": [
      {
        "columnName": "latest_login_time",
        "comparator": "relativeCurrentBetween",
        "ftv": [
          "7",
          "1"
        ],
        "tableType": "user"
      }
    ],
    "quota": "diamond_num",
    "relation": "and",
    "tableType": "user"
  }],
  "eventView": {
    "groupBy": [
      {
        "columnName": "user_level",
        "tableType": "user"
      },
      {
        "columnName": "channel",
        "tableType": "user"
      }
    ]
  },
  "sliceGroupVal": [
    "31",
    "app store"
  ],
  "timeoutSeconds": 10
}

リクエストパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
projectId	0	Integer	はい	プロジェクトID
events	-	List	はい	パラメータの内容はユーザープロパティ分析のクエリAPIと同じです
eventView	-	Object	はい	パラメータの内容はユーザープロパティ分析のクエリAPIと同じです
sliceGroupVal	["31","app store"]	List	いいえ	ドリルダウンするグループ
eventIndex	0	Integer	はい	ユーザーグループ比較におけるユーザーグループのインデックス。0から始まります
timeoutSeconds	10	Integer	いいえ	リクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします

成功レスポンスの例

{
  "data": {
    "datalist": [
      {
        "#account_id": "b6909071",
        "#distinct_id": "b12831131",
        "user_level": 31,
        "register_time": "2019-09-23 09:33:31",
        "diamond_num": 1250,
        "first_recharge_time": "2019-11-18 08:50:33",
        "latest_login_time": "2019-11-26 18:15:51",
        "channel": "app store",
        "#user_id": 2961031
      },
      {
        "#account_id": "a6013000",
        "#distinct_id": "a11167000",
        "user_level": 31,
        "register_time": "2019-09-02 19:15:08",
        "diamond_num": 72,
        "first_recharge_time": "2019-09-02 19:18:36",
        "latest_login_time": "2019-11-24 10:02:38",
        "channel": "app store",
        "#user_id": 2577000
      },
      {
        "#account_id": "j2614535",
        "#distinct_id": "j4855535",
        "user_level": 31,
        "register_time": "2019-08-24 20:40:19",
        "diamond_num": 820,
        "latest_login_time": "2019-11-21 14:16:42",
        "channel": "app store",
        "#user_id": 1120535
      }
    ],
    "columMeta": {
      "#account_id": "アカウントID",
      "#distinct_id": "ゲストID",
      "user_level": "ユーザーレベル",
      "register_time": "登録時間",
      "diamond_num": "現在の所持ダイヤ数",
      "first_recharge_time": "初回チャージ時間",
      "latest_login_time": "最終ログイン時間",
      "channel": "チャネル"
    }
  },
  "return_code": 0,
  "return_message": "success"
}

レスポンスパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ
data	-	Object	戻り値
data.datalist	-	List<Map>	ユーザー情報
data.columMeta	-	Map	フィールドの意味のマッピング

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1008	Integer	リターンコード
return_message	パラメータ(token)が空です	String	リターンメッセージ

4. プロパティ分析のユーザーリストのダウンロード

インターフェースURL

/open/streaming-download/user-prop-user-list?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID

リクエストBodyパラメータ

{
        "eventView": {
                "endTime": "2022-03-08 16:14:02",
                "groupBy": [],
                "recentDay": "",
                "startTime": "2022-03-08 16:14:02",
                "userCrowds": [{
                        "crowdName": "グループ1",
                        "filts": [],
                        "relation": "and"
                }, {
                        "crowdName": "グループ2",
                        "filts": [],
                        "relation": "and"
                }]
        },
        "events": [{
                "analysis": "TRIG_USER_NUM",
                "analysisDesc": "ユーザー数",
                "eventNameDisplay": "",
                "filts": [{
                        "columnDesc": "アカウントID",
                        "columnName": "#account_id",
                        "comparator": "notNull",
                        "filterType": "SIMPLE",
                        "ftv": [],
                        "specifiedClusterDate": "2022-03-08",
                        "tableType": "user",
                        "timeUnit": ""
                }],
                "quota": "",
                "relation": "and",
                "tableType": "user"
        }],
        "projectId": 319,
        "sliceGroupVal": ["グループ2"],
        "eventIndex": 0,
        "selectedColumns": ["#account_id", "#distinct_id", "accountid"]
}

リクエストパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
projectId	0	Integer	はい	プロジェクトID
events	-	List	はい	パラメータの内容はユーザープロパティ分析のクエリAPIと同じです
eventView	-	Object	はい	パラメータの内容はユーザープロパティ分析のクエリAPIと同じです
sliceGroupVal	["31","app store"]	List	いいえ	ドリルダウンするグループ
eventIndex	0	Integer	はい	ユーザーグループ比較におけるユーザーグループのインデックス。0から始まります
selectedColumns	["#account_id"]	array	はい	ダウンロードする列

レスポンス

AEシステムのプロパティ分析のユーザーリストのダウンロードと同じです

5. ユーザーイベントリストのクエリ

インターフェースURL

/open/user-event-list?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー

リクエストBodyパラメータ

{
  "eventNames": [
    "payment",
    "level_up",
    "activity_attend",
    "draw_card",
    "register",
    "logout",
    "login",
    "gold_get",
    "gold_consume"
  ],
  "pagerHeader": {
    "pageNum": 1,
    "pageSize": 2
  },
  "projectId": 377,
  "startDateTime": ["2021-11-04 00:00:00"],
  "dateFormat": "week",
  "firstDayOfWeek": 1,
  "userId": 795687603434164226,
  "timeoutSeconds": 10,
  "useCache": true,
  "zoneOffset": 8
}

リクエストパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
eventNames	["payment"]	List	はい	含まれるイベントのリスト
pagerHeader	-	Object	はい	共通のページングリクエストヘッダー
pagerHeader.pageNum	1	Long	いいえ	開始ページ
pagerHeader.pageSize	2	Long	いいえ	1ページあたりの件数
projectId	377	Integer	はい	プロジェクトID
startDateTime	["2021-11-04 00:00:00"]	List	いいえ	開始時間のリスト yyyy-MM-dd HH:mm:ss
dateFormat	week	String	はい	時間ディメンションの単位 day：日単位 week：週単位 month：月単位 total：合計
firstDayOfWeek	1	Integer	いいえ	週の初日
userId	795687603434164226	Long	はい	分析対象のユーザーID
timeoutSeconds	10	Integer	いいえ	リクエストのタイムアウトパラメータ。タイムアウトした場合はクエリタスクをキャンセルします
useCache	true	Boolean	はい	trueの場合はキャッシュを使用
zoneOffset	10	Integer	いいえ	タイムゾーン

成功レスポンスの例

{
  "data": {
    "columnDescMeta": {
      "network": "ネットワークタイプ",
      "ip": "IP",
      "browser": "ブラウザ",
      "browser_version": "ブラウザバージョン",
      "manufacturer": "メーカー",
      "#lib": "SDKタイプ",
      "channel": "流入チャネル",
      "platform": "プラットフォーム",
      "serverid": "サーバーID",
      "device_type": "デバイスタイプ",
      "#lib_version": "SDKバージョン",
      "os_version": "OSバージョン",
      "app_version": "appバージョン",
      "os": "OS",
      "lib": "ランタイムライブラリ",
      "level": "ユーザーレベル",
      "model": "機種",
      "screen_height": "画面の高さ",
      "carrier_name": "通信キャリア",
      "vip_level": "VIPレベル",
      "brand": "ブランド",
      "currency_type": "通貨",
      "pay_amount": "課金額",
      "diamond_get_amount": "ダイヤ獲得量",
      "payment_name": "購入パック名",
      "is_first_pay": "初回課金かどうか",
      "#country_code": "国・地域コード",
      "#ip": "クライアントIP",
      "#city": "都市",
      "#province": "省",
      "#country": "国・地域",
      "screen_width": "画面の幅",
      "device_id": "デバイスID",
      "#zone_offset": "タイムゾーンオフセット"
    },
    "eventNameDescMeta": {
      "anyEvent": "任意イベント",
      "activity_attend": "イベント参加",
      "draw_card": "ガチャイベント",
      "gold_consume": "ゴールド消費",
      "gold_get": "ゴールドを獲得",
      "level_up": "レベルアップイベント",
      "login": "ログイン",
      "logout": "ユーザーログアウト",
      "payment": "課金イベント",
      "register": "登録"
    },
    "resultGenerateTime": "2022-01-27 15:46:08",
    "userEventSeqList": [
      {
        "event_name": "login",
        "properties": {
          "#event_time": "2021-11-04 15:59:39.179",
          "network": "WIFI",
          "ip": "27.17.30.245",
          "browser": "Safari",
          "browser_version": "Safari 11.0.3",
          "manufacturer": "Apple",
          "#lib": "easydata",
          "channel": "Baidu",
          "platform": "WeGameプラットフォーム",
          "serverid": "10",
          "device_type": "desktop",
          "#lib_version": "1.0",
          "os_version": "iOS 11.4",
          "app_version": "V1.0",
          "os": "iOS",
          "lib": "JS",
          "level": "93",
          "model": "iPhone X",
          "screen_height": "681",
          "carrier_name": "中国联通",
          "vip_level": "1",
          "brand": "Apple",
          "#country_code": "",
          "#ip": "localhost",
          "#city": "不明",
          "#province": "不明",
          "#country": "不明",
          "screen_width": "360",
          "device_id": "47BjM",
          "#zone_offset": "-5"
        },
        "time": "2021-11-04 15:59:39.179"
      },
      {
        "event_name": "payment",
        "properties": {
          "#event_time": "2021-11-04 15:59:46.179",
          "network": "WIFI",
          "ip": "27.17.30.245",
          "browser": "Safari",
          "browser_version": "Safari 11.0.3",
          "manufacturer": "Apple",
          "#lib": "easydata",
          "channel": "Baidu",
          "platform": "WeGameプラットフォーム",
          "serverid": "10",
          "device_type": "desktop",
          "#lib_version": "1.0",
          "os_version": "iOS 11.4",
          "app_version": "V1.0",
          "os": "iOS",
          "lib": "JS",
          "level": "93",
          "model": "iPhone X",
          "screen_height": "681",
          "carrier_name": "中国联通",
          "vip_level": "1",
          "brand": "Apple",
          "currency_type": "ポイント",
          "pay_amount": "536",
          "diamond_get_amount": "7485",
          "payment_name": "地尊パック",
          "is_first_pay": false,
          "#country_code": "",
          "#ip": "localhost",
          "#city": "不明",
          "#province": "不明",
          "#country": "不明",
          "screen_width": "360",
          "device_id": "47BjM",
          "#zone_offset": "-5"
        },
        "time": "2021-11-04 15:59:46.179"
      }
    ]
  },
  "return_code": 0,
  "return_message": "success"
}

レスポンスパラメータの説明

$$パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ
data	-	Object	戻り値
data.columnDescMeta	-	Map	プロパティ名のマッピング
data.eventNameDescMeta	-	Map	イベント名
data.resultGenerateTime	2022-01-27 15:46:08	String	結果の生成日時
data.userEventSeqList	-	List	ユーザーシーケンスのリスト
data.userEventSeqList.event_name	login	String	イベント名
data.userEventSeqList.properties	-	Map	イベントプロパティの詳細
data.userEventSeqList.time	2021-11-04 15:59:46.179	String	時間

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1008	Integer	リターンコード
return_message	パラメータ(token)が空です	String	リターンメッセージ

ユーザープロパティ分析の共通列挙値

ユーザープロパティ分析の集計タイプの列挙値

値	説明	プロパティが必要か
TRIG_USER_NUM	ユニークユーザー数	いいえ
SUM	数値の合計	はい
AVG	数値の平均値	はい
MAX	数値の最大値	はい
MIN	数値の最小値	はい
DISTINCT	重複除外数	はい
TRUE	True totals	はい
FALSE	False totals	はい
IS_NOT_EMPTY	Not null totals	はい
IS_EMPTY	Null totals	はい
ARRAY_DISTINCT	リストのユニーク数	はい
ARRAY_SET_DISTINCT	セットのユニーク数	はい
ARRAY_ITEM_DISTINCT	要素のユニーク数	はい
MEDIAN	中央値	はい
PERCENTILE	パーセンタイル	はい

このページは役に立ちましたか？

1. ユーザープロパティ分析のクエリ​

リクエストBodyパラメータ​

リクエストパラメータの説明​

成功レスポンスの例​

レスポンスパラメータの説明​

2. ユーザープロパティ分析のフルダウンロード​

リクエストBodyパラメータ​

リクエストパラメータの説明​

レスポンス​

3. ユーザープロパティ分析のユーザーリスト​

リクエストBodyパラメータ​

リクエストパラメータの説明​

成功レスポンスの例​

レスポンスパラメータの説明​

4. プロパティ分析のユーザーリストのダウンロード​

リクエストBodyパラメータ​

リクエストパラメータの説明​

レスポンス​

5. ユーザーイベントリストのクエリ​

リクエストBodyパラメータ​

リクエストパラメータの説明​

成功レスポンスの例​

レスポンスパラメータの説明​

ユーザープロパティ分析の共通列挙値​

ユーザープロパティ分析の集計タイプの列挙値​

1. ユーザープロパティ分析のクエリ

リクエストBodyパラメータ

リクエストパラメータの説明

成功レスポンスの例

レスポンスパラメータの説明

2. ユーザープロパティ分析のフルダウンロード

リクエストBodyパラメータ

リクエストパラメータの説明

レスポンス

3. ユーザープロパティ分析のユーザーリスト

リクエストBodyパラメータ

リクエストパラメータの説明

成功レスポンスの例

レスポンスパラメータの説明

4. プロパティ分析のユーザーリストのダウンロード

リクエストBodyパラメータ

リクエストパラメータの説明

レスポンス

5. ユーザーイベントリストのクエリ

リクエストBodyパラメータ

リクエストパラメータの説明

成功レスポンスの例

レスポンスパラメータの説明

ユーザープロパティ分析の共通列挙値

ユーザープロパティ分析の集計タイプの列挙値