搜索推广API

    AccountService

    数据类型

    AccountInfoType

    请求参数:

    参数名称 类型 说明 限制
    userId Long 账户ID -
    balance Double 推广共享包金额 账户剩余金额减去信用卡透支金额
    (但目前不会提供小于0的数,即使小于0也会返回0)
    pcBalance Double 基准资金包金额 计算机余额
    mobileBalance Double 无线优惠资金包金额 移动余额
    cost Double 账户累积消费 注:如果使用了全能账户(开通全能账户后,
    用户名下的所有账户将会共享余额,
    每个账户的显示的余额为所有账户余额的和,
    cost的计算公式是:
    总消费=总现金+总优惠+总补偿+总转入资金-余额,
    余额变大导致cost可能为负。),此处余额可能为负
    payment Double 账户投资 -
    budgetType Integer 账户预算类型 0为不设置预算;
    1为日预算;
    2为周预算;
    budget Double 账户预算 当设置为日预算时,取值范围:
    [50, 10000000];
    当设置为周预算时,取值范围:[388, 70000000];
    当不设置预算时,输入任意值均默认为0;
    regionTarget Integer[] 推广地域列表 可选地域名称见地域编码。数组元素个数最大值:无
    excludeIp String[] ip排除列表 每个元素是合法的ipV4地址,其中最多可以包括
    3个高级IP地址(后两位为)和200个普通IP地址
    (后1位为
    或者没有*)。
    数组元素个数最大值:203
    openDomains String[] 账户开放域名列表(开放域名是在已有注册域名的基础上
    ,再添加用户可以推广的域名,系统默认用户只能推广注册域名,
    物料URL需要和注册域名及开放域名的主域一致即可)
    -
    regDomain string 账户注册域名 -
    budgetOfflineTime OfflineTimeType[] 到达预算下线时段 数组元素个数限制:
    最近有过下线时段的7个自然日的下线和
    上线时段(这7个自然日中若某日期距当前已超过30天,则不返回)
    null : 无到达预算下线时段;
    注:时间为date类型,格式示例”Jul 10, 2015 11:00:00 AM”
    weeklyBudget Double[] 返回本周的每日预算值 如设置为周预算时,该接口显示
    的是实际分配到每一天的日预算
    userStat Integer 账户状态(用于一站式平台显示账户状态) null: 未设置获取该属性
    1: 开户金未到
    2: 正常生效
    3: 余额为零
    4: 未通过审核
    6: 审核中
    7: 被禁用
    11: 预算不足
    isDynamicCreative Boolean 子链开关 True:开启
    False:关闭
    (默认开启)
    isDynamicTagSublink Boolean 标签子链开关 True:开启
    False:关闭
    (默认开启)
    isDynamicTitle Boolean 动态标题开关 True:开启
    False:关闭
    (默认开启)
    isDynamicHotRedirect Boolean 热点直达开关 True:开启
    False:关闭
    (默认开启)
    dynamicCreativeParam String 动态创意统计参数 以”?”或者”#”开头,长度不超过256字节
    userLevel Integer 客户权益等级查询接口,如果用户通过此接口请求了客户权益等级,返回结果中会有对应userLevel字段标识客户权益等级。其中,1 – 三徽章客户;2 – 二徽章客户;3 – 一徽章客户;4 – 未生效客户。有关客户权益的介绍,请参考客户平台权益 不请求该字段则不返回

    OfflineTimeType

    该数据对象定义了账户的到达预算下线时间段。

    参数名称 类型 说明 限制
    flag Int 标识改时间点是发生了上线还是下线 1 - 上线
    0 - 下线
    time dateTime 下线/上线时间点 -

    接口描述

    getAccountInfo

    获取username对应的账户信息 ;如果是来自MCC Token的请求,则返回target对应的账户信息。

    Json示意

    {
    "accountFields":["userId","cost","balance","excludeIp","regionTarget","dynamicCreativeParam","isDynamicCreative",…]
    }

    输入信息(getAccountInfoRequest)

    参数名称 类型 说明 限制
    accountFields string[] 指定需要返回的属性 取值范围:请参考表AccountFields。
    Userid默认返回。
    不请求的属性,没有返回值。
    账户设置为日预算,请求weeklyBudget无返回值。
    账户设置为周预算,请求weeklyBudget,预算相关属性均有返回值。

    账户字段(AccountFields)

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

    参数名称 说明 限制
    userId 用户id 基本字段
    balance 推广共享包金额 -
    pcBalance 基准资金包金额 -
    mobileBalance 无线优惠资金包金额 -
    budget 预算(消费限额) -
    budgetType 预算类型 -
    budgetOfflineTime 账户最近下线时间 -
    cost 消费总额 -
    dynamicCreativeParam 动态创意统计参数 -
    excludeIp IP排除列表 -
    isDynamicCreative 子链开关 -
    isDynamicTagSublink 标签子链开关 -
    isDynamicTitle 动态标题开关 -
    isDynamicHotRedirect 热点直达开关 -
    openDomains 开放域名 -
    payment 投资总额 -
    regDomain 网站域名 -
    regionTarget 推广地域 -
    userStat 用户状态 -
    weeklyBudget 周预算 -

    返回信息(getAccountInfoResponse)

    参数名称 类型 说明 限制
    accountInfoType AccountInfoType 按照要求返回字段 -

    代码示例

    • 请求

    获取帐户的全部属性:

    {
    "header":{
    	"opUsername":"searchlab",   			//mcc操作员账户名称
        "opPassword":"*********"        		//mcc操作员账户密码
        "tgUsername":"searchlab", 
        "tgSubname":"searchlab",				//mcc被操作的账户
        "bceUser":"014df051fa131234a2a*****" 	//mcc类型的bceuser
    },
    "body":{
    	"accountFields":["userId","balance","cost","payment","budgetType","budget","regionTarget","excludeIp","openDomains","regDomain","budgetOfflineTime","weeklyBudget","userStat","isDynamicCreative","dynamicCreativeParam","pcBalance"," mobileBalance"]
    }
    }
    • 返回

      { "header": { "desc": "success", "failures": [], "oprs": 1, "succ": 1, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { "data": [ { "isDynamicCreative": false, "budget": 0, "regionTarget": [ 1000, 300000 ], "budgetOfflineTime": [], "payment": 0, "openDomains": [ "baidu.com", "china356.com" ], "excludeIp": [ "2.2.2.2", "3.3.3.3", "3.5.6.7", "4.4.4.5", "5.5.6.6" ], "regDomain": "china356.com", "userStat": 3, "cost": 10000, "balance": 0, "pcBalance": 0, "mobileBalance": 0, "budgetType": 0, "userId": ***, "dynamicCreativeParam": "欢迎您的加入" } ] } }

    updateAccountInfo

    更新username对应的账户信息,如果是来自MCC Token的请求,则更新target对应的账户信息。

    Json示意

    {
    "accountInfo":{"userId":***,"excludeIp":["2.0.0.0"],"regionTarget":[2000],"dynamicCreativeParam":"?baidu.com","isDynamicCreative":true,…}
    }

    输入信息(updateAccountInfoRequest)

    参数名称 类型 说明 限制
    accountInfo AccountInfoType 更新对象 见下表,不填写的属性,没有返回值。

    对accountInfoType对象的输入限制如下:

    参数名称 类型
    userId 无效属性
    balance 无效属性(无返回值)
    cost 无效属性(无返回值)
    payment 无效属性(无返回值)
    budgetType 选填
    NULL:不修改该属性值为
    0:取消预算限制
    budget 选填,默认为NULL;
    值为NULL:不修改该属性;
    当设置为日预算时,取值范围:[50, 10000000];
    当设置为周预算时,取值范围:[388, 70000000];
    当不设置预算时,输入任意值均默认为0;
    (修改预算时,budgetType与budget必须都有合法值)
    regionTarget 选填;
    值为NULL:不修改该属性;
    值为空数组:取消投放地域限制
    excludeIp 选填;
    值为NULL:不修改该属性;
    值为空数组:取消IP排除
    openDomains 无效属性(无返回值)
    regDomain 无效属性(无返回值)
    budgetOfflineTime 无效属性(无返回值)
    weeklyBudget 无效属性(无返回值)
    isDynamicCreative 选填,子链开关;
    true:开启
    false:关闭
    isDynamicTagSublink 选填 ,标签子链开关;
    true:开启
    false:关闭
    isDynamicTitle 选填,动态标题开关;
    true:开启
    false:关闭
    isDynamicHotRedirect 选填,热点直达开关;true:开启
    false:关闭

    返回信息(updateAccountInfoResponse)

    参数名称 类型 说明 限制
    accountInfoType AccountInfoType 返回更新后的对象 无修改的属性,无返回值。对于无效属性,无返回值。

    代码示例

    • 请求

    更新用户的帐户信息,只返回用户更新过的字段。

    {
    "header":{
    	"opUsername":"searchlab",   			//mcc操作员账户名称
        "opPassword":"*********"        		//mcc操作员账户密码
        "tgUsername":"searchlab", 
        "tgPassword":"*********", 
        "tgSubname":"searchlab",				//mcc被操作的账户
        "bceUser":"014df051fa131234a2a*****" 	//mcc类型的bceuser
    },
    "body":{
    	"accountInfo":{
    	"budgetType":1,"budget":1000,"regionTarget":[2000,3000],"isDynamicCreative":false
    	}
    }
    }
    • 返回

      { "header": { "desc": "success", "failures": [], "oprs": 1, "succ": 1, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { "data": [ { "userId":***, "budget":1000.0, "regionTarget":[2000,3000], isDynamicCreative":false } ] } }

    上一篇
    CampaignService
    下一篇
    BulkJobService