人群包接口

更新时间：2020-03-17

新增人群包

接口描述

通过上传人群设备号文件新建人群包，文件中必须包含5000条与类型匹配的条目。账户下自定义人群包上限50。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CrowdFeedService/addCrowdFeed

请求参数说明

字段名称	类型	描述
crowdType	number	人群类型：1.IDFA 2.IMEI 4.手机号md5 5.IDFA_MD5 6.IMEI_MD5
crowdName	string	自定义人群名
content	string	人群文件，Base64编码后上传设备id的内容（目前最大支持10M）

响应参数说明

字段名称	类型	描述
crowdId	number	人群包ID
crowdName	string	人群名

请求示例

POST /v1/feed/cloud/CrowdFeedService/addCrowdFeed 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": {
    	"crowdFeedType": {
            "crowdName": "人群1",
            "crowdType": 1,
            "content": "JCODMwNDMKNjk2RjQ1OTEtMkYwNi00OEQxLTlDOUUtRUU3QzkjNENQ=="
       }
	}
}

响应示例

{
    "body": {
        "data": [
            {
                "crowdId": 123456,
                "crowdName": "人群1"
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

人群包文件分片上传

接口描述

分片上传人群文件，必须按照顺序上传分片，每个分片不大于10M，每个分片大小不一定相同，除了最后一个分片，每个分片至少包含5000行数据。

请求URL

http://sem.baidubce.com/v1/feed/cloud/CrowdFeedService/uploadCrowdFileBySlice

请求参数说明

字段名称	类型	描述
fileName	string	上传的文件名
chunks	number	分片总数量
chunk	number	分片编号，从0开始
crowdType	number	人群包类型：1.IDFA 2.IMEI 4.手机号md5 5.IDFA_MD5 6.IMEI_MD5
md5	string	文件的md5，多个分片以md5为标识
base64Content	string	分片的base64字符串

响应参数说明

字段名称	类型	描述
fileId	number	文件id，只在最后一个分片返回fileId

请求示例

POST /v1/feed/cloud/CrowdFeedService/uploadCrowdFileBySlice 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分钟，需要替换成自己生成的签名)
{
    "header": {
        "opUsername": "example",
        "tgUsername": "example",
        "bceUser": "example",
        "opPassword": "example",
        "tgPassword": "example"
    },
    "body": {
	    "fileName": "demo.txt",
	    "chunks": 2,
	    "chunk": 1,
	    "crowdType": 1,
	    "md5": "a98dksj20be28865cb8asdfsdf20a2c",
	    "base64Content": "TNFMDEyQ0UxOEM1CjNEMzJGMkFELUU0NDYtNERGRC1C..."
	}
}

响应示例

{
    "body": {
        "data": [
            {
                "fileId": 3412632
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

通过人群包文件id添加人群包

接口描述

通过人群包文件id添加人群包，人群包文件id是由人群包文件分片上传接口返回的

请求URL

http://sem.baidubce.com/v1/feed/cloud/CrowdFeedService/addCrowdFeedWithFileId

请求参数说明

字段名称	类型	描述
fileId	number	分片上传人群包文件返回的fileId
crowdType	number	人群包类型：1.IDFA 2.IMEI 4.手机号md5 5.IDFA_MD5 6.IMEI_MD5
crowdName	string	人群包名称

响应参数说明

字段名称	类型	描述
crowdId	number	人群id
crowdName	string	人群名称

请求示例

POST /v1/feed/cloud/CrowdFeedService/addCrowdFeedWithFileId 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分钟，需要替换成自己生成的签名)
{
    "header": {
        "opUsername": "example",
        "tgUsername": "example",
        "bceUser": "example",
        "opPassword": "example",
        "tgPassword": "example"
    },
    "body": {
	    "fileId": 3412632,
	    "crowdType": 1,
        "crowdName": "租房人群包"
	}
}

响应示例

{
    "body": {
        "data": [
            {
                "crowdId": 120102401,
                "crowdName": "租房人群包"
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

查询人群包

接口描述

通过人群包id或人群名称查询人群包信息，如果请求参数人群包id集合和人群包名称集合都不传，则查询全部数据。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CrowdFeedService/getCrowdFeed

请求参数说明

字段名称	类型	描述
crowdIdList	array(number)	人群包id集合，可为空
crowdNameList	array(string)	人群包名称集合，可为空，如果人群包id集合不为空，则忽略该条件

说明：当前接口兼容旧的请求参数（crowdId、crowdName），后续如果下线会提前通知。

响应参数说明

字段名称	类型	描述
crowdId	number	人群id
crowdName	string	人群名称
crowdTypeDesc	string	人群类型描述
status	number	人群状态，1：计算中，2：生效，3：失效
crowdCount	number	预估覆盖人数
createTime	number	创建时间，unix时间戳，单位毫秒
expireTime	number	过期时间，unix时间戳，单位毫秒
fromUserId	number	由谁分享，非分享的人群包不返回此字段
toUserIds	array(number)	已分享给谁

请求示例

POST /v1/feed/cloud/CrowdFeedService/getCrowdFeed 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": {
    	"crowdIdList":[1231211], 
    }
}

响应示例

{
    "body": {
        "data": [
            {
                "expireTime": 33070937979000,
                "createTime": 1535705647000,
                "status": 2,
                "crowdTypeDesc": "主题人群包",
                "crowdId": 1231211,
                "crowdCount": 10552780,
                "crowdName": "租房人群包"
            }
        ]
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

查询人群包关联的推广单元

接口描述

根据人群包id查询绑定该人群包的单元id。

接口URL

http://sem.baidubce.com/v1/feed/cloud/CrowdFeedService/getBindAdgroup

请求参数说明

字段名称	类型	描述
crowdId	number	人群包ID，必填
crowdName	string	人群名，选填

响应参数说明

字段名称	类型	描述
--	Map	Map的key为人群包的id，Map的value为关联此人群包的单元的id集合

请求示例

POST /v1/feed/cloud/CrowdFeedService/getBindAdgroup 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": {
    	"crowdFeedTypes": [
			{
				"crowdId": 123123
			},
			{
			    "crowdId": 123456
			}
    	]
	}
}

响应示例

{
    "body": {
        "data": {
            {
                "123123": [11111, 22222]
            },
			{
                "123456": [33333, 44444]
            }
        }
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}

推广单元接口

意图词包接口

人群包接口

新增人群包

人群包文件分片上传

通过人群包文件id添加人群包

查询人群包

查询人群包关联的推广单元

产品与文档反馈

提交失败

温馨提示

提交成功

温馨提示