# ユーザー属性分析 API
呼び出し方法Open APIドキュメントの呼び出し方法の説明を参照してください。
使用マニュアルの属性分析使用シーンを知ることができる。
# ユーザー属性分析クエリ
インターフェイス URL
/open/user-prop-analyze?token=xxx
リクエスト方法
POST
コンテンツタイプ
application/json
Query パラメーター
パラメータ名 | サンプル値 | パラメーターの種類 | 必須かどうか | パラメーターの説明 |
---|---|---|---|---|
token | xxx | String | はい | token |
# 要求 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 | はい | グループ化プロパティ |
∟ userCrowds | - | Object | いいえ | 群衆 |
∟ crowdName | 女性 | String | はい | 群衆の名前 |
∟ filts | - | List | はい | オブジェクトをフィルタリング |
∟ columnDesc | 性别 | String | いいえ | フィールド表示名 |
∟ columnName | gender | String | はい | フィールド名 |
∟ comparator | equal | String | はい | 参照:モデルクエリAPIのフィルター式 |
∟ filterType | SIMPLE | String | いいえ | フィルタモード、SIMPLE:シンプル、COMPOUND:コンポジット |
∟ ftv | ["女"] | List | いいえ | プロパティの比較値 |
∟ specifiedClusterDate | 2022-01-27 | String | いいえ | クラスター指定日 |
∟ tableType | user | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
∟ timeUnit | String | いいえ | フィルタリング時間単位 | |
∟ relation | and | String | はい | 論理関係、and:論理と、or:論理や |
events | - | List | はい | イベントインジケータ一覧 |
∟ analysis | SUM | String | はい | 分析の角度 |
∟ analysisDesc | 合計 | String | いいえ | 分析角度の説明(表示名) |
∟ eventNameDisplay | 残高の合計 | String | いいえ | イベント表示名 |
∟ filts | - | List | いいえ | 条件リスト |
∟ columnDesc | 残高 | String | いいえ | フィールド表示名 |
∟ columnName | accountbalance | String | はい | フィールド名 |
∟ comparator | greater | String | はい | 参照:モデルクエリAPIのフィルター式 |
∟ filterType | SIMPLE | String | いいえ | フィルタモード、SIMPLE:シンプル、COMPOUND:コンポジット |
∟ ftv | ["1"] | List | いいえ | プロパティの比較値 |
∟ specifiedClusterDate | 2022-01-27 | String | いいえ | クラスター指定日 |
∟ tableType | user | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
∟ timeUnit | String | いいえ | フィルタリング時間単位 | |
∟ quota | accountbalance | String | いいえ | 論理関係、and:論理と、or:論理や |
∟ relation | and | String | いいえ | 論理関係、and:論理と、or:論理や |
∟ tableType | user | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
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_list | - | List | データリスト |
∟ group_cols | ["女"] | List | グループまたは群衆のリスト |
∟ values | 1140523491 | Integer | ユーザー数 |
∟ group_cols_sorted | ["女"] | List | グループ化または群集順リスト |
∟ group_num | 0 | Integer | パケット数 |
∟ result_generate_time | 2022-01-27 15:01:51 | String | 結果生成時間 |
∟ unit | String | 数値属性単位 |
エラー応答の例
{
"return_code": -1008,
"return_message": "参数(token)为空"
}
パラメータ名 | サンプル値 | パラメーターの種類 | パラメーターの説明 |
---|---|---|---|
return_code | -1008 | Integer | リターンコード |
return_message | パラメータ(token)は空です | String | 戻る情報 |
# ユーザ属性分析ユーザリスト
インターフェイス URL
/open/user-prop-user-list?token=xxx
リクエスト方法
POST
コンテンツタイプ
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 | はい | 分析指標 |
∟ analysis | AVG | List | はい | 分析の種類、集計操作 |
∟ filts | - | List | いいえ | フィルタ項目一覧 |
∟ columnName | latest_login_time | String | はい | フィールド名 |
∟ comparator | relativeCurrentBetween | String | はい | 参照:モデルクエリAPIのフィルター式 |
∟ ftv | ["7", "1"] | List | プロパティの比較値 | |
∟ tableType | user | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
∟ quota | diamond_num | String | いいえ | 指標属性(analysisと協力して、どの属性のどの分析角度を意味するか) |
∟ relation | and | String | いいえ | 論理関係、and:論理と、or:論理や |
∟ tableType | user | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
eventView | - | Object | はい | グループ化属性テーブル |
∟ groupBy | - | List | いいえ | グループ化属性は、0個以上あり得る |
∟ columnName | user_level | String | はい | フィールド名 |
∟ tableType | user | String | はい | テーブルタイプ、event:イベントテーブル、user:ユーザテーブル |
sliceGroupVal | ["31","app store"] | List | いいえ | グループ化 |
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 | 結果を返す |
∟ datalist | - | List | ユーザー情報 |
∟ columMeta | - | Map | フィールド意味マッピング |
エラー応答の例
{
"return_code": -1008,
"return_message": "参数(token)为空"
}
パラメータ名 | サンプル値 | パラメーターの種類 | パラメーターの説明 |
---|---|---|---|
return_code | -1008 | Integer | リターンコード |
return_message | パラメータ(token)は空です | String | 戻る情報 |
# ユーザーイベントリストクエリ
インターフェイス URL
/open/user-event-list?token=xxx
リクエスト方法
POST
コンテンツタイプ
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
}
# リクエストパラメータ説明
パラメーター名 | サンプル値 | パラメーターの種類 | 必須かどうか | パラメーターの説明 |
---|---|---|---|---|
eventNames | ["payment"] | List | はい | 含まれるイベントの一覧 |
pagerHeader | - | Object | はい | 汎用ページング要求ヘッダ |
∟ pageNum | 1 | Long | いいえ | 開始ページ |
∟ pageSize | 2 | Long | いいえ | ページ数 |
projectId | 377 | Integer | はい | プロジェクトID |
startDateTime | ["2021-11-04 00:00:00"] | List | いいえ | 開始時刻リストyyyy-MM-dd HH: mm: ss |
dateFormat | week | String | はい | 時間次元の単位 minute: 1分押す minute5: 5分押す(v3.5サポート開始) minute10: 10分押す(v3.5サポート開始) hour:時間単位 day:日ごと week:週ごと 月:月ごと total:合計 |
firstDayOfWeek | 1 | Integer | いいえ | 週明け |
userId | 795687603434164226 | Long | はい | 分析対象のユーザID |
timeoutSeconds | 10 | Integer | いいえ | タイムアウトパラメーターが要求され、タイムアウトするとクエリタスク |
useCache | true | Boolean | いいえ | キャッシュを使用します。オプションのパラメーターはデフォルトでtrueです |
# 成功応答の例
{
"data": {
"columnDescMeta": {
"network": "网络类型",
"ip": "IP",
"browser": "浏览器",
"browser_version": "浏览器版本",
"manufacturer": "制造商",
"#lib": "SDK类型",
"channel": "来源渠道",
"platform": "平台",
"serverid": "区服ID",
"device_type": "设备类型",
"#lib_version": "SDK版本",
"os_version": "操作系统版本",
"app_version": "app版本",
"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": "苹果",
"#lib": "easydata",
"channel": "百度",
"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": "苹果",
"#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": "苹果",
"#lib": "easydata",
"channel": "百度",
"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": "苹果",
"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 | 結果を返す |
∟ columnDescMeta | - | Map | プロパティ名マッピング |
∟ eventNameDescMeta | - | Map | イベント名 |
∟ resultGenerateTime | 2022-01-27 15:46:08 | String | 結果生成時間 |
∟ userEventSeqList | - | List | ユーザシーケンスリスト |
∟ event_name | login | String | イベント名 |
∟ properties | - | Map | イベントプロパティの詳細 |
∟ time | 2021-11-04 15:59:46.179 | String | 時間 |
エラー応答の例
{
"return_code": -1008,
"return_message": "参数(token)为空"
}
パラメータ名 | サンプル値 | パラメーターの種類 | パラメーターの説明 |
---|---|---|---|
return_code | -1008 | Integer | リターンコード |
return_message | パラメータ(token)は空です | String | 戻る情報 |