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

广告产品详情 API

GET/open-api/v1/ad-products/{id}
·api.ppspy.com
数据与监控消耗规则

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

请求头

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

请求示例

cURL
curl --location --request GET 'https://api.ppspy.com/open-api/v1/ad-products/8f624441d1106bb9937e187e13af0bf4' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

请求参数 1 项

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

参数 类型 说明
id
path · 必填
string 产品ID |

返回示例

返回示例 · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "product": {
            "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,
            "category_id": "62739bc738365b2f72048ece",
            "image_url": "https://fb-cdn.pipiads.com/images/pimg_c502cb2f8e21f07022aa.png",
            "category_name": "Mother & Kids",
            "user_collected": 2
        },
        "store": {
            "id": "b06855e0873197f5937e187e13af0bf4",
            "name": "CALLIXE",
            "e_commerce_platform": "shopify",
            "logo_url": null,
            "source_store_link": "https://callixe.com",
            "published_products_count": null,
            "month_visits": null,
            "monthly_sales": null
        },
        "ad_started_history": [
            {
                "date": "2024-10-08",
                "count": 1
            }
        ],
        "advertisers": [
            {
                "id": "26ac3236deb2689afa954bd5014c6719",
                "source_advertiser_id": "100671036247649",
                "name": "CALLIXE",
                "ad_count": 38,
                "like_count": 181,
                "profile_picture_url": "https://fb-cdn.pipiads.com/images/3e29e9a171b5cec7823edacb7a6a7ab0.png",
                "source_advertiser_link": "https://facebook.com/100088499547786",
                "adset_count": 0,
                "ad_country": [],
                "ad_status": 1,
                "creation_time": null,
                "ad_started_at": 1728370800,
                "ad_ended_at": 1728370800,
                "active_days": 1,
                "active_ad_count": 38,
                "inactive_ad_count": 0,
                "removed_ad_count": 0,
                "ad_source": 1,
                "category_name": null,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER"
                ],
                "ads_library_link": "https://www.facebook.com/ads/library/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100671036247649"
            }
        ]
    },
    "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
»» product 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 AI分数 可选值：1-测品阶段，2-上升阶段，3-盈利阶段。
»»» ad_status integer true none 广告状态 可选值：1-活跃中，2-已停止。
»»» 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 广告结束时间 时间戳：秒。
»»» category_id string¦null true none 产品分类ID none
»»» category_name string¦null true none 分类名称 none
»»» user_collected integer true none 是否已收藏 可选值：1-未收藏，2-已收藏。
»» store object true none 店铺信息 none
»»» id string true none 店铺ID none
»»» name string true none 店铺名称 none
»»» e_commerce_platform string¦null true none 电商平台 none
»»» logo_url string¦null true none 店铺logo图片 none
»»» source_store_link string¦null true none 店铺链接 none
»»» published_products_count integer¦null true none 产品数量 none
»»» month_visits integer¦null true none 月访问量 none
»» ad_started_history [object] true none 广告数量的趋势 none
»»» date string true none 日期 UTC时间
»»» count integer true none 广告数 none
»» advertisers [object] true none 广告主信息 none
»»» 广告主 object¦null false none 广告主 none
»»»» id string true none 广告主ID none
»»»» source_advertiser_id string true none 广告主的主页ID none
»»»» name string true none 广告主的名字 none
»»»» ad_count integer true none 广告素材数 none
»»»» like_count integer¦null true none 点赞数 none
»»»» profile_picture_url string¦null true none 广告主头像链接 none
»»»» source_advertiser_link string¦null true none 广告主的主页链接 none
»»»» adset_count integer¦null true none 广告组数 none
»»»» ad_country [string] true none 投放国家 none
»»»» ads_library_link string true none 广告主的广告库链接 none
»»»» ad_status integer true none 广告状态 可选值：1-活跃中，2-已停止。
»»»» creation_time integer¦null true none 创建时间 时间戳：秒。
»»»» ad_started_at integer true none 广告开始时间 时间戳：秒。
»»»» ad_ended_at integer true none 广告结束时间 时间戳：秒。
»»»» active_days integer true none 广告天数 none
»»»» active_ad_count integer true none 活跃的广告数 none
»»»» inactive_ad_count integer true none 不活跃的广告数 none
»»»» removed_ad_count integer true none 已下架的广告数 none
»»»» category_name string¦null true none 分类 none
»»»» ad_platform [string] 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

接口信息

  • 接口名称: 广告产品详情
  • 请求方法: GET
  • 接口地址: /open-api/v1/ad-products/{id}
  • 使用限制： 使用本接口前，请先通过广告产品列表接口获取 id，并在有效期内使用，过期请重新获取，否则接口会返回403002
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
来自现有接口目录与文档 · 支持接口名称和地址搜索