搜索推广API

    DynamicCreativeService

    一个计划、一个单元最多有100个动态创意片段描述。

    数据类型

    DynCreativeType

    属性名类型说明限制
    dynCreativeIdLong动态创意id添加时无效
    campaignIdLong计划id-
    adgroupIdLong单元id-
    bindingTypeInteger动态创意绑定层级3:计划层级;
    5:单元层级
    titleString动态创意描述1-32个字符
    urlString默认访问url1-1017个字符
    murlString移动访问url1-1017个字符
    pauseBoolean启停状态添加时无效;True 暂停;false 启用;默认启用
    statusInteger动态创意状态添加时无效;
    91有效;
    92暂停推广;
    93不宜推广;
    94审核中;
    95部分无效;
    96有效-移动URL审核中

    ExclusionType

    ExclusionType描述了动态创意的排除对象,该类型中的属性取值范围在所有接口中均相同,但并不是所有属性在任何接口中均有意义。在具体的接口描述中会有进一步描述,说明对接口有意义的属性。

    属性名类型说明限制
    exclusionIdlong动态创意排除对象id-
    exclusionContentString动态创意排除内容1、当排除类型为URL时:以`http://`或者`https://`开头,
    不能仅为`http://`或者`https://`,不能包含@,和\t,\n,\r三个不可见字符的转义字符,
    最大1024字符,每个计划最多绑定排除URL20个。
    2、当排除类型为关键词时:1-20字符,
    不能包含\t,\n,\r三个不可见字符的转义字符,
    每个计划最多绑定排除词50个
    exclusionTypeInteger动态创意排除对象类型1:排除类型为URL;
    2:排除类型为关键词

    DynCreativeExclusionType

    DynCreativeExclusionType描述了动态创意的排除对象,该类型中的属性取值范围在所有接口中均相同,但并不是所有属性在任何接口中均有意义。在具体的接口描述中会有进一步描述,说明对接口有意义的属性。

    属性名类型说明限制
    exclusionTypesExclusionType[]排除对象数组-
    campaignIdLong推广计划id-

    接口描述

    addDynCreative

    批量不超过10000,建议分批多次请求。 添加动态创意描述,可在附属于计划层级、单元层级。

    输入信息(addDynCreativeRequest)

    属性名类型说明限制
    dynCreativeTypesDynCreativeType[]待添加动态创意必填

    返回信息(addDynCreativeResponse)

    属性名类型说明限制
    dynCreativeTypesDynCreativeType []实时数据查询结果-

    deleteDynCreative

    批量不超过10000,建议分批多次请求。

    输入信息(deleteDynCreativeRequest)

    属性名类型说明限制
    dynCreativeIdsLong[]动态创意id 必填

    返回信息(deleteDynCreativeResponse)

    属性名类型说明限制
    ---

    updateDynCreative

    批量不超过10000,建议分批多次请求。

    输入信息(updateDynCreativeRequest)

    属性名类型说明限制
    dynCreativeTypesDynCreativeType[]待修改的动态创意-

    返回信息(updateDynCreativeResponse)

    属性名类型说明限制
    dynCreativeTypesDynCreativeType[]修改后的动态创意-

    限制条件 DynCreativeType

    属性名类型说明限制
    dynCreativeIdLong动态创意id必填
    campaignedLong计划id无效字段
    adgroupIdLong单元id无效字段
    bindingTypeInteger动态创意绑定层级无效字段
    titleString动态创意描述1-32个字符 必填
    urlString默认访问url1-1017个字符 必填
    murlString移动访问url1-1017个字符 必填(传null或者不填写,表示将murl置空)
    pauseBoolean启停状态选填;True:暂停;false:开启
    statusInteger动态创意状态无效字段

    getDynCreative

    输入信息(getDynCreativeRequest)

    属性名类型说明限制
    idsLong[]待查询id集合长度:[1,100]
    idTypeIntegerId类型13:动态创意id,批量限制不超过10000;
    3:只查计划id, 批量限制不超过1000;
    5: 只查单元创意id属性;
    建议分批多词请求
    dynCreativeFieldsString[]带查询属性集合请参考表dynCreativeFields

    动态创意字段(dynCreativeFields)

    基本字段是每次必返的字段(不论用户传不传);复合字段是由多个简单属性组合的属性,用户请求会将这些简单字段打包返回;其余字段为简单字段,用户请求则返回。

    字段名说明字段类型
    dynCreativeId动态创意id基本字段
    campaignId推广计划id基本字段
    adgroupId推广单元id基本字段
    bindingType动态创意绑定层级-
    title动态创意描述-
    url默认访问url-
    murl移动访问url-
    status动态创意状态-
    pause启停状态-

    返回信息(getDynCreativeResponse)

    属性名类型说明限制
    dynCreativeTypesDynCreativeType[]--

    getExclusionTypeByCampaignId

    根据指定推广计划id获取推广计划下所有排除对象(id可批量)。

    输入信息(getExclusionTypeByCampaignIdRequest)

    属性名类型说明限制
    campaignIdslong[]指定计划的ID数组必填

    返回信息(getExclusionTypeByCampaignIdResponse)

    属性名类型说明
    dynCreativeExclusionTypesDynCreativeExclusionType[]按请求顺序返回计划下的动态创意排除对象

    addExclusionType

    添加动态创意排除对象,支持批量,每个计划最多绑定排除URL20个,绑定排除词50个,每次最多操作100个计划。(重复的排除对象不会被添加。添加以计划为单位,每个计划下排除对象要么全添加成功,要么全添加失败。)

    输入信息(addExclutionTypeRequest)

    属性名类型说明限制
    dynCreativeExclusionTypesDynCreativeExclusionType[]批量增加推广计划的动态创意排除对象参见下表

    属性限制

    DynCreativeExclusionType属性限制如下:

    属性名限制
    campaignId必填
    exclusionTypes[]必填,见下表

    ExclusionType属性限制如下:

    属性名限制
    exclusionId无效
    exclusionContent必填,每批请求只能添加同一类排除对象,以排除对象数组第一个排除对象类型为准。
    当排除类型为URL时:以`http://`或者`https://`开头,不能仅为`http://`或者`https://`,
    不能包含@和\n,\r,\t三个不可见字符的转义字符,最大1024字符,每个计划最多绑定排除URL20个。
    当排除类型为关键词时:1-20字符,不能包含\n,\r,\t不可见字符的转义字符,
    每个计划最多绑定排除词50个
    exclusionType必填,(1:排除url,2:排除词)

    返回信息(addExclusionTypeResponse)

    属性名类型说明
    dynCreativeExclusionTypesDynCreativeExclusionType[]新增动态创意排除对象数组

    delExclusionType

    按计划id及动态创意排除对象id删除动态创意排除对象。

    输入信息(delExclusionTypeRequest)

    属性名类型说明限制
    dynCreativeExclusionTypesDynCreativeExclusionType[]批量删除推广计划的动态创意排除对象参见下表

    DynCreativeExclusionType属性限制如下:

    属性名限制
    campaignId必填
    exclusionTypes[]必填,见下表

    ExclusionType属性限制如下:

    属性名限制
    exclusionId必填
    exclusionContent无效
    exclusionType无效

    返回信息(delExclusionTypeResponse)

    属性名类型说明限制
    optResultInteger删除结果1:全部成功;
    2:全部失败;
    3:部分成功,部分失败;
    说明:操作部分错误时会抛出错误代码,具体错误代码待定
    上一篇
    KRService
    下一篇
    SearchService