一.概述
为满足广大客户更灵活创建广告监测链接的诉求，GrowingIO（以下简称GIO）提供了一套创建监测链接的API。本章节旨在说明一些调用流程，逻辑及相关接口说明。
二.接口定义
1.查询应用ID
此接口仅提供应用ID的查询，新建应用请在GIO后台操作。
https://www.growingio.com/api/v1/projects/project_uid/meta/products
GET
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
返回参数
名称 | 类型 | 说明 |
id | string | 产品ID |
name | string | 名字 |
displayName | string | 产品显示名称，展示在deeplink页面 |
activated | boolean | 是否有效 true |
spn | string | App包名。 |
urlScheme | string | 产品的URL Scheme |
platform | string | 平台 |
createdAt | long | 创建时间 示例：1522019721098 |
响应示例
[
{
"displayName": "renrendai",
"name": "renrendai",
"activated": true,
"spn": "com.hecom.Guanghua",
"id": "Lj9yBRyD",
"createdAt": 1480635903152,
"urlSchema": "8137d31f4e7b819f",
"platform": "android"
},
{
"displayName": "gio",
"name": "Growingio 测试产品",
"activated": true,
"spn": "www.gioee.com",
"id": "GQPDxPNm",
"createdAt": 1522019721098,
"urlSchema": "8137d31f4e7b819f",
"platform": "ios"
}
]2.新建推广活动
https://www.growingio.com/api/v1/projects/project_uid/meta/campaigns
POST
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 是 | 名称 示例：双十一推广 |
productId | string | 否 | 对应的App的ID。 |
body示例
{
"productId":"rREJ88PL",
"name":"双十一推广"
}返回参数
名称 | 类型 | 说明 |
id | string | 活动ID。 |
name | string | 活动名称。 |
productId | string | 对应App的ID。 |
响应示例
{
"id": "gnPNkoWA",
"productId":"rREJ88PL",
"name":"双十一推广"
}3.查询推广活动ID
https://www.growingio.com/api/v1/projects/project_uid/meta/campaigns
GET
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
返回参数
名称 | 类型 | 说明 |
id | string | campaign id，活动ID。 |
name | string | 活动名称。 |
响应示例
[
{
"id": "gnPNkoWA",
"name": "双十一推广"
},
{
"id": "La9BwRne",
"name": "美丽星辰"
}
]4.新建推广渠道
https://www.growingio.com/api/v1/projects/project_uid/meta/channels
POST
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 渠道名称。 |
返回参数
名称 | 类型 | 说明 |
id | string | 渠道ID。 |
name | string | 渠道名称。 |
body示例
{
"name":"二维码推广"
}5.查询推广渠道ID
https://www.growingio.com/api/v1/projects/project_uid/meta/channels
GET
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
返回参数
名称 | 类型 | 说明 |
id | string | channel id，渠道ID。 |
name | string | 渠道名称。 |
响应示例
[
{
"id": "gnPNkoWA",
"name": "二维码推广"
},
{
"id": "HnKoPtrq",
"name": "今日头条"
}
]6.新建监测链接（吸引用户直接打开App）
https://www.growingio.com/api/v1/projects/project_uid/meta/deeplinks
POST
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 是 | 监测链接名称，长度50个字符内，同一个账号下系统会进行链接的同名校验，请勿重复提交同名链接。 |
productIdAndroid | string | 否 | Android产品ID。 从查询应用ID获取，iOS和Android至少填一个。 |
productIdIos | string | 否 | iOS产品ID。 从查询应用ID获取，iOS和Android至少填一个。 |
channelId | string | 是 | 渠道ID。 |
campaignIdIos | string | 否 | Android活动ID。 iOS和Android至少填一个。 |
campaignIdAndroid | string | 否 | iOS活动ID。 iOS和Android至少填一个。 |
downloadUrlIos | string | 否 | iOS应用下载地址。 |
downloadUrlAndroid | string | 否 | Android应用下载地址。 |
iosParams | string | 否 | iOS唤醒参数。 示例：{"uri":"key1:value1&key2:value2"} |
androidParams | string | 否 | Android唤醒参数。 示例：{"uri":"key1:value1&key2:value2"} |
返回参数
名称 | 类型 | 说明 |
linkId | string | 监测链接ID |
id | string | 资源ID。 |
name | string | 监测链接名称 |
trackingUrl | string | 监测链接 |
productIdAndroid | string | Android 产品ID |
productNameAndroid | string | 应用名称 |
productIdIos | string | iOS 产品ID |
productNameIos | string | 应用名称 |
channelId | string | 渠道ID |
channelName | string | 渠道名称 |
campaignIdIos | string | iOS 推广活动ID |
campaignIdAndroid | string | Android 推广活动ID |
campaignNameIos | string | iOS 应用所属推广活动名称 |
campaignNameAndroid | string | Android 应用所属推广活动名称 |
downloadUrlIos | string | iOS下载链接 |
downloadUrlAndroid | string | Android下载链接 |
iosParams | string | iOS 唤醒参数 |
androidParams | string | Android 唤醒参数 |
urlSchemaIos | string | iOS URL Schema |
urlSchemaAndroid | string | Android URL Scheme |
status | string | 状态？？？ |
creatorId | string | 创建人ID |
creatorName | string | 创建人名称 |
updaterId | string | 最后更新人ID |
updaterName | string | 最后更新人名称 |
createdAt | long | 创建时间 |
updatedAt | long | 更新时间 |
body示例
{
"name": "0523信息流推广",
"productIdIos": "rREJ88PL",
"channelId": "d4PY3M9M",
"campaignIdIos": "4RzMvWd9",
"downloadUrlIos": "http://www.growingio.com"
}响应示例
{
"id": "LlPQka9p",
"linkId": "d0B4MKe",
"name": "0523信息流推广",
"projectId": "4PYJMWoM",
"productIdIos": "rREJ88PL",
"productNameIos": "RnTestiOS",
"productIdAndroid": null,
"productNameAndroid": null,
"trackingUrl": "https://datayi.cn/d0B4MKe",
"downloadUrlIos": "http://www.growingio.com",
"downloadUrlAndroid": null,
"urlSchemaIos": "80310c35a53c9a45",
"urlSchemaAndroid": null,
"campaignIdIos": "4RzMvWd9",
"campaignNameIos": "测试活动_ch",
"campaignIdAndroid": null,
"campaignNameAndroid": null,
"iosParams": null,
"androidParams": null,
"channelId": "d4PY3M9M",
"channelName": "打点",
"status": "activated",
"creatorId": "AwoVvo28",
"creatorName": "系统",
"updaterId": "AwoVvo28",
"updaterName": "系统",
"createdAt": 1566186819563,
"updatedAt": 1566186819563
}7.查询监测链接（吸引用户直接打开App）
https://www.growingio.com/api/v1/projects/project_uid/meta/deeplinks
GET
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
返回参数
字段名 | 字段格式 | 说明 |
id | String | 资源ID |
linkId | String | 监测链接ID |
name | String | 监测链接名称 |
projectId | String | 项目UID |
productIdIos | String | iOS产品ID |
productNameIos | String | iOS产品名称 |
productIdAndroid | String | Android产品ID |
productNameAndroid | String | Android产品名称 |
trackingUrl | String | 监测链接 |
downloadUrlIos | String | iOS应用下载地址 |
downloadUrlAndroid | String | Android应用下载地址 |
urlSchemaIos | String | iOS URL Scheme？？？应用的urlscheme |
urlSchemaAndroid | String | Android URL Scheme |
campaignIdIos | String | iOS广告活动ID |
campaignNameIos | String | iOS广告活动名称 |
campaignIdAndroid | String | Android广告活动ID |
campaignNameAndroid | String | Android广告活动名称 |
iosParams | String | iOS唤醒参数 |
androidParams | String | Android唤醒参数 |
channelId | String | 推广渠道ID |
channelName | String | 推广渠道名称 |
status | String | 状态 |
creatorId | String | 创建人ID |
creatorName | String | 创建人名称 |
updaterId | String | 最后更新人ID |
updaterName | String | 最后更新人名称 |
createdAt | Long | 创建时间 示例：1521642287367 |
updatedAt | Long | 更新时间 示例：1521642287367 |
响应示例
[
{
"id": "GQPDxPNm",
"linkId": "dGVr8e9",
"name": "321deeplink",
"projectId": "4PYJMWoM",
"productIdIos": "xRxVp0o5",
"productNameIos": "TestAPP",
"productIdAndroid": "LPdgKARN",
"productNameAndroid": "Android SDK Demo",
"trackingUrl": "https://datayi.cn/dGVr8e9",
"downloadUrlIos": "http://baidu.com",
"downloadUrlAndroid": "http://growingio.com",
"urlSchemaIos": "c35abef955cd913a",
"urlSchemaAndroid": "8137d31f4e7b819f",
"campaignIdIos": "j9yB1nRy",
"campaignNameIos": "321上线",
"campaignIdAndroid": "xoga4DRm",
"campaignNameAndroid": "321上线验证1",
"iosParams": null,
"androidParams": null,
"channelId": "34RzeX9V",
"channelName": "123测试编辑编辑",
"status": "activated",
"creatorId": "nRbm8d93",
"creatorName": "xx",
"updaterId": "nRbm8d93",
"updaterName": "xx",
"createdAt": 1521642287367,
"updatedAt": 1521642287367
}
]