搜索推广API

    SearchService

    物料搜索。

    数据类型

    GetMaterialInfoBySearchParams

    属性名类型说明限制
    searchWordstring待搜索必填;最大长度40字节
    startNumInteger限定DB中按字面搜索结果的起始位置,如果限定campaignId或adgroupId则在限定的结果中过滤选填,默认为1
    endNumInteger限定DB中按字面搜索结果的终止位置,如果限定campaignId或adgroupId则在限定的结果中过滤。选填,默认为100;
    当endNum大于可能最大条数时,
    返回至最大条数位置结果为止。
    endNum最大限定为10000。
    campaignIdLong计划id选填,
    与adgroupId同时为空条件下,按照账户查询。
    当searchLevel为0时无效。
    adgroupIdLong单元id选填,
    与campaignId同时为空条件下,按照账户查询。
    当searchLvel为0、1时无效
    searchLevelInt查询物料类型必填;
    计划:0;
    单元:1;
    关键词:2
    searchTypeint搜索关键词匹配类型必填。
    0,模糊匹配;
    1,精确匹配
    materialFieldsString[]指定返回字段查询的属性域,
    填null或不填默认本层级及上层级全选。
    例如searchLevel=2时默认返回keywordId, keyword,adgroupId,
    adgroupName,campaignId, campaignName。
    取值限定:
    searchLevel=0时,取值范围:campaignId,campaignName;
    searchLevel=1时,取值范围: adgroupId, adgroupName,
    campaignId, campaignName;
    searchLevel=2时,取值范围:keywordId, keyword,adgroupId, adgroupName,
    campaignId, campaignName。
    注:如果不使用所有字段,
    建议仅选择需要的字段,提升查询效率。

    MaterialSearchInfo

    属性名类型说明限制
    materialInfoString[]按请求信息中materialFields定制的属性顺序返回物料信息materialFields按输入顺序返回,为空时取决于searchLevel:
    searchLevel为0时顺序为:keywordId, keyword,adgroupId,
    adgroupName,campaignId, campaignName。
    searchLevel为1时顺序为:adgroupId, adgroupName,
    campaignId, campaignName。
    searchLevel=2时,顺序为:keywordId, keyword,adgroupId,
    adgroupName,campaignId, campaignName。
    不为空时,返回结果字符串数
    组中各字段与输入参数一致

    GetCountByIdParams

    属性名类型说明限制
    idTypeInt输入id类型默认为全账户;0 计划id;1 单元id
    idsList待查idIdtype为空(账户层级)时无效,其余情况必填,
    最多1000个
    countTypeInt输出结果粒度必填;
    0,单元,
    1,关键词,
    2创意
    3计划。
    注:idtype为账户层级时可以取0、1、2、3;
    idtype为计划id时,可以取0、1、2;idtype为单元id时,
    可以填1、2

    CountInfo

    属性名类型说明限制
    idlong待查ID若返回必有
    countlong结果数量若返回必有

    TabType

    属性名类型说明
    tabIdInteger物料标签id,取值范围0~5
    adgroupIdLong单元id
    idTypeInteger关键词、创意层级;关键词:11;创意:7;关键词+创意:117
    idsLong[]某个物料标签下,关键词或者创意的id集合
    tabNameString物料标签字面量

    接口描述

    getMaterialInfoBySearch

    用户提供一个待搜索的关键词,搜索层级及搜索范围信息,服务端返回用户当前账户中的相关关键词的搜索结果。

    输入信息(getMaterialInfoBySearchRequest)

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

    返回信息(getMaterialInfoBySearchResponse)

    属性名类型说明限制
    moreMaterialint是否有更多的物料信息必有,0或1。有更多结果时返回1,无更多结果时返回0。
    materialSearchInfos-限定区间中的搜索相关物料结果没有搜索结果时无

    代码示例

    • 请求 获取帐户的全部属性:

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "searchWord":鲜花, startNum:1, "endNum":3, "searchLevel":1, "searchType":1, "campaignId":3233329, "adgroupId":212180382366, "materialFields": ["adgroupId","campaignName","adgroupId","adgroupName","campaignId","adgroupId"] } }

    • 返回

      { "header": { "desc": "success", "failures": [], "oprs": 1, "succ": 1, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { { "data": [ { { "moreMaterial": 1, "materialSearchInfos": [ { "materialInfos": [ "296119579", "鲜花", "2121803823", "GDATA-UNIT-150817025739-00441", "3233329", "GDATA-PLAN-150817025738-00000" ] }, { "materialInfos": [ "296119577", "鲜花", "2121803873", "GDATA-UNIT-150817025739-00402", "3233329", "GDATA-PLAN-150817025738-00000" ] } ] } }

      }

      }

    getCountById

    用户提供一个待搜索的id序列,服务端返回用户此id序列下对应状态的的单元/关键词数量,id数量不超过1000。

    输入信息(getCountByIdRequest)

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

    返回信息(getCountByIdResponse)

    属性名类型说明限制
    countInfoslist数量信息没有搜索结果时无

    代码示例

    • 请求 获取帐户的全部属性:

      { "header":{ "opUsername":"searchlab", //mcc操作员账户名称 "opPassword":"*" //mcc操作员账户密码 "tgUsername":"searchlab", "tgPassword":"*", "tgSubname":"searchlab", //mcc被操作的账户 "bceUser":"014df051fa131234a2a*" //mcc类型的bceuser }, "body":{ "idType":1, "ids":[4579,412451,412341], "countType":1 } }

    • 返回

      { "header": { "desc": "success", "failures": [], "oprs": 2, "succ": 2, "oprtime": 0, "quota": used_quota_of_this_operation, "rquota": your_remain_quota, "status": 0 }, "body": { "data": [ { "data": [ { "countInfos": [ { "id": 430, "count": 563 } ] } ], "errors": [

              ],
              "options": {
                  "options": null,
                  "success": 1,
                  "total": 1
              }
          }
      ]

      } }

    getTab

    输入参数(getTabRequest)

    属性名类型说明限制
    tabIdsInteger[]物料标签id[](必填);取值范围0-5,(0表示没有标记);默认值返回all(1-5)
    adgroupIdsLong[]单元id集合选填;建议多次分批请求,每次不超过30个;[]或null,则返回的ids为空
    idTypeInteger关键词、创意层级(必填);关键词:11;创意:7;关键词+创意:117
    IncludeMaterialIdsboolean是否需要查询标签id下对应的物料ids(选填);默认为false,不查询标签对应的物料id
    上一篇
    DynamicCreativeService
    下一篇
    LiveReportService