PPSPYAPI Platform
中文 / EN
文档/广告库产品/接口参考
接口参考

广告产品列表 API

POST/open-api/v1/ad-products/search
每获取一条记录扣除2积分·api.ppspy.com
数据与监控消耗规则

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

请求头

AUTHORIZATIONAuthorization: {API Key}
CONTENT-TYPEapplication/json
ACCEPTapplication/json

请求示例

cURL
curl --location --request POST 'https://api.ppspy.com/open-api/v1/ad-products/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
    "page": 1,
    "per_page": 2
}'

请求参数 51 项

按参数标注的位置传入请求。

参数 类型 说明
body
body · 可选
object | none
» extend_keywords
body · 可选
[object] 关键词搜索 | none
»» field
body · 必填
string 搜索的字段 | 可选值：all-全部，product_name-产品名称，product_link-产品URL，advertiser_name-广告主名称。
»» value
body · 必填
string 搜索的内容 | none
»» logic_operator
body · 必填
string 逻辑运算符 | 可选值：and，or。
» exclude_keywords
body · 可选
[object] 排除关键字 | none
»» field
body · 必填
string 搜索的字段 | 可选值：all-全部，product_name-产品名称，product_link-产品URL，advertiser_name-广告主名称。
»» value
body · 必填
string 搜索的内容 | none
»» logic_operator
body · 必填
string 逻辑运算符 | 可选值：and，or。
» ad_forecast
body · 可选
[integer] AI分数 | 可选值：1-测品阶段，2-上升阶段，3-盈利阶段。
» e_commerce_platform
body · 可选
[string] 电商平台 | none
» creation_time_start
body · 可选
integer 产品创建时间（开始） | 时间戳：秒。
» creation_time_end
body · 可选
integer 产品创建时间（结束） | 时间戳：秒。
» category_id
body · 可选
[string] 产品分类ID | none
» store_country
body · 可选
[string] 店铺国家 | none
» price_usd_start
body · 可选
number 产品美元价格（开始） | none
» price_usd_end
body · 可选
number 产品美元价格（结束） | none
» currency
body · 可选
[string] 货币单位 | none
» store_pixel_platforms
body · 可选
[string] Pixel平台 | 可选值：snap，tiktok，pinterest。
» store_language
body · 可选
[string] 店铺语言 | none
» store_published_products_count_start
body · 可选
integer 店铺产品数（开始） | none
» store_published_products_count_end
body · 可选
integer 店铺产品数（结束） | none
» active_adset_count_start
body · 可选
integer 活跃广告组数（开始） | none
» active_adset_count_end
body · 可选
integer 活跃广告组数（结束） | none
» adset_count_24h_start
body · 可选
integer 24小时广告组数（开始） | none
» adset_count_24h_end
body · 可选
integer 24小时广告组数（结束） | none
» adset_count_start
body · 可选
integer 总广告组数（开始） | none
» adset_count_end
body · 可选
integer 总广告组数（结束） | none
» ad_count_start
body · 可选
integer 广告素材数（开始） | none
» ad_count_end
body · 可选
integer 广告素材数（结束） | none
» store_active_adset_count_start
body · 可选
integer 店铺活跃广告组数（开始） | none
» store_active_adset_count_end
body · 可选
integer 店铺活跃广告组数（结束） | none
» store_ad_count_start
body · 可选
integer 店铺广告素材数（开始） | none
» store_ad_count_end
body · 可选
integer 店铺广告素材数（结束） | none
» ad_audience_reach_start
body · 可选
integer 覆盖人数（开始） | none
» ad_audience_reach_end
body · 可选
integer 覆盖人数（结束） | none
» ad_cost_start
body · 可选
number 广告花费（开始） | 单位：美元。
» ad_cost_end
body · 可选
number 广告花费（结束） | 单位：美元。
» ad_status
body · 可选
integer 广告状态 | 可选值：1-活跃中，2-已停止。
» active_days_start
body · 可选
integer 广告天数（开始） | none
» active_days_end
body · 可选
integer 广告天数（结束） | none
» ad_started_at_start
body · 可选
integer 广告开始时间（开始） | 时间戳：秒。
» ad_started_at_end
body · 可选
integer 广告开始时间（结束） | 时间戳：秒。
» ad_ended_at_start
body · 可选
integer 广告结束时间（开始） | 时间戳：秒。
» ad_ended_at_end
body · 可选
integer 广告结束时间（结束） | 时间戳：秒。
» order_by
body · 可选
string 排序字段 | 可选值：ad_started_at-广告开始时间，ad_ended_at-广告结束时间，active_adset_count-活跃广告组数，adset_count_24h-24小时广告组数，adset_count-总广告组数，ad_count-广告素材数，store_active_adset_count-店铺活跃广告组数，creation_time-产品创建时间，ad_audience_reach-覆盖人数，ad_cost-广告花费，active_days-广告天数。
» direction
body · 可选
string 排序方式 | 可选值：desc-降序，asc-升序。
» page
body · 可选
integer 页码 | 最小值等于1。
» per_page
body · 可选
integer 分页大小 | 取值范围1-100。
» ids
body · 可选
[string] 产品ID | none
» store_id
body · 可选
string 店铺ID | none

返回示例

返回示例 · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "current_page": 10,
        "data": [
            {
                "id": "8f624441d1106bb9937e187e13af0bf4",
                "store_id": "b06855e0873197f5937e187e13af0bf4",
                "name": "Thera Pillow | Traction Massager",
                "source_product_link": "https://callixe.com/products/thera",
                "currency": "USD",
                "price": 89.73,
                "price_usd": 89.73,
                "ad_count": 1,
                "creation_time": 1712007737,
                "active_ad_count": 1,
                "source_product_id": "9426992202001",
                "images": [
                    "https://fb-cdn.pipiads.com/images/pimg_c502cb2f8e21f07022aa.png",
                    "https://fb-cdn.pipiads.com/images/pimg_c64596f08800b96cbdd4.png",
                    "https://fb-cdn.pipiads.com/images/pimg_87f89103b85e469582d4.png",
                    "https://fb-cdn.pipiads.com/images/pimg_e19af42f354271c796d9.png",
                    "https://fb-cdn.pipiads.com/images/pimg_d99b44555550dfe88916.png"
                ],
                "adset_count": 0,
                "active_adset_count": 0,
                "adset_count_24h": 0,
                "ad_forecast": 1,
                "ad_status": 1,
                "e_commerce_platform": "shopify",
                "ad_audience_reach": 0,
                "ad_cost": 0.99,
                "active_days": 1,
                "ad_started_at": 1728370800,
                "ad_ended_at": 1728370800,
                "image_url": "https://fb-cdn.pipiads.com/images/pimg_c502cb2f8e21f07022aa.png",
                "store": {
                    "id": "b06855e0873197f5937e187e13af0bf4",
                    "name": "CALLIXE",
                    "ad_count": 1,
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": [
                        1,
                        3
                    ],
                    "logo_url": null,
                    "source_store_link": "https://callixe.com",
                    "adset_count": 0,
                    "country": "US",
                    "monthly_sales": null
                },
                "user_collected": 2
            }
        ],
        "last_page": 1,
        "per_page": 2,
        "total": 1
    },
    "credits": {
        "remaining_credits": 745,
        "consumed_credits": 0,
        "total_credits": 745
    }
}
文档中的示例数据

返回数据结构

名称 类型 必选 约束 中文名 说明
» code integer true none 业务状态码 none
» message string true none 响应的消息 none
» data object true none 响应的数据 none
»» current_page integer true none 当前页码 none
»» data [object] true none 数据列表 none
»»» id string true none 产品ID none
»»» store_id string true none 店铺ID none
»»» name string true none 产品名称 none
»»» source_product_link string true none 产品链接 none
»»» currency string¦null true none 货币 none
»»» price number¦null true none 产品价格 none
»»» price_usd number¦null true none 产品美元价格 none
»»» ad_count integer true none 广告数 none
»»» creation_time integer¦null true none 产品创建时间 时间戳：秒。
»»» active_ad_count integer true none 活跃广告数 none
»»» source_product_id string true none 电商平台的产品ID none
»»» images [string] true none 产品图片链接 none
»»» image_url string¦null true none 产品主图 none
»»» adset_count integer true none 总广告组数 none
»»» active_adset_count integer true none 活跃广告组数 none
»»» adset_count_24h integer true none 24小时广告组数 none
»»» ad_forecast integer true none 产品分数 none
»»» ad_status integer true none 广告状态 none
»»» e_commerce_platform string true none 电商平台 none
»»» ad_audience_reach integer¦null true none 覆盖人数 none
»»» ad_cost number¦null true none 广告花费 单位：美元。
»»» active_days integer true none 广告天数 none
»»» ad_started_at integer true none 广告开始时间 时间戳：秒。
»»» ad_ended_at integer true none 广告结束时间 时间戳：秒。
»»» store object¦null true none 店铺信息 none
»»»» id string true none 店铺ID none
»»»» name string true none 店铺名称 none
»»»» ad_count integer true none 店铺素材数 none
»»»» e_commerce_platform string¦null true none 电商平台 none
»»»» e_commerce_types [integer]¦null true none 电商类型 none
»»»» logo_url string¦null true none 店铺logo none
»»»» source_store_link string¦null true none 店铺链接 none
»»»» adset_count integer true none 总广告组数 none
»»»» monthly_sales integer¦null true none 月销量 none
»»»» country string¦null true none 店铺国家 none
»»» user_collected integer true none 是否已收藏 可选值：1-未收藏，2-已收藏。
»» last_page integer true none 最后一页的页码 none
»» per_page integer true none 分页大小 none
»» total integer true none 总数据量 none
» credits object true none Credits 信息 当前 API 请求对应的 credits 信息
»» remaining_credits integer true none 剩余 credits 本次请求后剩余的 credits 数量
»» consumed_credits integer true none 消耗 credits 本次请求消耗的 credits 数量
»» total_credits integer true none 总 credits 当前 credits 类型的总数量
原始接口信息与服务地址

Base URLs

  • 生产环境: https://api.ppspy.com

接口信息

  • 接口名称: 广告产品列表
  • 请求方法: POST
  • 接口地址: /open-api/v1/ad-products/search
  • 价格说明: 每获取一条记录扣除2积分
GET查询当前积分/open-api/v1/creditsGETShopify店铺列表/open-api/v1/shopGETShopify店铺详情/open-api/v1/shop/{id}GET店铺流量列表/open-api/v1/shop/traffic-shopGET单商品店铺列表/open-api/v1/shop/single-product-shopGET店铺主题模版库/open-api/v1/shop/theme-shopGETShopify产品列表/open-api/v1/productGETShopify畅销产品列表/open-api/v1/bestsellersPOST广告列表/open-api/v1/advertisements/searchGET广告详情/open-api/v1/advertisements/{id}POST广告店铺列表/open-api/v1/ad-stores/searchGET广告店铺详情/open-api/v1/ad-stores/{id}GET广告店铺的落地页统计/open-api/v1/ad-stores/landing-pages-ad-countGET店铺的广告趋势/open-api/v1/ad-stores/analysisGET店铺的投放分析/open-api/v1/ad-stores/deep-analysisGET店铺的广告文案 最多使用/open-api/v1/ad-stores/ad-contentGET店铺的广告文案 最长运营/open-api/v1/ad-stores/ad-content-longest-runGET店铺的广告主/open-api/v1/ad-stores/advertisersPOST广告产品列表/open-api/v1/ad-products/searchGET广告产品详情/open-api/v1/ad-products/{id}POST创建分组/open-api/v1/ad-monitor-groupsGET分组列表/open-api/v1/ad-monitor-groupsPUT编辑分组/open-api/v1/ad-monitor-groups/{id}DELETE删除分组/open-api/v1/ad-monitor-groups/{id}POST搜索广告主/open-api/v1/ad-monitor-task/search-fb-ads-advertiser
来自现有接口目录与文档 · 支持接口名称和地址搜索