旧-帮助文档
回到 GrowingIO
  • GrowingIO 帮助文档
  • 快速提交工单
  • 快速上手-Web
  • 快速上手-移动端
  • 快速上手-小程序
  • 产品更新日志
  • 分析工具
    • 事件分析
    • 用户分群
    • 用户细查
    • 漏斗分析
    • 活动分析
    • 落地页分析
    • 分布分析
    • 智能路径
    • 留存分析
    • 留存魔法师
    • 活跃用户分析
    • 热图分析
      • Web 端热图
      • App 热图
    • 单图
    • 微信应用用户分析
    • 小程序-分享分析
  • 看板
    • 自定义首页
    • 概览看板
    • KPI看板(企业版)
    • 小程序预置看板
    • 微信内嵌页预置看板
    • 实时监控模板
    • 业务场景
  • GIO 小程序看数助手
  • 广告监测
    • 创建监测链接
      • 推广 App
      • 推广网页
      • 推广小程序(微信)
    • 数据报表
      • 应用级数据
      • 深度数据分析
      • 数据指标说明
    • 推广管理
      • 监测链接
      • 广告活动
      • 推广渠道
    • 渠道配置指南
      • 腾讯社交广告
      • 今日头条
      • 百度原生信息流
      • 微博超级粉丝通
      • 爱奇艺
      • Inmobi
      • 微信广告平台
      • 凤羽广告平台
      • bilibili(B 站)
    • 其他功能
      • 日志导出
      • 维度配置
      • 权限配置
      • 反作弊规则
      • 深度链接配置
    • 相关知识
      • UTM 参数使用指南
      • 创建小程序的推广码
      • 移动端转化归因
      • 默认的渠道来源跟踪
      • DeepLink 启用新域名
    • 广告监测FAQ
  • SDK 文档
    • SDK 简介与安全性说明
    • 各平台 SDK 支持明细
    • SDK 更新日志
    • Web JS SDK
      • Web JS SDK API
      • Web JS SDK 常见问题
    • Android SDK
      • Android 无埋点 SDK
      • Android 无埋点 SDK API
      • Android 半自动采集浏览事件
      • Android 埋点 SDK
      • Android SDK 常见问题
    • iOS SDK
      • iOS 无埋点SDK
      • iOS SDK API
      • iOS 半自动采集浏览事件
      • iOS SDK 1.X旧版本升级指导
      • iOS 埋点SDK
      • iOS SDK 常见问题
    • Hybrid SDK (App内嵌H5)
    • 小程序、小游戏以及内嵌页 SDK
      • SDK 更新日志 - 小程序 & 内嵌页 & 快应用
      • 微信小程序 SDK
        • mpvue+第三方插件 添加代码
      • 微信小游戏 SDK
      • H5 内嵌页 SDK
      • 支付宝小程序 SDK
      • 百度小程序 SDK
      • QQ 小程序 SDK
      • 字节跳动小程序 SDK
      • 快应用 SDK
    • React Native 无埋点 SDK
      • ReactNative 埋点 SDK
    • Flutter 埋点 SDK
    • Cordova 埋点 SDK
    • Weex 埋点 SDK
    • API Cloud埋点 SDK
    • AppCan 埋点 SDK
    • Java 埋点 SDK
    • PHP 埋点 SDK
    • GrowingIO Debugger
      • 验证打点事件
  • 数据模型
    • 用户模型
      • 访问用户
      • 登录用户
      • 用户属性
    • 事件模型
      • 什么是事件
      • 无埋点事件
        • 访问事件及属性
        • 页面事件及属性
        • 动作事件及属性
      • 埋点事件
        • 埋点事件及属性
    • 统计模型
      • 指标--事件的度量
      • 维度--事件的属性
      • 预定义的指标和维度
  • 数据定义
    • 用户变量
      • 登录用户变量
      • 访问用户变量
    • 页面级变量
      • 查询条件直接设置成页面级变量
    • 无埋点圈选
      • Web 圈选
      • App 端圈选 App
      • 电脑端圈选 App
      • 小程序数据定义
      • 微信内嵌页数据定义
      • 圈选指标管理
        • 合并简单指标
        • 复合指标
    • 埋点事件
      • 埋点事件级变量
      • 转化变量
    • 小程序事件和变量
  • 数据管理
    • 新版数据管理功能说明
    • 无埋点事件管理
    • 埋点事件管理
    • 变量管理
    • 合并事件管理
    • 计算指标
  • 系统配置
    • 组织管理
    • 项目管理
    • 用户管理
    • 权限管理
    • 爬虫规则
    • 账号管理
    • UTM 映射管理
    • IP及域名数据过滤
  • API
    • GrowingIO API 认证
    • 广告监测链接创建服务 API
    • 微信小程序二维码创建服务 API
    • 原始数据导出 API
      • 原始数据导出字段说明
        • 无埋点事件
        • 埋点事件与变量
        • 广告相关数据
        • 通用字段说明
      • 原始数据导出 2.0 API
      • 原始数据导出 1.0 API(已废弃)
      • 原始数据导出 API 的升级迁移
      • 原始数据导出格式及处理建议
    • 统计数据导出 API
    • 埋点数据上传API
    • 用户变量上传 API
    • 项目管理 API
    • 数据管理 API (GDPR)
    • API 更新日志
  • 常见问题
    • 基本问题
    • SDK 集成
    • 圈选常见问题
    • 指标和维度
    • 数据安全
    • 产品使用
    • 数据统计差异
    • 无效指标清理说明
  • 内容贡献者
  • 帮助文档问题反馈
Powered by GitBook
On this page
  • 说明
  • 接口调用文档
  • 1.系统校验规则说明
  • 2.使用流程
  • 3.认证说明
  • 4.API接口详细
  • 返回数据
  1. API

微信小程序二维码创建服务 API

Previous广告监测链接创建服务 APINext原始数据导出 API

Last updated 5 years ago

说明

微信小程序二位码,是调用腾讯微信小程序接口的。其中创建小程序码,腾讯提供 A、B 两个接口;创建二维码,微信提供 C 接口。

GrowingIO 在授权后,调用的是 A 和 C 接口创建小程序码和二维码。

具体详情请见微信开发者文档:

其中

  1. 接口只能生成已发布的小程序的码;

  2. 接口 A 加上接口 C,总共生成的码数量限制为 100,000;如果使用 GrowingIO 的批量创建码的服务,请谨慎调用。

接口调用文档

注意:

  • productId 需要在中查询获取。

  • 在进行导出之前,请务必参考,完成接口认证获取 token 。

1.系统校验规则说明

1.1 项目 ID (AI) 与应用相关:

规则一:推广的应用是否隶属于当前项目。

1.2 推广活动相关:

规则一:同项目下推广活动不能重名。 规则二:推广活动名称限制50个字符,仅支持中英文数字-/_,。

1.3 渠道相关:

规则一:同项目下渠道名称不能重名,包括自定义渠道及系统预定义渠道。 规则二:渠道名称限制50个字符,仅支持中英文数字-/_,。

1.4 监测链接相关

规则一:同项目下监测链接不能重名。 规则二:监测链接名称限制50个字符,仅支持中英文数字-/_,。 规则三:针对跳转地址有URL基本校验(是否可跳转,格式校验)。 规则四:必填校验。详见后续不同监测链接的创建逻辑。

2.使用流程

为保证数据安全,GrowingIO所有的API服务,请求Head中需要携带Token。

完整的监测链接创建流程见下图:

3.认证说明

名字

类型

描述

示例

X-Client-Id

String

GrowingIO 分配的公钥,请在GrowingIO后台“项目配置”页面获取

X-Client-Id: 123abc

Authorization

String

认证后获取到的 Token

Authorization: Token xxxxxx

4.API接口详细

4.1 应用 API

新建应用请在GIO后台操作,此接口仅提供应用ID的查询。

GET https://www.growingio.com/api/v1/projects/{项目编号}/meta/products

Response: Status Code: 200 OK

字段名

字段格式

说明

示例

id

String

产品编号

gnPNkoWA

name

String

名字

GIO测试 SDK

displayName

String

对应的 app id

LPdgKARN

activated

Bool

是否有效

true

spn

String

spn

wx51cba5e78d4ef4d8

urlSchema

String

产品的url schema

8137d31f4e7b819f

platform

String

平台

minp

createdAt

Long

创建时间

1480635903152

Response 示例:

[
    {
        "displayName": "mina growth",
        "name": "GIO测试 SDK",
        "activated": true,
        "spn": "wx51cba5e78d4ef4d8",
        "id": "Lj9yBRyD",
        "createdAt": 1480635903152,
        "urlSchema": "8137d31f4e7b819f",
        "platform": "minp"
    },
    {
        "displayName": "gio",
        "name": "Growingio 测试产品",
        "activated": true,
        "spn": "2018071560686136",
        "id": "GQPDxPNm",
        "createdAt": 1522019721098,
        "urlSchema": "8137d31f4e7b819f",
        "platform": "alip"
    }
]

4.2 推广活动相关 API

此部分相关接口可以查询已有活动的活动ID或者创建新的活动。

POST https://www.growingio.com/api/v1/projects/{项目编号}/meta/campaigns

Request:

字段名

字段格式

说明

示例

name

String

名字

双十一推广

productId

String

对应 app 的 id

LPdgKARN

示例:

{
  "productId":"rREJ88PL",
  "name":"双十一推广"
}

Response: Status Code: 200 OK

字段名

字段格式

说明

示例

id

String

活动 id

gnPNkoWA

productId

String

对应 app 的 id

LPdgKARN

name

String

名字

双十一推广

示例:

{
  "id": "gnPNkoWA",
  "productId":"rREJ88PL",
  "name":"双十一推广"
}

GET https://www.growingio.com/api/v1/projects/{项目编号}/meta/campaigns

Response: Status Code: 200 OK

字段名

字段格式

说明

示例

id

String

campaign id

gnPNkoWA

name

String

名字

双十一推广

productId

String

对应 app 的 id

LPdgKARN

Response 示例:

[
  {
    "id": "gnPNkoWA",
    "name": "大太阳活动",
    "productId": "LPdgKARN"
  },
  {
    "id": "La9BwRne",
    "name": "美丽星辰",
    "productId": "LPdgKARN"
  }
]

4.3 渠道管理 API

此相关部分API可以进行渠道的ID查询及新建渠道。

POST https://www.growingio.com/api/v1/projects/{项目编号}/meta/channels

Request:

字段名

字段格式

说明

示例

name

String

名字

二维码推广

示例:

{
  "name":"线下地推"
}

GET https://www.growingio.com/api/v1/projects/{项目编号}/meta/channels

Response: Status Code: 200 OK

字段名

字段格式

说明

示例

id

String

channel id

gnPNkoWA

name

String

名字

今日头条

Response 示例:

[
  {
    "id": "gnPNkoWA",
    "name": "二维码推广"
  },
  {
    "id": "jinritoutiao",
    "name": "今日头条"
  }
]

4.4 链接创建 API

请求地址

POST

https://www.growingio.com/api/v1/projects/:project_id/meta/minplinks

请求参数

路径参数:

参数名称

示例

备注

projectId

nxog09md

Headers:

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Body:

名称

类型

是否必须

备注

productId

string

必须

对应微信小程序应用id,在 4.1 请求应用中获得

buildQrCode

boolean

必须

是否创建二维码

redirectUrl

string

必须

跳转链接

campaignId

string

必须

活动 id

channelId

string

必须

渠道 id

utmMedium

string

非必须

utm medium 参数

utmContent

string

非必须

utm content 参数

utmTerm

string

非必须

utm term 参数

comments

string

非必须

备注

codeType

string

非必须

二维码类型,A码或C码

name

string

必须

名字

调用 A 接口创建 小程序码 的请求参数示例

// 创建小程序广告监测链接,同时创建小程序码 (A码)
// Request Payload
{
    "name": "minp-qrcode-test-001",
    "productId": "3oL4DgoW",
    "redirectUrl": "pages/list/list",
    "channelId": "woVOxv92",
    "campaignId": "39l1r3R2",
    "utmMedium": "广告媒介",
    "utmTerm": "免费试用",
    "utmContent": "广告内容",
    "comments": "这是注释",
    "buildQrCode": true,
    "codeType": "A"
}

调用 C 接口创建 小程序码 的请求参数示例

// 创建小程序广告监测链接,同时创建小程序二维码 (C码)
// Request Payload
{
    "name": "minp-qrcode-test-002",
    "productId": "3oL4DgoW",
    "redirectUrl": "pages/list/list",
    "channelId": "woVOxv92",
    "campaignId": "39l1r3R2",
    "utmMedium": "广告媒介",
    "utmTerm": "免费试用",
    "utmContent": "广告内容",
    "comments": "这是注释",
    "buildQrCode": true,
    "codeType": "C"
}

返回数据

名称

类型

是否必须

备注

其他信息

id

string

非必须

linkId

string

非必须

监测链接ID

name

string

非必须

名字

projectId

string

非必须

项目 id

spn

string

非必须

spn

trackingUrl

string

非必须

GrowingIO 分配的追踪链接

redirectUrl

string

非必须

目标链接

campaignId

string

非必须

活动 id

campaignName

string

非必须

活动 名称

channelId

string

非必须

渠道 id

channelName

string

非必须

渠道名称

utmMedium

string

非必须

utm medium 参数

utmContent

null

非必须

utm content 参数

utmTerm

null

非必须

utm term 参数

comments

null

非必须

备注

status

string

非必须

状态

creatorId

string

非必须

创建人 id

creatorName

string

非必须

创建人名称

updaterId

string

非必须

更新人 id

updaterName

string

非必须

更新人名称

createdAt

number

非必须

创建时间

updatedAt

number

非必须

更新时间

调用 A 接口创建 小程序码 的请求,返回参数示例

// Response
{
    "id": "a9a84ZoB",
    "linkId": "a9a84ZoB",
    "name": "minp-qrcode-test-001",
    "projectId": "GR4mj3PM",
    "spn": "wx51cba5e78d4ef4d8",
    "trackingUrl": "pages/list/list?aid=a9a84ZoB",
    "redirectUrl": "pages/list/list",
    "campaignId": "39l1r3R2",
    "campaignName": "上线前测试",
    "channelId": "woVOxv92",
    "channelName": "csdn",
    "utmMedium": "广告媒介",
    "utmContent": "广告内容",
    "utmTerm": "免费试用",
    "comments": "这是注释",
    "qrCode": "https://gta.growingio.com/buckets/uploads/files/81624/wxcode/A/1557038991079/wxcode.jpg?sign=QNV9UcW0i%2BLVbDj%2F59KXV5l0kVQtGN%2BwxRDDOLyQQWc%3D&expires=1557039291693",
    "status": "activated",
    "creatorId": "6LPdeoNl",
    "creatorName": "Dingding",
    "updaterId": "6LPdeoNl",
    "updaterName": "Dingding",
    "createdAt": 1557038990657,
    "updatedAt": 1557038990657
}

调用 C 接口创建 小程序码 的请求,返回参数示例

//Response 
{
    "id": "nPNWAaoW",
    "linkId": "nPNWAaoW",
    "name": "minp-qrcode-test-002",
    "projectId": "GR4mj3PM",
    "spn": "wx51cba5e78d4ef4d8",
    "trackingUrl": "pages/list/list?aid=nPNWAaoW",
    "redirectUrl": "pages/list/list",
    "campaignId": "39l1r3R2",
    "campaignName": "上线前测试",
    "channelId": "woVOxv92",
    "channelName": "csdn",
    "utmMedium": "广告媒介",
    "utmContent": "广告内容",
    "utmTerm": "免费试用",
    "comments": "这是注释",
    "qrCode": "https://gta.growingio.com/buckets/uploads/files/81624/wxcode/C/1557039139065/wxcode.jpg?sign=NIWNlKpis743%2BJ%2FJbB3ObrqTHXi0OCRlWyfGD8ng%2BIQ%3D&expires=1557039439512",
    "status": "activated",
    "creatorId": "6LPdeoNl",
    "creatorName": "Dingding",
    "updaterId": "6LPdeoNl",
    "updaterName": "Dingding",
    "createdAt": 1557039138779,
    "updatedAt": 1557039138779
}

Token获取详见:

详细的认证过程请参考:

“GrowingIO接口认证”文档
https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/qr-code.html
“GrowingIO接口认证”文档
应用 API
认证说明