# 小游戏分析数据接口接入指南

向小游戏开发者开放分析数据接口 analysis.getGameAnalysisData。 通过数据接口，开发者可以获取公众平台统计模块和小游戏数据助手上的数据，按需做进一步处理。

请注意：

1. 接口限制：当时间粒度为自然日/自然周/自然月，仅允许查询单个粒度时长；当时间粒度为1分钟/5分钟/1小时，仅允许查询最大时长为24小时的时间范围；
2. 因计算资源限制，自然日/自然周/自然月粒度的数据结果计算时间不固定，建议开发者间隔6小时采集1次；
3. 建议开发者在调用接口获取数据后，将数据保存在自身数据库中，以最大化访问的效率，也降低微信侧接口调用的不必要损耗；
4. 部分维度取值范围是动态的，维度定义板块不会给出固定的枚举值列表，需要通过接口获取实际数据；
5. 部分指标的计算会进行时间偏移，如次日留存/七日留存，需要根据指标定义对查询时间做相应的偏移；

# 概念说明

数据包含若干列，按列属性可划分为时间、维度、指标。

1. 时间：不同数据可能支持多种粒度，指标按粒度进行聚合计算得到；
2. 维度：事物的属性特征，多个属性间有层次/组合关系，例如省份/城市、平台×性别；
3. 指标：事物的度量，按维度聚合统计得到，例如DAU、ARPPU等；

# 查询示例

假设有DAU数据如下，包含平台×性别的维度：

1. 要查询2020-10-02，不区分具体平台的男性用户数（即红框数据），请求参数如下：

   {
     "metric": "1000006:4", // 指标id
     "granularity": 24, // 自然天的枚举值
     "start_time": 1601568000,  // 数据起始时间，北京时间2020-10-02 00:00:00的时间戳
     "end_time": 1601654400, // 数据结束时间，北京时间2020-10-03 00:00:00的时间戳
     "filter_list": [
       {
         "dimension": "3", // 性别维度id
         "value": "1" // 性别维度男性的枚举值
       }
       // 不区分平台，可不设置平台维度的filter
     ]
   }
   

   CURL命令示例： curl 'https://api.weixin.qq.com/datacube/getgameanalysisdata?access_token=${access_token}' -X POST -d '{"metric":"1000006:4","granularity":24,"start_time":1601568000,"end_time":1601654400,"filter_list":[{"dimension":"3","value":"1"}]}'

   查询结果：

   {
     "data_list": [
       {
         "timestamp": 1601568000, // 数据时间，北京时间2020-10-02 00:00:00的时间戳
         "time_label": "2020-10-02",
         "metric_value": 51
       }
     ]
   }
   

2. 要查询2020-10-02，指定iPhone平台下的性别用户数分布（即蓝框数据），请求参数如下：

   {
     "metric": "1000006:4", // 指标id
     "granularity": 24, // 自然天的枚举值
     "start_time": 1601568000,  // 数据起始时间，北京时间2020-10-02 00:00:00的时间戳
     "end_time": 1601654400, // 数据结束时间，北京时间2020-10-03 00:00:00的时间戳
     "filter_list": [
       {
         "dimension": "5", // 平台维度id
         "value": "1" // 平台维度iPhone的枚举值
       }
     ],
     "group_list": [
       "3" // 按性别维度分组
     ]
   }
   

   CURL命令示例： curl 'https://api.weixin.qq.com/datacube/getgameanalysisdata?access_token=${access_token}' -X POST -d '{"metric":"1000006:4","granularity":24,"start_time":1601568000,"end_time":1601654400,"filter_list":[{"dimension":"5","value":"1"}],"group_list":["3"]}'

   查询结果：

   {
     "data_list": [
       {
         "timestamp": 1601568000, // 数据时间，北京时间2020-10-02 00:00:00的时间戳
         "time_label": "2020-10-02",
         "group_dimension_list": [
           {
             "value": "-9999",
             "label": "全部" // 汇总值
           }
         ],
         "metric_value": 52
       },
       {
         "timestamp": 1601568000, // 数据时间，北京时间2020-10-02 00:00:00的时间戳
         "time_label": "2020-10-02",
         "group_dimension_list": [
           {
             "value": "1",
             "label": "iPhone"
           }
         ],
         "metric_value": 25
       },
       {
         "timestamp": 1601568000, // 数据时间，北京时间2020-10-02 00:00:00的时间戳
         "time_label": "2020-10-02",
         "group_dimension_list": [
           {
             "value": "2",
             "label": "Android"
           }
         ],
         "metric_value": 27
       }
     ]
   }
   

   备注：推荐使用方式2，group_list字段填当前查询指标的所有可用维度，一次性拉取所有维度结果

# 指标定义

更多数据指标建设中，敬请期待

# 活跃用户

# 注册用户

# 付费用户

# 分享用户

# 场景渠道分析-活跃用户

# 场景渠道分析-注册用户

# 产品渠道分析-活跃用户

# 产品渠道分析-注册用户

# 自定义渠道分析-活跃用户

# 自定义渠道分析-注册用户

# 自定义渠道分析-付费用户

# 维度定义

# 小游戏自定义渠道分析-渠道

动态取值范围，无固定枚举值列表

# 小游戏自定义渠道分析-分组

动态取值范围，无固定枚举值列表

# 年龄段

# 平台

# 微信公众平台账号

动态取值范围，无固定枚举值列表

# 性别

# 场景渠道

# 注意：2024年10月30日（包含2024年10月30日）之后使用以下场景渠道维度

# 注意：2024年10月30日 之前使用以下场景渠道维度

# 产品渠道