微信小程序 getUserPortrait

2022-05-10 16:23 更新

analysis.getUserPortrait

本接口應在服務器端調(diào)用,詳細說明參見服務端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

獲取小程序新增或活躍用戶的畫像分布數(shù)據(jù)。時間范圍支持昨天、最近7天、最近30天。其中,新增用戶數(shù)為時間范圍內(nèi)首次訪問小程序的去重用戶數(shù),活躍用戶數(shù)為時間范圍內(nèi)訪問過小程序的去重用戶數(shù)。

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請求地址

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

請求參數(shù)

屬性 類型 默認值 必填 說明
access_token string 接口調(diào)用憑證
begin_date string 開始日期。格式為 yyyymmdd
end_date string 結(jié)束日期,開始日期與結(jié)束日期相差的天數(shù)限定為0/6/29,分別表示查詢最近1/7/30天數(shù)據(jù),允許設置的最大值為昨日。格式為 yyyymmdd

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
ref_date string 時間范圍,如:"20170611-20170617"
visit_uv_new Object 新用戶畫像
visit_uv Object 活躍用戶畫像

visit_uv_new 的結(jié)構(gòu)

屬性 類型 說明
index number 分布類型
province Object 省份,如北京、廣東等
city Object 城市,如北京、廣州等
genders Object 性別,包括男、女、未知
platforms Object 終端類型,包括 iPhone,android,其他
devices Object 機型,如蘋果 iPhone 6,OPPO R9 等
ages Object 年齡,包括17歲以下、18-24歲等區(qū)間

province 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

city 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

genders 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

platforms 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

devices 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

ages 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

visit_uv 的結(jié)構(gòu)

屬性 類型 說明
index number 分布類型
province Object 省份,如北京、廣東等
city Object 城市,如北京、廣州等
genders Object 性別,包括男、女、未知
platforms Object 終端類型,包括 iPhone,android,其他
devices Object 機型,如蘋果 iPhone 6,OPPO R9 等
ages Object 年齡,包括17歲以下、18-24歲等區(qū)間

province 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

city 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

genders 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

platforms 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

devices 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

ages 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
access_source_visit_uv number 該場景訪問uv

請求數(shù)據(jù)示例

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

返回數(shù)據(jù)示例

{
  "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
      }
    ]
  }
}

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。

接口方法

openapi.analysis.getUserPortrait
需在 config.json 中配置 analysis.getUserPortrait API 的權(quán)限,詳情

請求參數(shù)

屬性 類型 默認值 必填 說明
beginDate string 開始日期。格式為 yyyymmdd
endDate string 結(jié)束日期,開始日期與結(jié)束日期相差的天數(shù)限定為0/6/29,分別表示查詢最近1/7/30天數(shù)據(jù),允許設置的最大值為昨日。格式為 yyyymmdd

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
refDate string 時間范圍,如:"20170611-20170617"
visitUvNew Object 新用戶畫像
visitUv Object 活躍用戶畫像

visitUvNew 的結(jié)構(gòu)

屬性 類型 說明
index number 分布類型
province Object 省份,如北京、廣東等
city Object 城市,如北京、廣州等
genders Object 性別,包括男、女、未知
platforms Object 終端類型,包括 iPhone,android,其他
devices Object 機型,如蘋果 iPhone 6,OPPO R9 等
ages Object 年齡,包括17歲以下、18-24歲等區(qū)間

province 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

city 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

genders 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

platforms 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

devices 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

ages 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

visitUv 的結(jié)構(gòu)

屬性 類型 說明
index number 分布類型
province Object 省份,如北京、廣東等
city Object 城市,如北京、廣州等
genders Object 性別,包括男、女、未知
platforms Object 終端類型,包括 iPhone,android,其他
devices Object 機型,如蘋果 iPhone 6,OPPO R9 等
ages Object 年齡,包括17歲以下、18-24歲等區(qū)間

province 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

city 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

genders 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

platforms 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

devices 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

ages 的結(jié)構(gòu)

屬性 類型 說明
id number 屬性值id
name string 屬性值名稱,與id對應。如屬性為 province 時,返回的屬性值名稱包括「廣東」等。
accessSourceVisitUv number 該場景訪問uv

請求數(shù)據(jù)示例

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

返回數(shù)據(jù)示例

{
  "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"
}


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號