接口参考

创建监控任务 API

POST/open-api/v1/ad-monitor-task/create-monitor-task

每成功创建一个监控任务，消耗1次监控额度·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-monitor-task/create-monitor-task' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
    "facebook_page_id_list": [
        "100726615757315"
    ],
    "group_id": "d7fffb6c5166af6c285438ecf5202a87"
}'

请求参数 6 项

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

参数	类型	说明
body body · 可选	object	\| none
» facebook_page_id_list body · 可选	[string]	Facebook广告主ID列表 \| none
» facebook_page_url_list body · 可选	[string]	Facebook广告主URL列表 \| none
» facebook_public_page_number_list body · 可选	[string]	Facebook公共主页编号列表 \| none
» facebook_shop_url_list body · 可选	[string]	店铺/网站的URL列表 \| none
» group_id body · 可选	string¦null	广告分组ID \| none

返回示例

返回示例 · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "data": [
            {
                "task_id": "902175d02614903e4944dfdfe85bbb4d",
                "facebook_page_id": "100726615757315",
                "facebook_page_url": null,
                "facebook_public_page_number": null,
                "facebook_shop_url": null,
                "error_message": null
            }
        ]
    },
    "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
»» data	[object]	true	none		none
»»» task_id	string	true	none	监控任务ID	none
»»» facebook_page_id	string¦null	true	none	Facebook广告主ID	none
»»» facebook_page_url	string¦null	true	none	Facebook广告主URL	none
»»» facebook_public_page_number	string¦null	true	none	Facebook公共主页编号	none
»»» facebook_shop_url	string¦null	true	none	店铺/网站的URL	none
»»» error_message	string¦null	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-monitor-task/create-monitor-task
价格说明: 每成功创建一个监控任务，消耗1次监控额度
重要说明: 如果同时提交多个参数(facebook_page_id_list, facebook_page_url_list, facebook_public_page_number_list, facebook_shop_url_list)，系统只会使用其中一个。使用优先级从高到低为: facebook_page_id_list > facebook_page_url_list > facebook_public_page_number_list > facebook_shop_url_list