Releases: whalesky-labs/oceanengine-sdk-php
4.0.3
4.0.2
4.0.1
1.0.6
What's Changed
Full Changelog: 4.0.2...1.0.6
4.0.0
OceanEngine SDK PHP 4.0 发布说明
4.0 是一次面向稳定性、可维护性和工程化能力的升级版本。
这一版重点不在单个接口新增,而在 SDK 核心能力重构,包括请求链路、运行时适配、错误处理、测试体系和上传能力加固,目标是让 SDK 更适合在真实生产环境中长期使用。
核心升级
- 全面统一 PHP 8.0+ 类型声明与接口签名
- 重构 OceanEngineClient、RpcRequest、RequestInterface、ChainProxy 等核心调用链
- 优化模块发现与动态代理机制,提升稳定性和可维护性
- 补强异常体系,HTTP/业务错误信息更清晰
HTTP 与运行时能力增强
- 支持 FPM / CLI / Swoole 多运行环境自适配
- HTTP 重试配置调整为客户端实例级隔离,避免多实例并发时相互污染
- 新增 TLS verify 配置能力
- 默认启用证书校验,提升生产环境安全性
- 修复 JSON 编码失败、请求异常映射不一致等问题
上传能力加固
- 强化 multipart/form-data 文件上传处理
- 支持 @/path/to/file 与 \CURLFile 两种文件传参方式
- 为“上传视频素材”补充更严格的本地参数校验:
- upload_type
- video_file
- video_signature
- video_url
- 文件不存在、不可读、MD5 非法等问题会在 SDK 本地直接拦截,而不是把坏请求发到服务端
测试体系升级
- 新增并完善大量单元测试与集成测试
- 集成测试按模块补齐 smoke test,支持按文件执行
- 测试输出统一中文化,排查更直接
- 新增 HTTP、OAuth、异常、请求校验、上传链路等覆盖
文档与工程化改进
- README 大幅更新
- 新增/补充 CONFIG_GUIDE.md、HTTP_MIGRATION.md、TEST_MIGRATION.md
- 补充 env.example
- 增加 CI、Issue Template、Dependabot 等工程配置
升级提示
- 需要 PHP >= 8.0
- 建议重点关注:
- TLS 校验默认开启
- 文件上传请求请使用 multipart/form-data
- 部分请求参数校验变严格,历史上“勉强能过”的调用方式在 4.0 中会直接报本地异常
总结
4.0 不是简单的接口补充版本,而是一次 SDK 底层能力和工程体系的系统升级。
如果你在生产环境中使用 OceanEngine PHP SDK,这一版会带来更稳定的请求行为、更明确的错误反馈,以及更可依赖的测试与维护基础。
3.0.8
🚀 Release v3.0.8 - 升级版工作台接口能力扩展与资产管理迁移
✨ 新增功能
新增接口:升级版工作台(EBP)能力
本版本围绕「升级版工作台」新增三大模块接口能力,并统一采用 /v3.0/... 路径(不包含 open_api 前缀):
- JuLiangAds / ProductManagement / WorkspaceUpgrade:新增 15 个商品库相关接口
- Tools / ByteMiniAppManagement / WorkspaceUpgrade:新增 14 个字节/微信小程序与小游戏接口
- Tools / AppManagement / WorkspaceUpgrade:新增 8 个安卓应用相关接口
🔧 架构调整
- 修正 JuLiangAds\ProductManagement\WorkspaceUpgrade 子模块命名空间,确保模块可正常路由
- 增强动态子模块调用能力:
- ByteMiniAppManagement->WorkspaceUpgrade()
- AppManagement->WorkspaceUpgrade()
🧪 测试与验证
- 新增可执行测试脚本:
- tests/Api/JuLiangAds/ProductManagement/WorkspaceUpgrade/DpaLibraryList.php
- 新增/修改 PHP 文件均已通过 php -l 语法检查
- 动态调用链已实测可实例化:
- AppManagement->WorkspaceUpgrade()->ToolsEbpAppList()
- ByteMiniAppManagement->WorkspaceUpgrade()->ToolsEbpMicroAppletList()
———
📋 详细变更
1) JuLiangAds / ProductManagement / WorkspaceUpgrade(15个)
| 接口类 | 方法 | API 路径 |
|---|---|---|
| DpaPlayletAuthGet | GET | /v3.0/dpa/ebp/playlet/auth/get/ |
| DpaDictGet | GET | /v3.0/dpa/ebp/dict/get/ |
| DpaCategoryGet | GET | /v3.0/dpa/ebp/category/get/ |
| DpaClueProductGet | GET | /v3.0/dpa/ebp/clue_product/get/ |
| DpaProductDetailGet | GET | /v3.0/dpa/ebp/product/detail/get/ |
| DpaProductList | GET | /v3.0/dpa/ebp/product/list/ |
| DpaMetaGet | GET | /v3.0/dpa/ebp/meta/get/ |
| DpaLibraryList | GET | /v3.0/dpa/ebp/library/list/ |
| DpaClueProductList | GET | /v3.0/dpa/ebp/clue_product/list/ |
| DpaClueProductDelete | POST | /v3.0/dpa/ebp/clue_product/delete/ |
| DpaProductStatusBatchUpdate | POST | /v3.0/dpa/ebp/product_status/batch_update/ |
| DpaProductDelete | POST | /v3.0/dpa/ebp/product/delete/ |
| DpaProductUpdate | POST | /v3.0/dpa/ebp/product/update/ |
| DpaClueProductSave | POST | /v3.0/dpa/ebp/clue_product/save/ |
| DpaProductCreate | POST | /v3.0/dpa/ebp/product/create/ |
2) Tools / ByteMiniAppManagement / WorkspaceUpgrade(14个)
| 接口类 | 方法 | API 路径 |
|---|---|---|
| ToolsEbpMicroAppletList | GET | /v3.0/tools/ebp/micro_applet/list/ |
| ToolsEbpMicroAppletLinkList | GET | /v3.0/tools/ebp/micro_applet/link/list/ |
| ToolsEbpMicroAppletCreate | POST | /v3.0/tools/ebp/micro_applet/create/ |
| ToolsEbpMicroAppletUpdate | POST | /v3.0/tools/ebp/micro_applet/update/ |
| ToolsEbpWechatAppletList | GET | /v3.0/tools/ebp/wechat_applet/list/ |
| ToolsEbpWechatGameList | GET | /v3.0/tools/ebp/wechat_game/list/ |
| ToolsEbpWechatAppletCreate | POST | /v3.0/tools/ebp/wechat_applet/create/ |
| ToolsEbpWechatAppletUpdate | POST | /v3.0/tools/ebp/wechat_applet/update/ |
| ToolsEbpWechatGameCreate | POST | /v3.0/tools/ebp/wechat_game/create/ |
| ToolsEbpWechatGameUpdate | POST | /v3.0/tools/ebp/wechat_game/update/ |
| ToolsEbpMicroGameList | GET | /v3.0/tools/ebp/micro_game/list/ |
| ToolsEbpMicroGameLinkList | GET | /v3.0/tools/ebp/micro_game/link/list/ |
| ToolsEbpMicroGameCreate | POST | /v3.0/tools/ebp/micro_game/create/ |
| ToolsEbpMicroGameUpdate | POST | /v3.0/tools/ebp/micro_game/update/ |
3) Tools / AppManagement / WorkspaceUpgrade(8个)
| 接口类 | 方法 | API 路径 |
|---|---|---|
| ToolsEbpAppList | GET | /v3.0/tools/ebp/app/list/ |
| ToolsEbpAppDetail | GET | /v3.0/tools/ebp/app/detail/ |
| ToolsEbpAppExtendList | GET | /v3.0/tools/ebp/app_extend/list/ |
| ToolsEbpAppPublish | POST | /v3.0/tools/ebp/app/publish/ |
| ToolsEbpAppUpdate | POST | /v3.0/tools/ebp/app/update/ |
| ToolsEbpAppGameBookList | GET | /v3.0/tools/ebp/app_game_book/list/ |
| ToolsEbpAppExtendCreate | POST | /v3.0/tools/ebp/app_extend/create/ |
| ToolsEbpAppExtendUpdate | POST | /v3.0/tools/ebp/app_extend/update/ |
4) 文档更新
- docs/JULIANGADS.md:补全 ProductManagement 基础接口与 WorkspaceUpgrade 调用说明
- docs/TOOLS.md:补全
- AppManagement / WorkspaceUpgrade 接口清单
- ByteMiniAppManagement / WorkspaceUpgrade 接口清单
———
本版本重点完成升级版工作台接口能力扩展,并将商品库、应用、小程序/小游戏相关资产管理能力补齐到 EBP 维度,提升 SDK 在新工作台体系下的可用性与一致性。
3.0.7
🚀 Release v3.0.7 - 全域计划调控工具与事件管理增强
✨ 新增功能
新增接口:全域计划调控工具
新增五个千川全域计划调控工具接口,完善直播投放调控能力。
主要功能:
- 调控任务管理: 支持修改调控任务设置、预算、投放时长
- 一键控量计划: 支持创建直播一键控量计划,快速调控直播间投放
- 调控状态管理: 支持修改一键控量计划的调控状态
🐛 问题修复
修复事件管理接口 URL 路径错误
修复巨量广告资产-事件管理模块 5 个接口的 URL 路径配置错误,确保接口正常调用。
🧪 测试用例
新增事件管理资产接口测试
为事件管理资产模块新增 5 个接口测试用例,提升代码质量保障。
📋 详细变更
新增接口列表
GlobalPlanningTool 模块增强 (5 个接口):
| 接口名称 | 说明 |
|---|---|
QianChuanAdControlTaskUpdate |
修改调控任务设置 |
QianChuanAdControlTaskBudgetUpdate |
修改调控任务预算 |
QianChuanAdControlTaskDurationUpdate |
修改调控任务投放时长 |
QianChuanAdControlTaskSmartControlCreate |
创建直播-一键控量计划 |
QianChuanAdControlTaskSmartControlStatusUpdate |
修改直播-一键控量计划调控状态 |
接口详情
修改调控任务设置
- API 路径:
/v1.0/qianchuan/ad_control_task/update/ - 请求方法:
POST - 适用场景: 修改已创建的调控任务配置
修改调控任务预算
- API 路径:
/v1.0/qianchuan/ad_control_task/budget/update/ - 请求方法:
POST - 适用场景: 调整调控任务的预算设置
修改调控任务投放时长
- API 路径:
/v1.0/qianchuan/ad_control_task/duration/update/ - 请求方法:
POST - 适用场景: 调整调控任务的投放时长
创建直播-一键控量计划
- API 路径:
/v1.0/qianchuan/ad_control_task/smart_control/create/ - 请求方法:
POST - 适用场景: 快速创建直播间一键控量计划
修改直播-一键控量计划调控状态
- API 路径:
/v1.0/qianchuan/ad_control_task/smart_control/status/update/ - 请求方法:
POST - 适用场景: 开启或关闭一键控量计划
修复接口列表
Events 事件管理模块 (5 个接口 URL 修复):
| 接口名称 | 说明 |
|---|---|
EventManagerShareGet |
事件管理资产查看共享范围 |
EventManagerDeepBidTypeGet |
获取可用深度优化方式 |
EventManagerOptimizedGoalGetV2 |
获取可用优化目标 |
EventManagerShare |
事件管理资产共享 |
EventManagerShareCancel |
事件管理资产取消共享 |
文档更新
docs/TOOLS.md文档优化:更新 GlobalPlanningTool 接口列表,修正接口调用方法名称
本版本专注于增强千川全域计划调控能力,同时修复事件管理接口问题并补充测试用例,提升 SDK 稳定性和开发体验。
3.0.6
🚀 Release v3.0.6 - 千川全域推广授权与店铺管理
✨ 新增功能
新增接口:千川全域推广授权与店铺管理功能
新增两个千川全域推广接口,完善授权申请和店铺管理能力。
主要功能:
- 全域推广授权申请: 支持广告主申请全域推广授权,开启全域推广能力
- 可授权店铺查询: 支持获取商品全域可授权店铺列表,便于店铺授权管理
- 授权管理增强: 为千川全域推广提供完整的授权管理流程支持
📋 详细变更
新增接口列表
PCFullPromotion 模块增强 (2 个接口):
QianchuanUniPromotionAuthorizationApply- 广告主申请全域推广授权QianchuanUniPromotionAuthorizableShopList- 获取商品全域可授权店铺列表
接口详情:
-
广告主申请全域推广授权
- API 路径:
/v1.0/qianchuan/uni_promotion/authorization/apply/ - 请求方法: POST
- 内容类型: application/json
- 必填参数: advertiser_id (广告主 ID)
- 适用场景: 千川全域推广授权申请
- API 路径:
-
获取商品全域可授权店铺列表
- API 路径:
/v1.0/qianchuan/uni_promotion/authorizable_shop/list/ - 请求方法: GET
- 内容类型: application/json
- 必填参数: advertiser_id (广告主 ID)
- 适用场景: 查询可授权店铺列表,进行店铺授权管理
- API 路径:
文档更新
JULIANGQIANCHUAN.md 文档优化:
- 在 PCFullPromotion 千川全域推广章节新增两个接口说明
- 完善接口调用方法文档,提升开发者使用体验
- 保持与其他模块文档风格一致
本版本专注于增强千川全域推广的授权管理能力,为开发者提供完整的授权申请和店铺管理功能。
3.0.5
🚀 Release v3.0.5 - 随心推全域订单数据与素材管理
✨ 新增功能
新增接口:随心推全域订单数据与素材查询功能
新增两个随心推全域接口,完善订单数据查询和素材管理能力。
主要功能:
- 订单数据查询: 支持获取随心推全域订单数据,当前仅支持商品全域订单
- 素材列表管理: 支持获取随心推全域订单下的素材列表,便于素材追踪
- 数据分析增强: 为随心推全域推广提供更全面的数据分析支持
📋 详细变更
新增接口列表
FreestylePushGlobal 模块增强 (2个接口):
QianchuanAwemeUniPromotionOrderReportGet- 获取随心推全域订单数据QianchuanAwemeUniPromotionAdMaterialGet- 获取随心推全域订单下素材列表
接口详情:
-
获取随心推全域订单数据
- API路径:
/v1.0/qianchuan/aweme/uni_promotion/order/report/get/ - 请求方法: GET
- 内容类型: application/json
- 必填参数: advertiser_id (广告主ID)
- 适用场景: 商品全域订单数据查询
- API路径:
-
获取随心推全域订单下素材列表
- API路径:
/v1.0/qianchuan/aweme/uni_promotion/ad/material/get/ - 请求方法: GET
- 内容类型: application/json
- 必填参数: advertiser_id (广告主ID)
- 适用场景: 商品全域订单素材管理
- API路径:
文档更新
JULIANGQIANCHUAN.md 文档优化:
- 在 FreestylePushGlobal 随心推全域章节新增两个接口说明
- 完善接口调用方法文档,提升开发者使用体验
- 保持与其他模块文档风格一致
本版本专注于增强随心推全域推广的数据查询能力,为开发者提供更完整的订单数据分析和素材管理功能。
3.0.4
🚀 Release v3.0.4 - 千川全域授权初始化功能
✨ 新增功能
新增接口:QianChuanUniPromotionAuthInit (全域授权初始化)
新增千川全域授权初始化接口,解决商品投放权限问题。
主要功能:
- 权限初始化: 解决部分在拉取达人/机构广告主可投的商品列表时返回商品不可投的问题
- 全域推广权限: 为当前账户获取使用抖音号投放所选商品的全域推广权限
- 频率控制: 每个广告主在10分钟内仅可调用一次,防止接口滥用
📋 详细变更
新增接口列表
AccountRel 模块增强 (1个接口):
QianChuanUniPromotionAuthInit- 全域授权初始化
接口详情:
- API路径:
/v1.0/qianchuan/uni_promotion/auth/init/ - 请求方法: POST
- 内容类型: application/json
- 支持平台: 巨量千川
- 调用限制: 每个广告主10分钟内仅可调用一次
文档更新
ACCOUNT.md 文档优化:
- 在AccountRel账户关系部分新增全域授权初始化接口说明
- 统一表格格式,提升文档可读性
- 完善接口调用方法说明
本版本专注于解决千川全域推广中的权限初始化问题,为开发者提供更稳定的商品投放体验。