搜索推广API

    KRService

    关键词规划师。

    数据类型

    SeedFilter

    请求关键词推荐时的设置条件。

    属性名类型说明备注
    deviceInteger设备类型选填,默认PC+无线;
    0:pc+无线;
    1:pc;
    2:无线
    maxNum Integer 返回结果的最大可能条数
    (实际返回条数一般小于等于maxNum)。
    返回结果是按照相关性排序的,maxNum越大,
    越往后返回的结果,相关性越降低。
    选填,默认300;
    取值范围:[1,1000]
    negativeWords String[] 返回结果字面中不能包含该词 选填,默认为null;
    数组最大元素限制:10个;
    单个元素最大字节数限制:64字节
    positiveWordString返回结果字面中必须包含该词选填,默认为null;
    最大字节数限制:64字节
    competeLow Long 限定只返回竞争激烈程度大于等于competeLow的拓展词,
    即返回词的竞争激烈程度在区间[competeLow,competeHigh]
    选填,默认值为0;
    取值范围[0,99]
    competeHigh Long 限定只返回竞争激烈程度小于等于competeHigh的拓展词
    ,即返回词的竞争激烈程度在区间[competeLow,competeHigh]
    选填,默认值为100;
    取值范围[1,100]
    pvLow Long 限定只返回日均搜索量大于等于pvLow的拓展词,
    即返回词的pv在区间[pvLow,pvHigh]
    选填,默认为1;
    取值范围:[0,4294967294]
    pvHigh Long 限定只返回日均搜索量小于等于pvHigh的拓展词,
    即返回词的pv在区间[pvLow,pvHigh]
    选填,
    默认为2147483647;
    取值范围:[1,4294967295]
    regionExtend Boolean 返回推荐词的字面中是否包含地域拓展词选填,
    默认为false;
    true:包含地域拓展词;
    false:不包含地域拓展词
    removeDuplicateBoolean返回结果是否与账户内已有关键词去重选填,
    默认值为true,去重;
    false:不去重;
    true:去重
    searchRegionsInteger[]指定地域pv,
    返回结果中的日均搜索量为searchRegion选定地域上的搜索量
    选填,
    默认值为null,表示全部地域

    KRResult

    关键词推荐的返回拓展词对象。

    属性名 类型 说明 限制
    wordstring 返回推荐词字面 最大长度64字节
    competition Integer 该关键词的广告客户竞争激烈程度 返回值范围:[0,100]
    wordPackageString关键词所属词包名-
    businessPointsList关键词所属业务点名-
    recBidDouble左侧(上方)准入价:
    过去一周内关键词在精确触发下推至页首所
    需要的最低价格
    -
    PVLong近30天内网民的日均搜索次数,
    PV=pcPV+mobilePV
    返回值范围:[0,4294967294]
    pcPVLong近30天内网民在PC端的
    日均搜索次数,
    当device=2(mobile)时,pcPV=0
    返回值范围:[0,4294967294]
    mobilePVLong近30天内网民在mobile端的
    日均搜索次数,
    当device=1(pc)时,mibilePV=0
    返回值范围:[0,4294967294]
    showReasonsList展现理由如:搜索词报告、百度相关搜索、移动黑马、
    黑马、同行动态、高电话拨打、
    高APP下载、搜索建议词

    KREstimatedType

    预估接口请求参数。

    属性名类型说明限制
    wordString关键词必填;关键词最大长度:64字节
    bidDouble关键词出价getEstimatedDataByBid接口必填;
    getEstimatedData接口该字段无效;
    取值范围:(0,999.99)开区间
    matchTypeInteger匹配模式选填,默认-短语-核心包含;
    取值范围:
    1 精确匹配;
    2 广泛匹配;
    3短语-同义包含;
    4短语-精确包含;
    5-短语-核心包含

    EstimatedBidType

    属性名类型说明限制
    showLong预估展现-
    clickdouble预估点击-
    cpcDouble预估平均点击价格-
    chargedouble预估消费-
    rankInteger预估排名-
    ctrdouble预估点击率-
    showRateDouble展现份额预估-
    pvLong日均检索量(精确匹配下)-
    recBidDouble准入价-

    EstimatedDataType

    属性名类型说明限制
    biddouble关键词出价-
    showLong每日展现次数-
    clickdouble每日点击次数-
    chargedouble每日消费-

    接口描述

    getKRCustom

    账户主动推词接口:根据用户的账户和业务内容,返回对应的为用户量身定制的推荐词。

    输入信息(getKRCustomRequest)

    属性名 类型 说明 限制
    idLong输入的计划/单元id,
    将根据输入id返回对应的量身推荐词
    选填
    idTypeInteger指定输入id的类型3:计划id;
    5:单元id;
    输入id为null时,type可在3,5之间任填
    seedFilter SeedFilter 请求种子词的设置条件选填

    返回信息(getKRCustomResponse)

    属性名 类型 说明
    krResult KRResult[ ]返回的拓展词对象数组

    代码示例

    • 请求 账户主动推词:

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "seedFilter": { "device": 1, "competeLow": 20 "competeHigh": 80 "searchRegions": [1000,3000] } } }

    • 返回 推荐词信息:

      { "header": { "desc": "success", "failures": [], "oprs": 2, "succ": 2, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { "data": [ { "word": "玫瑰花", "competition": 22, "wordPackage": "xxxx", "businessPoints": ["xxxx"], "showReasons": ["黑马"], "recBid": 2.12, "PV": 323 }, … ] } }

    getKRByQuery

    根据输入的种子词或url返回推荐的扩展词,一次调用仅允许请求1个种子词或一个url。

    输入信息(getKRByQueryRequest)

    属性名 类型 说明 限制
    queryTypeIntegerkr请求类型1:word推词;2:url推词
    queryString查询内容必填
    seedFilterSeedFilter请求种子词的设置条件选填

    返回信息(getKRByQueryResponse)

    属性名 类型 说明
    krResultKRResult[] 返回的拓展词对象数组

    代码示例

    • 请求 种子词推词:

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "queryType": 1, "query": "鲜花", "seedFilter": { "device": 1, "competeLow": 20 "competeHigh": 80 "searchRegions": [1000,3000] } } }

    • 返回

    推荐词信息:

    {
        "header": {
            "desc": "success",
            "failures": [],
            "oprs": 2,
            "succ": 2,
            "oprtime": 0,
            "quota": used_quota_of_this_operation,
            "rquota": your_remain_quota,
            "status": 0
        },
        "body": {
            "data": [
                {
                    "word": "玫瑰花", 
                    "competition": 22,
                    "wordPackage": "xxxx",
                    "businessPoints": ["xxxx"],
                    "showReasons": ["黑马"],
                    "recBid": 2.12, 
                    "PV": 323
                },
    	…
            ]
        }
    }

    getEstimatedDataByBid

    关键词预估接口。根据出价获取关键词预估结果。

    输入信息(getEstimatedDataByBidRequest)

    属性名类型说明限制
    wordsKREstimatedType[]关键词必填;数组元素最大个数:500
    searchRegionsInteger[]地域选填,默认值为null,表示全部地域

    输出信息(getEstimatedDataByBidResponse)

    属性名类型说明限制
    wordString关键词-
    biddouble出价-
    matchTypeInteger匹配模式-
    competitionLong 竞争激烈程度 -
    allEstimatedBidType所有设备预估数据-
    pcEstimatedBidType计算机预估数据-
    mobileEstimatedBidType移动预估数据-

    代码示例

    • 请求

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "words": [ { "word": "鲜花", "bid": 1.0, "matchType": 5 }, { "word": "玫瑰", "bid": 2.0, "matchType": 5 } ], "searchRegions": [1000,3000] } }

    • 返回 推荐词信息:

      { "header": { "desc": "success", "failures": [], "oprs": 2, "succ": 2, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { "data": [ { "word": "鲜花", "bid": 1.0, "matchType": 5 "competition": 35, "all": [ { "show": 2759, "click": 202.01, "cpc": 2.85, "charge": 575.3, "rank": 2, "ctr": 0.07, "showRate": 0.82, "pv": 595, "recBid": 9.51 } ], "pc": [ { "show": 65, … } ], "mobile": [ { "show": 65, … } ] } ] } }

    getEstimatedData

    关键词预估接口。随机出价获取关键词预估结果。

    输入信息(getEstimatedDataRequest)

    属性名类型说明限制
    wordsKREstimatedType[]关键词必填;数组元素最大个数:1000
    searchRegionsInteger[]地域选填,默认值为null,表示全部地域

    输出信息(getEstimatedDataResponse)

    属性名类型说明限制
    allEstimatedDataType所有设备预估结果-
    pcEstimatedDataType计算机预估结果-
    mobileEstimatedDataType移动预估结果-

    代码示例

    • 请求

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "words": [ { "word": "鲜花", "bid": 1.0, "matchType": 5 }, { "word": "玫瑰", "bid": 2.0, "matchType": 5 } ], "searchRegions": [1000,3000] } }

    • 返回 推荐词信息:

      { "header": { "desc": "success", "failures": [], "oprs": 2, "succ": 2, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { "data": [ { "all": [ { "show": 65, … } ], "pc": [ { "show": 65, … } ], "mobile": [ { "show": 65, … } ] } ] } }

    getKRFileIdByWords

    异步接口,根据输入的种子词返回推荐的扩展词,一次调用允许请求100个种子词。

    输入信息(getKRFileIdByWordsRequest)

    属性名类型说明限制
    seedWordsString[]关键词必填;
    关键词最大长度:64字节;
    数组元素最大个数:100
    seedFilterseedFilter请求种子词的设置条件选填

    输出信息(getKRFileIdByWordsResponse)

    属性名类型说明限制
    fileIdStringkr处理任务id-

    代码示例

    • 请求 种子词推词:

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "seedWords": ["鲜花","店面"], "seedFilter": { "device": 1, "competeLow": 20 "competeHigh": 80 "searchRegions": [1000,3000] } } }

    • 返回

    推荐词信息:

    {
        "header": {
            "desc": "success",
            "failures": [],
            "oprs": 2,
            "succ": 2,
            "oprtime": 0,
            "quota": used_quota_of_this_operation,
            "rquota": your_remain_quota,
            "status": 0
        },
        "body": {
            "data": [
                {
                    "fileId": "cc405142375a55dbc64a856e7f22ac76"
                }
            ]
        }
    }

    getFileStatus

    在调用getKRFileIdByWords接口后使用,以查询请求的文件是否已生成。

    输入信息(getFileStatusRequest)

    属性名类型说明限制
    fileIdstringgetKRFileIdbyWordS的下载任务id必填

    返回信息(getFileStatusResponse)

    属性名类型说明限制
    isGeneratedinteger文件任务状态检查1:等待中;
    2:处理中 ;
    3:处理成功;
    对于生成失败的文件返回null和对应的errorcode

    说明: 在获取getKRFileIdByWordS下载url前,请调用此方法。待确认文件已生成后,再获取下载的url。

    getFilePath

    返回请求的文件下载地址。使用接口:getKRFileIdByWords。

    按照请求的下载文件顺序返回。

    输入信息(getFilePathRequest)

    属性名类型说明限制
    fileIdString处理任务id必填

    返回信息(getFilePathResponse)

    属性名类型说明限制
    filePathString下载路径-
    一篇
    CreativeService
    一篇
    DynamicCreativeService