定向包接口
更新时间:2020-07-15
查询定向包
接口描述
查询定向包信息。
接口URL
http://sem.baidubce.com/v1/feed/cloud/AtpFeedService/getAtpFeed
请求参数说明
字段名称 | 类型 | 描述 |
---|---|---|
atpFeedFields | array(string) | 需要查询的定向包属性,属性名称即定向包对象和定向设置列表的字段名称。 注意:查询定向设置时,不应传"audience",而是传定向设置列表中需要的字段名称。某些定向信息内容可能较长(如意图词),请按照实际需要查询,以提高响应速度。 |
ids | array(number) | 需要查询的定向包ID数组,最多填100个ID。 如果不填,则查询该账户下所有的定向包。 |
key | string | 定向包名字查询关键字。 在ids字段查询的基础上返回定向包名字包括此字段的定向包信息 |
响应参数说明
响应内容为定向包对象数组,请参考其定义。
请求示例
POST /v1/feed/cloud/AtpFeedService/getAtpFeed HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
"header": {
"opUsername": "example",
"tgUsername": "example",
"bceUser": "example",
"opPassword": "example",
"tgPassword": "example"
},
"body": {
"ids": [3739688195],
"key": "定向包",
"atpFeedFields": [
"atpFeedId",
"atpFeedName",
"atpFeedDesc",
"subject",
"age",
"sex"
]
}
}
响应示例
{
"body": {
"data": [
{
"atpFeedId": 3739688195,
"atpFeedName": "atpFeedName",
"subject": 1,
"audience":{
"age": "1,2",
"sex": "1"
}
}
]
},
"header": {
"oprs": 1,
"failures": [],
"succ": 1,
"oprtime": 0,
"desc": "success",
"status": 0
}
}
新增定向包
接口描述
新增定向包。(说明:一个账户下最多有100个定向包)
接口URL
http://sem.baidubce.com/v1/feed/cloud/AtpFeedService/addAtpFeed
请求参数说明
字段名称 | 类型 | 描述 |
---|---|---|
atpFeedTypes | array(object) | 定向包对象数组,请参考其定义。 |
响应参数说明
响应为定向包对象数组,请参考其定义。
响应结果中会包含新增成功的定向包ID信息。
请求示例
POST /v1/feed/cloud/AtpFeedService/addAtpFeed HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
"header": {
"opUsername": "example",
"tgUsername": "example",
"bceUser": "example",
"opPassword": "example",
"tgPassword": "example"
},
"body": {
"atpFeedTypes": [
{
"atpFeedName": "定向包",
"atpFeedDesc": "这是个定向包",
"ftypes": [],
"subject": 1,
"audience":{
"age": "1,2",
"sex": "1"
}
}
]
}
}
响应示例
{
"body": {
"data": [
{
"atpFeedId": 3739688195,
"atpFeedName": "定向包",
"atpFeedDesc": "这是个定向包",
"ftypes": [],
"subject": 1,
"audience":{
"age": "1,2",
"sex": "1"
}
}
]
},
"header": {
"oprs": 1,
"failures": [],
"succ": 1,
"oprtime": 0,
"desc": "success",
"status": 0
}
}
更新定向包
接口描述
更新定向包信息。
接口URL
http://sem.baidubce.com/v1/feed/cloud/AtpFeedService/updateAtpFeed
请求参数说明
字段名称 | 类型 | 描述 |
---|---|---|
atpFeedTypes | array(object) | 定向包对象数组,请参考其定义。 |
注意:请求参数中的定向包ID为必填信息。
响应参数说明
响应为定向包对象数组,请参考其定义。
请求示例
POST /v1/feed/cloud/AtpFeedService/updateAtpFeed HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
"header": {
"opUsername": "example",
"tgUsername": "example",
"bceUser": "example",
"opPassword": "example",
"tgPassword": "example"
},
"body": {
"atpFeedTypes": [
{
"atpFeedId": 3739688195,
"atpFeedName": "修改定向包",
"atpFeedDesc": "修改了定向包",
"audience":{
"age": "1"
}
}
]
}
}
响应示例
{
"body": {
"data": [
{
"atpFeedId": 3739688195,
"atpFeedName": "修改定向包",
"atpFeedDesc": "修改了定向包",
"audience":{
"age": "1"
}
}
]
},
"header": {
"oprs": 1,
"failures": [],
"succ": 1,
"oprtime": 0,
"desc": "success",
"status": 0
}
}
删除定向包
接口描述
删除定向包。
注意:删除后不可恢复,请谨慎操作。
接口URL
http://sem.baidubce.com/v1/feed/cloud/AtpFeedService/deleteAtpFeed
请求参数说明
字段名称 | 类型 | 描述 |
---|---|---|
atpFeedIds | array(number) | 需要删除的定向包ID。一次最多删除100个定向包。 |
响应参数说明
响应为定向包对象数组,但是仅包含被删除的定向包ID信息。
请求示例
POST /v1/feed/cloud/AtpFeedService/deleteAtpFeed HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
"header": {
"opUsername": "example",
"tgUsername": "example",
"bceUser": "example",
"opPassword": "example",
"tgPassword": "example"
},
"body": {
"atpFeedIds": [
3739688195,
3739688196,
3739688197
]
}
}
响应示例
{
"body": {
"data": [
{
"atpFeedId": 3739688195
},
{
"atpFeedId": 3739688196
},
{
"atpFeedId": 3739688197
}
]
},
"header": {
"oprs": 1,
"failures": [],
"succ": 1,
"oprtime": 0,
"desc": "success",
"status": 0
}
}
定向包绑定单元
接口描述
定向包绑定单元。
注意:被绑定的单元定向会被定向包的定向完全覆盖,请谨慎操作。
接口URL
http://sem.baidubce.com/v1/feed/cloud/AtpFeedService/bindAtpFeed
请求参数说明
字段名称 | 类型 | 描述 |
---|---|---|
atpBindFeedTypes | array(object) | 定向包绑定对象数组,请参考其定义。 |
响应参数说明
响应为定向包绑定对象数组,仅返回绑定成功的单元ID。
请求示例
POST /v1/feed/cloud/AdgroupFeedService/bindAtpFeed HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
"header": {
"opUsername": "example",
"tgUsername": "example",
"bceUser": "example",
"opPassword": "example",
"tgPassword": "example"
},
"body": {
"atpBindFeedTypes": [
{
"atpFeedId": 3739688195,
"adgroupFeedIds": [3739688196,3739688197]
}
]
}
}
响应示例
{
"body": {
"data": [
{
"atpFeedId": 3739688195,
"adgroupFeedIds": [3739688196,3739688197]
}
]
},
"header": {
"oprs": 1,
"failures": [],
"succ": 1,
"oprtime": 0,
"desc": "success",
"status": 0
}
}