推广计划模块

推广计划对象

字段名称 类型 描述
campaignFeedId number 计划ID
campaignFeedName number 计划名称
subject number 推广对象。
取值范围如下:
1:网站链接
2:APP(IOS)
3:APP(Andriod)
appinfo object 推广app信息。subject=1时,该字段无效。对象定义参考推广app信息
budget numer 推广计划预算。
默认为0,表示不限预算。
正常取值范围为[100 - 9999999.99]
starttime string 推广开始日期。
默认为null,表示长期投放。
格式示例:'2016-12-15'
不能早于当天的日期
endtime string 推广结束日期。
默认为null,表示长期投放。
例如:'2016-12-18'
不能早于开始日期
schedule array(object) 暂停时段设置,对象定义参考暂停时段设置
bgtctltype number 预算分配控制方式。默认为标准方式
取值范围如下:
0:匀速。根据流量波动,让预算在整个投放日程中较为平稳的消耗。
1:标准。尽快将广告投放出去,预算可能会在短时间内消耗完
2:加速。尽可能获得更多展现,对比标准投放预算消耗更快
pause number 是否暂停推广。默认为false
true:推广计划暂停
false:推广计划启用
status number 推广计划状态。
此字段仅用于查询接口响应结果。
0:有效
1:处于暂停时段
2:暂停推广
3:推广计划预算不足
4:账户待激活
11:账户预算不足
20:账户余额为零
23:被禁推
24:app已下线
bstype number bstype
1:普通计划
3:闪投计划
注:不支持修改

暂停时段设置

字段名称 类型 描述
weekDay number 推广暂停日。
取值范围如下:
1:星期一
2:星期二
3:星期三
4:星期四
5:星期五
6:星期六
7:星期日
startHour number 推广暂停时段开始时间,以小时为单位,取值范围:[0,23]
endHour number 推广暂停时段结束时间,以小时为单位,取值范围:[1,24]

推广app信息

字段名称 类型 描述
appName string 应用名称,最多20个字符。
apkName string 应用包名,仅Android有效,最多1024个字符
appUrl string 推广应用链接。
如果是IOS app,链接必须为iTunes链接。
联盟媒体流量仅支持以.apk为结尾的下载链接
docId number app docid。请登录开发者中心查看推广APP对应Docid信息

查询过滤条件

字段名称 类型 描述
bstype array(number) 计划类型,目前支持:1-普通计划,3-闪投计划,不填返回全部

查询推广计划

接口描述

查询推广计划信息。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CampaignFeedService/getCampaignFeed

请求参数说明

字段名称 类型 描述
campaignFeedFields array(string) 需要查询的计划属性,属性名称与推广计划对象的字段定义一致。
campaignFeedIds array(number) 需要查询的计划id数组,最多填100个计划id。
如果数组为空,会返回账户内的所有计划
campaignFeedFilter object 要查询的计划的过滤条件,参看:查询过滤条件

响应参数说明

响应内容为推广计划对象数组,请参考其定义。

请求示例

POST /v1/feed/cloud/CampaignFeedService/getCampaignFeed 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": {
        "campaignFeedIds": [
            "96848458"
        ],
        "campaignFeedFields": [
            "campaignFeedName",
            "campaignFeedId",
            "subject",
            "budget",
            "bgtctltype",
            "pause",
            "starttime",
            "endtime",
            "status"
        ],
        "campaignFeedFilter":{"bstype":[1,3]}
    }
}

响应示例

{
    "body": {
        "data": [
            {
                "pause": false,
                "budget": 0,
                "campaignFeedName": "Plan1",
                "starttime": "Nov 29, 2018 12:00:00 AM",
                "endtime": "Nov 30, 2018 12:00:00 AM",
                "status": 20,
                "subject": 1,
                "campaignFeedId": 96848458,
                "bgtctltype": 1
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

新增推广计划

接口描述

新增推广计划。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CampaignFeedService/addCampaignFeed

请求参数说明

字段名称 类型 描述
campaignFeedTypes array(object) 推广计划对象数组,请参考其定义。

响应参数说明

响应为推广计划对象数组,请参考其定义。

响应结果中会包含新增成功的计划ID信息。

请求示例

POST /v1/feed/cloud/CampaignFeedService/addCampaignFeed 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": {
        "campaignFeedTypes": [
            {
                "campaignFeedName": "Plan1",
                "subject": 2,
                "appinfo": {
                    "appName": "百度贴吧",
                    "appUrl": "https://itunes.apple.com/cn/app/1234567"
                },
                "pause": false,
                "budget": 0,
                "starttime": "2018-12-30",
                "endtime": "2019-01-30",
                "schedule": [
                    {
                        "weekDay": 1,
                        "startHour": 0,
                        "endHour": 9
                    },
                    {
                        "weekDay": 2,
                        "startHour": 0,
                        "endHour": 9
                    },
                    {
                        "weekDay": 3,
                        "startHour": 0,
                        "endHour": 9
                    },
                    {
                        "weekDay": 4,
                        "startHour": 0,
                        "endHour": 9
                    },
                    {
                        "weekDay": 5,
                        "startHour": 0,
                        "endHour": 9
                    },
                    {
                        "weekDay": 6,
                        "startHour": 0,
                        "endHour": 9
                    },
                    {
                        "weekDay": 7,
                        "startHour": 0,
                        "endHour": 9
                    }
                ],
                "bgtctltype": 1,
                "bstype": 1
            }
        ]
    }
}

响应示例

{
  "body": {
    "data": [
      {
        "campaignFeedId": 1234567,
        "campaignFeedName": "Plan1",
        "subject": 2,
        "appinfo": {
          "appName": "百度贴吧",
          "appUrl": "https://itunes.apple.com/cn/app/1234567"
        },
        "pause": false,
        "status": 0,
        "budget": 0,
        "schedule": [
          {
            "weekDay": 1,
            "startHour": 0,
            "endHour": 9
          },
          {
            "weekDay": 2,
            "startHour": 0,
            "endHour": 9
          },
          {
            "weekDay": 3,
            "startHour": 0,
            "endHour": 9
          },
          {
            "weekDay": 4,
            "startHour": 0,
            "endHour": 9
          },
          {
            "weekDay": 5,
            "startHour": 0,
            "endHour": 9
          },
          {
            "weekDay": 6,
            "startHour": 0,
            "endHour": 9
          },
          {
            "weekDay": 7,
            "startHour": 0,
            "endHour": 9
          }
        ],
        "bgtctltype": 1
      }
    ]
  },
  "header": {
    "oprs": 1,
    "failures": [],
    "succ": 1,
    "oprtime": 0,
    "desc": "success",
    "status": 0
  }
}

更新推广计划

接口描述

更新推广计划信息。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CampaignFeedService/updateCampaignFeed

请求参数说明

字段名称 类型 描述
campaignFeedTypes array(object) 推广计划对象数组,请参考其定义。

注意:请求参数中的计划ID为必填信息。**

响应参数说明

响应为推广计划对象数组,请参考其定义。

请求示例

POST /v1/feed/cloud/CampaignFeedService/updateCampaignFeed 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": {
        "campaignFeedTypes": [
            {
                "campaignFeedId": 1234567,
                "campaignFeedName": "新的计划名称",
                "subject": 2,
                "appinfo": {
                    "appName": "新的应用名称",
                    "appUrl": "https://itunes.apple.com/cn/app/1234567"
                },
                "pause": true,
                "budget": 300.33,
                "schedule": [
                    {
                        "weekDay": 1,
                        "startHour": 0,
                        "endHour": 9
                    }
                ],
                "bgtctltype": 2
            }
        ]
    }
}

响应示例

{
  "body": {
    "data": [
      {
        "campaignFeedId": 1234567,
        "campaignFeedName": "新的计划名称",
        "subject": 2,
        "appinfo": {
          "appName": "新的应用名称",
          "appUrl": "https://itunes.apple.com/cn/app/1234567"
        },
        "pause": true,
        "status": 2,
        "budget": 300.33,
        "schedule": [
          {
            "weekDay": 1,
            "startHour": 0,
            "endHour": 9
          }
        ],
        "bgtctltype": 2
      }
    ]
  },
  "header": {
    "oprs": 1,
    "failures": [],
    "succ": 1,
    "oprtime": 0,
    "desc": "success",
    "status": 0
  }
}

删除推广计划

接口描述

删除推广计划。删除推广计划会同时删除计划下的推广单元、创意等从属信息。

注意:删除后不可恢复,请谨慎操作。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CampaignFeedService/deleteCampaignFeed

请求参数说明

字段名称 类型 描述
campaignFeedTypes array(object) 需要删除的计划ID。一次最多删除100个计划。

响应参数说明

响应为推广计划对象数组,但是仅包含被删除的计划ID信息。

请求示例

POST /v1/feed/cloud/CampaignFeedService/deleteCampaignFeed 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": {
        "campaignFeedIds": [
            11111,
            2222,
            3333
        ]
    }
}

响应示例

{
  "body": {
    "data": [
      {
        "campaignFeedId": 1111
      },
      {
        "campaignFeedId": 2222
      },
      {
        "campaignFeedId": 3333
      }
    ]
  },
  "header": {
    "oprs": 1,
    "failures": [],
    "succ": 1,
    "oprtime": 0,
    "desc": "success",
    "status": 0
  }
}