创意模块接口

创意对象

创意对象定义了推广单元的所有属性,创意模块的多个接口均引用了其定义,请参考各接口的说明使用。

字段名称 类型 描述
creativeFeedId number 创意ID
adgroupFeedId number 所属推广单元ID
creativeFeedName string 创意名称
materialstyle number 创意样式ID,取值请参考创意样式列表
pause boolean 是否暂停推广
status number 创意状态。
此字段仅用于查询,新增/修改创意时参数中传此字段无效。
取值范围如下:
0:有效
1:暂停推广
2:审核中
3:审核未通过
4:无效(因与所属推广单元所选的投放版位不匹配而无法投放,推广单元修改投放版位后将自动重置此状态。请参考创意样式列表的说明。)
material string 物料内容。
物料内容为string形式的json对象,包含该创意所需的标题、图片、落地页URL等展示物料,以及监测URL等功能性物料。各种创意样式所需的物料字段有所不同,请参考创意物料说明创意样式列表
refusereason string 审核未通过的原因(审核拒绝理由)。原因可能有多个,该字段为string形式的json数组,数组元素为string类型,每个元素是一个原因。
示例:
"[\"原因A\",\"原因B\"]"
ideaType number 返回的创意类型,取值0代表自定义创意 1代表程序化创意

查询创意

接口描述

查询创意信息

接口URL

http://sem.baidubce.com/v1/feed/cloud/CreativeFeedService/getCreativeFeed

请求参数说明

字段名称 类型 描述
creativeFeedFields array(string) 需要查询的创意属性。属性名称即创意对象的字段名称。
idType number 查询条件ids字段的类型,1表示计划ID,2表示单元ID,3表示创意ID。
ids array(number) 需要查询的计划ID/单元ID/创意ID数组,最多填100个ID。
creativeFeedFilter object 查询创意的筛选条件,定义见下。

查询创意的筛选条件(creativeFeedFilter字段)用于更精细地筛选查询的创意。目前仅支持按照创意状态筛选。字段如下:

字段名称 类型 描述
status array(number) 需要筛选的创意状态。取值请参考创意对象的status字段说明。

响应参数说明

响应内容为创意对象数组,请参考其定义。

请求示例

POST /v1/feed/cloud/CreativeFeedService/getCreativeFeed 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": {
        "idType": 3,
        "ids": [
            "54320498743"
        ],
        "creativeFeedFields": [
            "creativeFeedId",
            "creativeFeedName",
            "materialstyle",
            "material"
            "ideaType":0
        ]
    }
}

响应示例

{
    "body": {
        "data": [
            {
                "creativeFeedId": 54320498743,
                "creativeFeedName": "Creative1",
                "materialstyle": 101,
                "material": "{\"title\":\"使用信息流推广,获得好效果!\",\"brand\":\"百度\",\"url\":\"https://www.baidu.com/\",\"userPortrait\":\"http://example.com/example.jpg\",\"pictures\":[{\"image\":\"http://example.com/example.jpg\"}]}"
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

新增创意

接口描述

新增创意

接口URL

http://sem.baidubce.com/v1/feed/cloud/CreativeFeedService/addCreativeFeed

请求参数说明

字段名称 类型 描述
creativeFeedTypes array(object) 创意对象数组,请参考其定义。

响应参数说明

响应为创意对象数组,请参考其定义。

响应结果中的创意对象与请求参数中一一对应(其中失败的不会包含在data中,但会在error中提供错误信息),且会包含新增成功的创意ID信息。

请求示例

POST /v1/feed/cloud/CreativeFeedService/addCreativeFeed 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": {
        "creativeFeedTypes": [
            {
                "adgroupFeedId": 3739688195,
                "creativeFeedName": "Creative1",
                "materialstyle": 101,
                "material": "{\"title\":\"使用信息流推广,获得好效果!\",\"brand\":\"百度\",\"url\":\"https://www.baidu.com/\",\"userPortrait\":\"http://example.com/example.jpg\",\"pictures\":[{\"image\":\"http://example.com/example.jpg\"}]}"
            }
        ]
    }
}

响应示例

{
    "body": {
        "data": [
            {
                "creativeFeedId": 54320498743,
                "adgroupFeedId": 3739688195,
                "creativeFeedName": "Creative1",
                "materialstyle": 101,
                "material": "{\"title\":\"使用信息流推广,获得好效果!\",\"brand\":\"百度\",\"url\":\"https://www.baidu.com/\",\"userPortrait\":\"http://example.com/example.jpg\",\"pictures\":[{\"image\":\"http://example.com/example.jpg\"}]}"
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

更新创意

接口描述

更新创意信息

接口URL

http://sem.baidubce.com/v1/feed/cloud/CreativeFeedService/updateCreativeFeed

请求参数说明

字段名称 类型 描述
creativeFeedTypes array(object) 创意对象数组,请参考其定义。

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

响应参数说明

响应为创意对象数组,请参考其定义。

请求示例

POST /v1/feed/cloud/CreativeFeedService/updateCreativeFeed 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": {
        "creativeFeedTypes": [
            {
                "creativeFeedId": 54320498743,
                "adgroupFeedId": 3739688195,
                "creativeFeedName": "Creative1",
                "materialstyle": 101,
                "material": "{\"title\":\"使用信息流推广,获得好效果!\",\"brand\":\"百度\",\"url\":\"https://www.baidu.com/\",\"userPortrait\":\"http://example.com/example.jpg\",\"pictures\":[{\"image\":\"http://example.com/example.jpg\"}]}"
            }
        ]
    }
}

响应示例

{
    "body": {
        "data": [
            {
                "creativeFeedId": 54320498743,
                "adgroupFeedId": 3739688195,
                "creativeFeedName": "Creative1",
                "materialstyle": 101,
                "material": "{\"title\":\"使用信息流推广,获得好效果!\",\"brand\":\"百度\",\"url\":\"https://www.baidu.com/\",\"userPortrait\":\"http://example.com/example.jpg\",\"pictures\":[{\"image\":\"http://example.com/example.jpg\"}]}"
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

删除创意

接口描述

删除创意。

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

接口URL

http://sem.baidubce.com/v1/feed/cloud/CreativeFeedService/deleteCreativeFeed

请求参数说明

字段名称 类型 描述
creativeFeedIds array(number) 需要删除的创意ID。一次最多删除100个创意。

响应参数说明

响应为创意对象数组,但是仅包含被删除的创意ID信息。

请求示例

POST /v1/feed/cloud/CreativeFeedService/deleteCreativeFeed 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": {
        "creativeFeedIds": [
            54320498743,
            54320498744,
            54320498745
        ]
    }
}

响应示例

{
    "body": {
        "data": [
            {
                "creativeFeedId": 54320498743
            },
            {
                "creativeFeedId": 54320498744
            },
            {
                "creativeFeedId": 54320498745
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

根据物料内容生成实况预览地址

接口描述

根据指定的物料内容生成实况预览URL。物料内容即使还没有在创意中提交,也可利用此接口生成预览地址。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CreativeFeedService/getTempCreativeFeedPreviewUrl

请求参数说明

字段名称 类型 描述
previewFeedTypes array(Object) 预览对象数组(定义见下),目前只支持1个,即数组长度为1。

预览对象包含了预览所需的信息:

字段名称 类型 描述
materialstyle number 预览的样式ID
creativeFeedName string 预览物料的创意名称(无实际作用,调用时可任意填写)
previewSource string 预览来源,请填写"other"
material string 预览物料的内容,与创意对象的material字段定义相同

响应参数说明

字段名称 类型 描述
qr string 预览二维码URL地址

请求示例

POST /v1/feed/cloud/CreativeFeedService/getTempCreativeFeedPreviewUrl 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":{
        "previewFeedTypes":[
            {
                "materialstyle":101,
                "creativeFeedName":"creative_20126046113",
                "previewSource":"other",
                "material":"{\"title\":\"使用信息流推广,获得好效果!\",\"brand\":\"百度\",\"url\":\"https://www.baidu.com/\",\"userPortrait\":\"http://example.com/example.jpg\",\"pictures\":[{\"image\":\"http://example.com/example.jpg\"}]}"
            }
        ]
    }
}

响应示例

{
    "header":{
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    },
    "body":{
        "data":[
            {
                "qr": "http://bj.bcebos.com/fc-feed/preview/img/926000f96eb2bf7c.png"
            }
        ]
    }
}

生成创意的实况预览地址

接口描述

根据创意ID生成实况预览URL。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CreativeFeedService/getCreativeFeedPreviewUrlWithPreviewSource

请求参数说明

字段名称 类型 描述
previewFeedRequest array(Object) 预览对象数组(定义见下),目前只支持1个,即数组长度为1。

预览对象包含了预览所需的信息:

字段名称 类型 描述
creativeFeedId Integer 创意ID
previewSource String 预览来源,请填写"other"

响应参数说明

字段名称 类型 描述
qr string 预览二维码URL地址

请求示例

POST /v1/feed/cloud/CreativeFeedService/getCreativeFeedPreviewUrlWithPreviewSource 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":{
        "previewFeedRequest":{
            "creativeFeedId": 54320498743,
            "previewSource": "other",
        }
    }
}

响应示例

{
    "header":{
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    },
&nbs