linkfox-shopee-store-ads について
Shopee Open Platform の Ads API を利用し、店舗運営者による広告データの確認や商品広告の管理を支援するスキルです。プロキシ経由で AD トークンを扱い、レスポンスを保存・要約するスクリプトを備えています。
主な機能
- 01広告残高と商品・キーワード推薦の取得
- 02手動商品広告の作成と編集
- 03GMS 商品キャンペーンの管理
- 04CPC とキャンペーン実績レポートの取得
- 05レスポンス全体の保存と大容量出力の要約
活用シーン
- 01広告アカウント残高と推薦項目の確認
- 02手動商品広告の作成と実績確認
- 03CPC または GMS キャンペーンの分析
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ linkfox-ai/ linkfox-skills --skill linkfox-shopee-store-adsインストール後、Claude Code で/linkfox-shopee-store-adsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/api.mdonboarding.mdreferences/apis/check-create-gms-product-campaign-eligibility.mdcreate-gms-product-campaign.mdcreate-manual-product-ads.mdedit-gms-item-product-campaign.mdedit-gms-product-campaign.mdedit-manual-product-ad-keywords.mdedit-manual-product-ads.mdget-ads-facil-shop-rate.mdget-all-cpc-ads-daily-performance.mdget-all-cpc-ads-hourly-performance.mdget-create-product-ad-budget-suggestion.mdget-gms-campaign-performance.mdget-gms-item-performance.mdget-product-campaign-daily-performance.mdget-product-campaign-hourly-performance.mdget-product-level-campaign-id-list.mdget-product-level-campaign-setting-info.mdget-product-recommended-roi-target.mdget-recommended-item-list.mdget-recommended-keyword-list.mdget-shop-toggle-info.mdget-total-balance.mdlist-gms-user-deleted-item.mdscripts/_ads_api_runner.py_ads_endpoints.py_shopee_ads_common.pyads_api.pycheck_auth_dependency.py詳細
Shopee 店铺 Ads
Shopee Open Platform Ads 模块(23 个 API,不含即将下线的 auto product ads)。依赖 linkfox-shopee-store-auth;须目标店存在 appType=ad 授权。经 POST /shopee/developerProxy 传入 shopId(或 merchantId)+ api/v2/ads/... 路径,服务端自动走 AD 应用 Token(勿传 accessToken / appType)。
调用方式
- API 端点:
POST /shopee/developerProxy(不同操作通过请求体区分;完整参数/响应/错误码见references/api.md) - Python 脚本:
python scripts/<脚本名>.py '<JSON 参数>' [--inline](可用脚本见上文脚本一览) - 成本约束:本工具会消耗算力;失败/空结果不得自动换关键词、翻页或连续试探;需要继续检索时先向用户说明会产生额外消耗。
输出策略(脚本默认行为):
- 始终将完整响应写入
<cwd>/linkfox/<YYYY-MM-DD>/<session>/data/linkfox-shopee-store-ads-<timestamp>.json(<cwd>为脚本执行时的工作目录,在 Claude Code 里即当前项目目录;<session>取自环境变量SESSION_ID,按用户任务自动聚合;禁止写入 /tmp,当前目录不可写则报错) - 响应体 ≤ 8 KB:落盘后把完整 JSON 打印到 stdout
- 响应体 > 8 KB:落盘后 stdout 只输出摘要(顶层字段、常见计数如
total/costToken、最大列表字段的长度 + 前 3 条样本) - 加
--inline强制全量打印到 stdout(同样落盘)
读数据建议:先看摘要判断是否足够;需要具体字段时优先用 jq或ConvertFrom-Json 从保存的 json 文件按需抽取,避免整份 JSON 进入上下文。
解决认证和算力问题
发生以下异常情况时,采用 references/onboarding.md 引导解决问题:
异常情况
- 未配置API Key:环境变量未配置
LINKFOX_AGENT_API_KEY,也未配置LINKFOXAGENT_API_KEY。 - 响应401或402状态码
- 响应提示算力或余额不足:消息含"算力余额不足/计费不足/余额不足/quota exceeded/insufficient balance/套餐到期/需充值/请充值",或类似含义的内容。
官方参考
Ads 模块索引:v2.ads.get_total_balance
Prerequisites(必须先读)
- 运行
python scripts/check_auth_dependency.py;exit code 42 → 先安装linkfox-shopee-store-auth。 - 不要在本 skill 内实现授权/令牌逻辑;授权一律走 auth skill。
- 调用业务 API 之前,用 auth 的
authorized_stores.py确认目标店存在appType=ad:- 仅有
appType=erp(或历史空值)→ 不能当广告已授权;引导authorize_url.py且传appType=ad - 两项都缺 → 若用户只要广告,只开 AD 授权即可(不必先开 ERP)
- 仅有
- Ads API 还需 Shopee 侧开通广告能力;并非所有站点/店铺可用。
- 禁止向
developerProxy传accessToken或appType;path 用api/v2/ads/**即可由服务端路由到 AD。
Core Concepts
- AD 与 ERP 分离:广告 Token 与 ERP Token 独立;店铺在列表中存在 ≠ 广告已授权
- 转发链路:
developerProxy(shopId/merchantId+api/v2/ads/...,服务端注入 AD token)→ 紫鸟shopee-proxy/ad/...→ Shopee API - 余额:
get_total_balance查广告账户余额 - 手动商品广告:
create_manual_product_ads→edit_manual_product_ads/edit_manual_product_ad_keywords - 效果报表:
get_all_cpc_ads_*_performance、get_product_campaign_*_performance - GMS:
create_gms_product_campaign等系列 - 未纳入:
create_auto_product_ads、edit_auto_product_ads(官方标注 coming offline soon) - 联盟营销 AMS(module=127)→ 非本 skill
可用脚本(Ads 模块 23 个 API)
| 分组 | 脚本 |
|---|---|
| 账户/推荐 | get_total_balance.py、get_shop_toggle_info.py、get_recommended_keyword_list.py、get_recommended_item_list.py |
| CPC 效果 | get_all_cpc_ads_daily_performance.py、get_all_cpc_ads_hourly_performance.py |
| 商品广告 | create_manual_product_ads.py、edit_manual_product_ads.py、get_product_level_campaign_id_list.py 等 |
| GMS | create_gms_product_campaign.py、get_gms_campaign_performance.py 等 |
| 通用入口 | ads_api.py(JSON 含 api 字段) |
完整列表见 references/api.md。共享:_shopee_ads_common.py、_ads_endpoints.py、_ads_api_runner.py。
接口说明(按 API)
入参与响应细节放在 references/apis/,SKILL 只保留索引。
模块总览 / Feedback 见 references/api.md。
Usage Scenarios
0. 确认 AD 授权(每次任务开头)
- auth:
authorized_stores.py→ 找目标shopId且appType=ad - 缺失 → auth:
authorize_url.py传appType=ad,提示用户完成广告授权(URL 1 小时有效) - 完成后再进入下列业务场景;收到 1004 时优先怀疑缺 AD 授权,不要用 ERP 记录硬调
1. 查余额与推荐
get_total_balance.pyget_recommended_item_list.py/get_recommended_keyword_list.py
2. 创建手动商品广告
get_create_product_ad_budget_suggestion.pycreate_manual_product_ads.py传完整bodyget_product_campaign_daily_performance.py查效果
呼び出しの原則
appType=adを確認してから、スクリプトを呼び出してくださいdeveloperProxy.httpStatus/ゲートウェイのerrcodeを確認してから、*Responseフィールドを読み取ってください- GET:業務パラメーターは JSON のトップレベルに配置してください
- POST:複雑なインターフェースには
bodyを渡してください。create/edit では、重複を防ぐため、一意のreference_idを渡すことをおすすめします - 各スクリプトの docstring には 公式ドキュメントの URL(
module=117)が含まれています - 先に
storeTokensを呼び出して raw token を取得しないでください。また、proxy にaccessTokenを含めないでください
該当しない項目
- ストアの認証 →
linkfox-shopee-store-auth - 商品 listing →
linkfox-shopee-store-product - アフィリエイトマーケティング AMS(module=127)→
linkfox-shopee-store-ams - Amazon 広告 →
linkfox-amazon-ads-*シリーズ
計算リソースの消費ルール
計算リソースは消費しません。
フィードバック:
以下のいずれかに該当する場合は、フィードバック API を通じてフィードバックを自動検出して報告してください。
- このスキルで説明されている機能や目的が、実際の動作と一致しない
- スキルの結果がユーザーの意図と一致しない
- ユーザーがこのスキルへの不満や称賛を表明している
- 改善できると思われる点がある
references/api.md に記載された方法に従ってフィードバック API を呼び出してください。ユーザーの作業を中断しないでください。
高品質でプロフェッショナルな越境 EC スキルをお探しなら、LinkFox Skills をご覧ください。