# 获取小程序用户画像分布

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：getUserPortrait

该接口用于获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天。其中，新增用户数为时间范围内首次访问小程序的去重用户数，活跃用户数为时间范围内访问过小程序的去重用户数。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/datacube/getweanalysisappiduserportrait?access_token=ACCESS_TOKEN

支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情

# 云调用

调用方法：analysis.getUserPortrait
出入参和 HTTPS 调用相同，调用方式可查看云调用说明文档

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：18
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	说明
access_token	string	是	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
begin_date	string	是	开始日期。格式为 yyyymmdd
end_date	string	是	结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，允许设置的最大值为昨日。格式为 yyyymmdd

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
ref_date	string	时间范围，如："20170611-20170617"
visit_uv_new	object	新用户画像
visit_uv	object	活跃用户画像

# Res.visit_uv_new `Object Payload`

新用户画像

参数名	类型	说明
province	objarray	省份，如北京、广东等
city	objarray	城市，如北京、广州等
genders	objarray	性别，包括男、女、未知
platforms	objarray	平台类型，包括 Android、iOS 等
devices	objarray	终端类型，包括 iPhone，android，其他
ages	objarray	年龄，包括17岁以下、18-24岁等区间

# Res.visit_uv `Object Payload`

活跃用户画像

参数名	类型	说明
province	objarray	省份，如北京、广东等
city	objarray	城市，如北京、广州等
genders	objarray	性别，包括男、女、未知
platforms	objarray	平台类型，包括 Android、iOS 等
devices	objarray	终端类型，包括 iPhone，android，其他
ages	objarray	年龄，包括17岁以下、18-24岁等区间

# Res.visit_uv_new.province(Array) `Object Payload`

省份，如北京、广东等

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv_new.city(Array) `Object Payload`

城市，如北京、广州等

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv_new.genders(Array) `Object Payload`

性别，包括男、女、未知

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv_new.platforms(Array) `Object Payload`

平台类型，包括 Android、iOS 等

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv_new.devices(Array) `Object Payload`

终端类型，包括 iPhone，android，其他

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv_new.ages(Array) `Object Payload`

年龄，包括17岁以下、18-24岁等区间

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv.province(Array) `Object Payload`

省份，如北京、广东等

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv.city(Array) `Object Payload`

城市，如北京、广州等

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv.genders(Array) `Object Payload`

性别，包括男、女、未知

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv.platforms(Array) `Object Payload`

平台类型，包括 Android、iOS 等

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv.devices(Array) `Object Payload`

终端类型，包括 iPhone，android，其他

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# Res.visit_uv.ages(Array) `Object Payload`

年龄，包括17岁以下、18-24岁等区间

参数名	类型	说明
id	number	属性值id
name	string	属性值名称，与id对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。
value	number	该场景访问uv

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

# 5.1 HTTPS调用

请求示例

{
  "begin_date": "20170611",
  "end_date": "20170617"
}

返回示例

{
  "ref_date": "20170611",
  "visit_uv_new": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 215
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 78
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 2146
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 27642
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 61
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 151
      }
    ]
  },
  "visit_uv": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 1341
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 234
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 14534
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 21750
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 617
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 3156
      }
    ]
  }
}

# 5.2 云函数调用

请求示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.analysis.getUserPortrait({
        "beginDate": '20170611',
        "endDate": '20170617'
      })
    return result
  } catch (err) {
    return err
  }
}

返回示例

{
  "refDate": "20170611",
  "visitUvNew": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 215
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 78
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 2146
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 27642
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 61
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 151
      }
    ]
  },
  "visitUv": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 1341
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 234
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 14534
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 21750
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 617
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 3156
      }
    ]
  },
  "errMsg": "openapi.analysis.getUserPortrait:ok"
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口

# 7. 适用范围

本接口在不同账号类型下的可调用情况：

小程序	小游戏
✔	✔

✔：该账号可调用此接口
其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；

# 获取小程序用户画像分布

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

# Res.visit_uv_new Object Payload

# Res.visit_uv Object Payload

# Res.visit_uv_new.province(Array) Object Payload

# Res.visit_uv_new.city(Array) Object Payload

# Res.visit_uv_new.genders(Array) Object Payload

# Res.visit_uv_new.platforms(Array) Object Payload

# Res.visit_uv_new.devices(Array) Object Payload

# Res.visit_uv_new.ages(Array) Object Payload

# Res.visit_uv.province(Array) Object Payload

# Res.visit_uv.city(Array) Object Payload

# Res.visit_uv.genders(Array) Object Payload

# Res.visit_uv.platforms(Array) Object Payload

# Res.visit_uv.devices(Array) Object Payload

# Res.visit_uv.ages(Array) Object Payload