You need to enable JavaScript to run this app.
导航
上传文件创建分群
最近更新时间:2024.06.30 18:36:02首次发布时间:2024.06.30 18:36:02

请求说明

该接口会将本地文件上传并生成uuid_file_key,只有通过uuid_file_key才可用于OpenAPI创建或更新通过文件定义的分群。
Path:/openapi/v1/{app_id}/cohorts/upload_uuid
Method: POST
Content-type: multipart/form-data

请求参数

Path-parameters: 参考考API说明与公共参数
Body:

{
    "file": {二进制文件},
}

{
    "cohort_name": "文件创建分群-openapi",
    "description": "",
    "refresh_rule": 0, # 只能是0,表示不支持刷新
    "cohort_type": 2, # 固定为2,表示文件创建分群
    "dsl_content": {
        "uuid_file_key": "upload_uuid/164314/20220819/1eb8f3c6-4447-4e9c-a538-c1b33a1cd0e4.csv", 
        // uuid_file_key需要通过9.1接口上传文件后获取
        "file_list": [
            {
                "name": "user_unique_id_template (3).csv" //上传文件的名称
            }
        ],
        "dsl_type": "user_unique_id" // 支持user_unique_id、ssid、device_id、web_id
    }
}

返回参数

Response:

{
    "code": 200,
    "message": "success",
    "data": {
        "uuid_file_key": "{file_key}"
    }
}

字段含义说明

参数

类型

示例值

描述

uuid_file_key

string

upload_uuid/164314/20220819/1eb8f3c6-4447-4e9c-a538-c1b33a1cd0e4.csv

上传成功后的file_key

  • 文件最大限制为200m
  • 支持的文件格式为csv
  • 支持的表头为user_unique_id,第二行开始为具体数据

请求示例

bc 为创建的 RangersClient, 其初始化请参考使用说明, 各语言的 SDK 都提供了类似的接口
调用(Python):

# 例如,app_id= 164314

# 例如, 上传 uuids.csv
method = 'POST'
service_url = '/datafinder/openapi/v1/164314/cohorts/upload_uuid'
headers = {}  # headers 不需要显式添加'Content-Type'属性,否则会报错
files = {  # form-data 格式文件
    'file': ('uuids.csv', open('uuids.csv', 'rb'))  # key 必须为 'file',value 为上传的 csv 文件
}

resp = bc.request(method=method, service_url=service_url, headers=headers, files=files)
print(resp.content.decode('utf-8'))

返回示例

返回结果:

{
    "code": 200,
    "message": "success",
    "data": {
        "uuid_file_key": "upload_uuid/164314/20220819/1eb8f3c6-4447-4e9c-a538-c1b33a1cd0e4.csv"
    }
}