Pipispy APIEnglish

数据消耗规则:1. 获取一条数据结果消耗1 数据,获取数据结果的更多数据详情不消耗数据。2. 广告监控: 每次监控 $1 / 月。单个监控有效期为一个月,一个月后自动停止。删除监控不会恢复监控次数,请谨慎删除。监控调用为随时且无限次。

监控任务广告商品列表

接口信息

  • 接口名称: 监控任务广告商品列表
  • 请求方法: POST
  • 接口地址: open-api/v1/monitor/data
  • 接口路径: /v3/api/ad-monitor-task/product-list
  • 接口描述:
    • 广告商品 - 全部商品列表
    • 价格说明: 免费

请求头:

  • Content-Type: application/json
  • Accept: application/json

请求参数

请求结构

参数名 类型 描述 示例 必填 默认值
key string 用户申请的外部 api 请求 key "your_api_key_here" 是
uri string 接口路径 "/v3/api/ad-monitor-task/product-list" 是
params object 接口入参对象 见参数列表 是

请求体参数 (params 对象)

参数名 类型 必填 描述
task_id String true 任务id
keyword String false 商品名称关键词
first_ad_date_start integer false 首次广告开始日期, 时间戳,单位s
first_ad_date_end integer false 首次广告结束日期, 时间戳,单位s
min_active_ad_count integer false 最小活跃广告数
max_active_ad_count integer false 最大活跃广告数
min_ad_count integer false 最小广告数
max_ad_count integer false 最大广告数
min_ad_days integer false 最小投放天数
max_ad_days integer false 最大投放天数
min_price number false 最小价格
max_price number false 最大价格
min_material_count integer false 最小店铺素材数量
max_material_count integer false 最大店铺素材数量
recent_ad_date_start integer false 最近广告开始日期,时间戳,单位s
recent_ad_date_end integer false 最近广告结束日期, 时间戳,单位s
order_by string false 可支持排序的字段:
active_ad_count(活跃广告数)
ad_count(广告数)
ad_days(投放天数)
recent_ad_date(最近广告开始日期)
first_ad_date(首次广告日期)
price(价格)
material_count (店铺素材数量 )
direction string false 排序方式 desc,asc
page integer false 页码
per_page integer false 分页大小

请求示例

curl -X POST "https://www.pipispy.com/open-api/v1/monitor/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/ad-monitor-task/product-list",
    "params": {
        "order_by": "ad_count",
        "direction": "desc",
        "min_active_ad_count": 10,
        "max_active_ad_count": 1000,
        "max_ad_count": 1000,
        "min_ad_days": 5,
        "max_ad_days": 20,
        "min_price": 20,
        "max_price": 100,
        "per_page": 10,
        "page": 1,
        "first_ad_date_start": 1745798400,
        "first_ad_date_end": 1761350399,
        "recent_ad_date_start": 1753574400,
        "recent_ad_date_end": 1761350399,
        "task_id": "68f98898850c5345a4c87e66"
    }
  }'

响应参数

响应体结构

{
  "code": 200,
  "message": "success",
  "data": {},
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

响应字段说明

字段名 类型 描述
code Integer 响应状态码,200 表示成功
message String 响应消息
data Object 响应数据
version String API 版本
timestamp String 响应时间戳
sign String 响应签名
remaining_credits Long 当前请求后的剩余可用积分
consumed_credits Long 本次请求消耗的积分
success Boolean 请求是否成功
fail Boolean 请求是否失败

响应结果信息字段

字段名 类型 描述
per_page integer 每页数据量
total integer 搜索结果总量
last_page integer 最后一页
current_page integer 当前页
data array [object {10}] 数据
data[].product_id string 商品ID
data[].product_url string 产品地址
data[].product_name string 商品名称
data[].product_image string 商品图片
data[].active_ad_count integer 活跃广告数
data[].ad_count integer 广告数量
data[].ad_days integer 投放天数
data[].recent_ad_date integer 最近广告日期(秒级时间戳)
data[].first_ad_date integer 首次广告日期(秒级时间戳)
data[].price number 价格(USD)

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "per_page": 10,
    "total": 1,
    "data": [
      {
        "product_url": "https://atoleajewelry.com/collections/waterproof-jewelry/products/initial-birthstone-charm-necklace",
        "product_image": "https://fb-cdn.pipiads.com/images/pimg_e20d63ffa1cc4f3512f02.png",
        "price": 80.0,
        "product_id": "016ffe77783899d006894f28ab736904",
        "ad_count": 103,
        "recent_ad_date": 1754722800,
        "first_ad_date": 1753340400,
        "ad_days": 17,
        "product_name": "Initial & Birthstone Charm Necklace",
        "active_ad_count": 103
      }
    ],
    "last_page": 1,
    "current_page": 1
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

错误码说明

错误码 描述
200 成功
400 请求参数错误
500 服务器内部错误