抖音千川服务

POST

ocean/engine

最后修改时间：2024-06-24 08:26:48

请求参数

Body 参数application/json

tenantID

string

租户id

必需

轻数平台租户

advertiserId

string

广告主ID

必需

抖音千川广告主id

shopId

string

店铺id

必需

抖音店铺id

httpType

string

请求类型

必需

get/post 参考千川接口文档

url

string

请求千川接口地址

必需

参考接口文档

appType

string

应用类型

必需

1 千川PC，2千川随心推

tableName

string

用于解析数据后存储

必需

bizParam

string

业务参数

必需

json字符串

isPage

boolean

是否分页

必需

true开启分页，false关闭分页

arrayField

string

数组字段

必需

解析响应数据字段,jsonpath结构

pageRule

number

分页规则

必需

isPage为true生效，默认1； 1 正常分页（分页字段为page页码，，page_size 大小），2游标方式（分页字段 cursor页码游标值，第一次拉取，无需入参，count。页面大小，默认值30，限制1-50）

customKey

string | null

自定义业务参数

可选

json数组结构[{"key":"","value":""}]

isTermination

boolean

异常是否终止

必需

默认为false；true 数据获取出现异常则终止，false 跳过异常继续处理

frequency

number | null

限流

可选

限流，自定义限流时长，如不传递则为600毫秒

database

string

用于确定存储数据库

必需

onlyRead

boolean

只读模式

可选

默认false；开启只读模式后，不会进行数据的写入

validKeys

array[string] | null

自定义取数字段

可选

不传递则为默认取全部，传递后只取该集合下key

示例

{
    "tenantID": "42",
    "advertiserId": "42",
    "shopId": "95",
    "httpType": "get",
    "url": "http://skgowpi.中国互联.公司/ntgt",
    "appType": "1",
    "tableName": "xxxx",
    "bizParam": "[{\"biz\":\"1\"}]",
    "isPage": false,
    "arrayField": "$.data.arrays",
    "pageRule": 1,
    "customKey": "[{\"key\":\"k1\",\"value\":\"v1\"}]",
    "isTermination": true,
    "frequency": 600,
    "database": "xxxxx",
    "onlyRead": false,
    "validKeys": [
        "eYV"
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://172.168.28.12:9099/daq/ocean/engine' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantID": "42",
    "advertiserId": "42",
    "shopId": "95",
    "httpType": "get",
    "url": "http://skgowpi.中国互联.公司/ntgt",
    "appType": "1",
    "tableName": "xxxx",
    "bizParam": "[{\"biz\":\"1\"}]",
    "isPage": false,
    "arrayField": "$.data.arrays",
    "pageRule": 1,
    "customKey": "[{\"key\":\"k1\",\"value\":\"v1\"}]",
    "isTermination": true,
    "frequency": 600,
    "database": "xxxxx",
    "onlyRead": false,
    "validKeys": [
        "eYV"
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

data

object

返回数据

必需

requestTotal

integer

请求到数据总条数

必需

sqlTotal

integer

生成sql总条数

必需

successSqlTotal

integer

成功写入总条数

必需

traceId

string

traceId

必需

示例

{
    "code": 0,
    "data": {
        "requestTotal": 0,
        "sqlTotal": 0,
        "successSqlTotal": 0
    },
    "traceId": "string"
}

旺店通企业版ERP（奇门）

吉客云