vivo广告推广平台：服务端API接口文档《NO.7》

当前位置：首页 > 推广案例

推广案例

vivo广告推广平台：服务端API接口文档《NO.7》

发布时间：2021-09-15浏览次数：92

5.标签管理

5.1 新增标签接口

接口说明

为应用方增加标签，用于后续标签推送。

访问方式

URL

编码方式

协议

method

Content-Type

/tag/add

Utf-8

https

POST

application/json

Curl e.g.：

curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tag/add

Request body e.g.:

{

"name": "shenzhen",

"desc":"深圳用户标签",

"group":"city"

}

Response body e.g.:

http status 200:

{

"result": 0,

"desc": "成功",

}

业务异常：

{

"result": xxx,

"desc": "xxx"

}

http status 500：

Internet server error!

接口定义

输入参数：

属性名字	类型	是否必填Y/N	描述
name	string	Y	标签名称
desc	string	N	标签描述
group	string	N	标签分类名

输出参数：

属性名字	类型	描述
result	int	接口调用是否成功的状态码 0成功，非0失败
desc	string	文字描述接口调用情况

5.2 更新单个标签接口

接口说明

更新一个标签的信息,更新标签名字、描述、所属分类。

访问方式

URL

编码方式

协议

method

Content-Type

/tag/update

Utf-8

https

POST

application/json

Curl e.g.：

curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tag/update

Request body e.g.:

{

"oldName":"shenzhen",

"newName":"shenzhenbaoan"

}

Response body e.g.:

http status 200:

{

"result": 0,

"desc": "成功"

}

业务异常：

{

"result": xxx,

"desc": "xxx"

}

http status 500：

Internet server error!

接口定义

输入参数：

属性名字	类型	是否必填Y/N	描述
oldName	string	Y	旧标签名称
newName	string	Y	新标签名称
desc	string	N	更新标签描述
group	string	N	更新标签所属分类

输出参数：

属性名字	类型	描述
result	int	接口调用是否成功的状态码 0成功，非0失败
desc	string	文字描述接口调用情况

5.3 给标签添加用户设备接口

接口说明

给标签添加用户设备信息，单次不超过1000个设备。

访问方式

URL

编码方式

协议

method

Content-Type

/tag/addMembers

Utf-8

https

POST

application/json

Curl e.g.：

curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tag/addMembers

Request body e.g.:

{

"name":"shenzhen",

"type":1,

"ids":["15549635570031000000216","15549635980031000001086"]

}

Response body e.g.:

http status 200:

{

"result": 0,

"desc": "success",

"data": [

{

"status": 1,

"userid": "00000000000000000000004"

{

"status": 1,

"userid": "00000000000000000000005"

}

]

}

业务异常：

{

"result": xxx,

"desc": "xxx"

}

http status 500：

Internet server error!

接口定义

输入参数：

属性名字	类型	是否必填Y/N	描述
name	string	Y	标签名字
type	int	Y	用户类型：1是regId ,2是别名
ids	JSON Array	Y	用户id

输出参数：

属性名字	类型	描述
result	int	接口调用是否成功的状态码 0成功，非0失败
desc	string	文字描述接口调用情况
data	JSON Array	userid是非法用户id，status有3种状态：1是用户不存在，2是用户push开关关闭，3是用户14天未联网。

5.4 移除标签中的用户设备接口

接口说明

移除标签中的用户设备信息，单次不超过1000个设备。

访问方式

URL

编码方式

协议

method

Content-Type

/tag/removeMembers

Utf-8

https

POST

application/json

Curl e.g.：

curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tag/removeMembers

Request body e.g.:

{

"name":"shenzhen",

"type":1,

"ids":["15554239157791000000009","15554239157791000000008"]

}

Response body e.g.:

http status 200:

{

"result": 0,

"desc": "success",

"data": [

{

"status": 1,

"userid": "15554239157791000000008"

{

"status": 1,

"userid": "15554239157791000000009"

}

]

}

业务异常：

{

"result": xxx,

"desc": "xxx"

}

http status 500：

Internet server error!

接口定义

输入参数：

属性名字	类型	是否必填Y/N	描述
name	string	Y	标签名字
type	int	Y	用户类型：1是regId ,2是别名
ids	JSON Array	Y	用户id

输出参数：

属性名字	类型	描述
result	int	接口调用是否成功的状态码 0成功，非0失败
desc	string	文字描述接口调用情况
data	JSON Array	userid是非法用户id，status有3种状态：1是用户不存在，2是用户push开关关闭，3是用户14天未联网。