Releases: westng/oceanengine-sdk-php
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账户关系部分新增全域授权初始化接口说明
- 统一表格格式,提升文档可读性
- 完善接口调用方法说明
本版本专注于解决千川全域推广中的权限初始化问题,为开发者提供更稳定的商品投放体验。
3.0.3
🚀 Release v3.0.3 - 千川全域推广功能大幅增强
🚀 新增功能
新增模块:PCFullPromotion (千川 PC 全域推广)
全新增加了完整的千川 PC 全域推广管理模块,包含20个API接口,覆盖全域推广的完整生命周期。
主要功能包括:
- 计划管理: 创建、编辑、状态更新、列表查询、详情获取
- 素材管理: 获取、添加、删除全域推广计划下素材
- 商品管理: 获取、删除全域计划下商品
- 授权管理: 抖音号授权、达人/机构商品选择、商家商品选择
- 智能辅助: 预算建议、审核建议、排除素材列表
- 灵活配置: 名称更新、预算更新、ROI目标更新、投放时间更新
FreestylePushGlobal (随心推全域) 功能增强
新增2个接口,完善随心推全域订单管理功能:
- 追加随心推全域订单预算
- 获取随心推全域续费建议延长时长
📋 详细变更
新增接口列表
PCFullPromotion 模块 (20个接口):
QianchuanUniAwemeAdCreate- 新建全域推广计划QianchuanUniAwemeAdUpdate- 编辑全域推广计划QianchuanUniPromotionAdStatusUpdate- 更改全域推广计划状态QianchuanUniPromotionList- 获取全域推广列表QianchuanUniPromotionAdDetail- 获取全域推广计划详情QianchuanUniPromotionAdMaterialGet- 获取全域推广计划下素材QianchuanUniPromotionAdMaterialAdd- 添加全域推广计划下素材QianchuanUniPromotionAdMaterialDelete- 删除全域推广计划下素材QianchuanUniPromotionAdProductGet- 获取全域计划下商品列表QianchuanUniPromotionAdProductDelete- 删除全域计划下商品QianchuanUniAwemeAuthorizedGet- 获取可投全域推广抖音号列表QianchuanUniPromotionProductAwemeGet- 全域达人/机构获取可选商品列表QianchuanUniPromotionProductGet- 全域商家可选商品列表QianchuanUniPromotionBlockMaterialGet- 获取全域可排除抖音视频/图文列表QianchuanUniAwemeSuggestBudget- 获取全域建议预算QianchuanUniPromotionAdSuggestion- 获取全域计划审核建议QianchuanUniPromotionAdNameUpdate- 更新商品全域推广计划名称QianchuanUniPromotionAdBudgetUpdate- 更新全域推广计划预算QianchuanUniPromotionAdRoi2GoalUpdate- 更新全域推广控成本计划支付ROI目标QianchuanUniPromotionAdScheduleDateUpdate- 更新全域推广计划投放时间
FreestylePushGlobal 模块增强 (2个接口):
QianchuanAwemeUniPromotionOrderBudgetAdd- 追加随心推全域订单预算QianchuanAwemeUniPromotionOrderSuggestDeliveryTimeGet- 获取随心推全域续费建议延长时长
本版本为千川全域推广功能的重要里程碑,为开发者提供了完整的全域推广解决方案。
3.0.2
3.0.1
3.0.0
🚀 Release v3.0.0 - HTTP客户端升级与配置管理重构
✨ 主要特性
🌐 HTTP客户端现代化
- 从 cURL 迁移到 GuzzleHttp 7.0+:更现代、更强大的HTTP客户端
- 智能重试机制:支持HTTP状态码和业务错误码双重重试策略
- 中间件架构:重试、超时、日志中间件,提升系统健壮性
⚙️ 配置管理系统重构
- 灵活的配置方式:支持.env文件、系统环境变量、默认配置
- 自动配置加载:通过index.php自动加载所有配置
- 配置管理器:统一的配置管理API
🧪 测试文件现代化
- 自动加载优化:简化测试文件配置加载流程
- 向后兼容:保持所有现有API调用方式不变
🛠️ 技术改进
重试机制增强
- 可配置重试开关:支持动态启用/禁用重试机制
- 业务错误码重试:支持40100(频控)、40110(开发者频控)、50000(超时)等
- 客户端配置:通过OceanEngineClient对象直接配置重试参数
代码质量提升
- 方法名规范化:HttpRequest::curl() 重命名为 HttpRequest::request()
- 错误处理优化:更详细的异常信息和错误分类
📄 新增文档
- HTTP迁移指南:详细的cURL到GuzzleHttp迁移说明
- 配置管理指南:完整的配置系统使用说明
- 错误码说明:HTTP状态码和业务错误码处理指南
- 测试迁移指南:测试文件现代化改进说明
⚠️ 重要变更
破坏性变更
HttpRequest::curl()方法已重命名为HttpRequest::request()- 测试文件配置加载方式简化,只需加载
index.php
新增功能
OceanEngineClient::setRetryConfig()- 配置重试机制OceanEngineClient::setRetryEnabled()- 控制重试开关
📦 迁移指南
对于现有用户
- 更新依赖:运行
composer update安装 GuzzleHttp - 方法名更新:将
HttpRequest::curl()改为HttpRequest::request() - 测试文件简化:移除多余的 require_once 语句,只保留
require_once __DIR__ . '/../index.php'
对于新用户
- 配置环境:复制
env.example为.env并填入配置 - 使用新API:通过客户端对象配置重试机制
⚡ 性能提升
- 连接复用:GuzzleHttp支持HTTP/2和连接池
- 智能重试:减少因网络问题导致的API调用失败
- 配置优化:减少配置加载开销
感谢所有贡献者和用户的支持!(虽然还没有)这次重构为SDK带来了更现代、更强大的功能,同时保持了完全的向后兼容性。 🎉
2.0.0
🎉 Welcome To 2.0.0 🎉
💥 破坏性变更【重要警告】
⚠️ ⚠️ ⚠️
本次版本移除了所有旧版 API 类,且调用方式有较大调整。
升级到 2.0.0 后,请务必检查并重构调用代码,确保使用新的统一模块访问方式。
否则可能导致类找不到或接口调用失败。
请务必阅读最新文档,做好兼容性迁移准备。
✅ 当前发布亮点:
🚀 版本号升级
- 从 v1.0.5 直接跳到 2.0.0,进行了破坏性变更、结构性调整,这是符合 语义化版本规范(SemVer) 的做法。
🔧 改动内容
- 将通用模块抽离成公共文件
- 测试代码已更新,调整了调用示例以匹配最新 API 设计。
- 如出现找不到类(之前的错误),也可能与你更新或移除旧的 API 类有关。
✨ 新特性
- 新增巨量广告、本地推、星图API 点我查看文档
- 重构 API 模块加载机制
- 更简洁的调用方式(如
$client->module('模块名称')->AccountInfo->AdvertiserInfo()->setParams($args)->send())
🛠️ 修复
- 修复了部分测试代码无法调用的问题
📦 安装方式
composer require westng/oceanengine-sdk-php:^2.0