Download the PHP package westng/oceanengine-sdk-php without Composer

On this page you can find all versions of the php package westng/oceanengine-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package oceanengine-sdk-php

OceanEngine SDK for PHP

OceanEngine SDK for PHP

巨量引擎开放平台 PHP SDK

🚀 巨量引擎开放平台 PHP SDK - 为 PHP 开发者提供完整的巨量引擎 API 集成解决方案

PHP >= 8.1 Composer package Guzzle 7.x

📖 概述

在技术蓬勃发展的当下,巨量引擎开放平台的 Marketing API SDK,本应是普惠所有开发者的得力工具,涵盖巨量广告、巨量千川、巨量本地推、巨量星图及企业号相关功能,从 Token 获取到请求封装、响应解释,每个环节都暗藏助力高效开发的玄机。

其本地化设计,理应为开发者开辟便捷通道,无论经验如何,都能借它在 API 调用之路上畅行无阻。可现实却令人咋舌,面对 PHP 这片高手云集、活力满满的领域,官方竟然缺失 PHP 版本的 SDK!

这简直荒谬至极。PHP 开发者们为互联网立下汗马功劳,如今却像被抛弃的孩子。看着其他语言开发者仗着官方 SDK 大步快跑,自己只能徒手在荆棘中挣扎,太不公平!好比马拉松赛场,别人装备精良、补给充足,自己却赤脚前行、无水可饮。

幸有补救性 SDK,让 PHP 开发者不至于掉队,能凭本事搭起投放管理系统,但背后是他们付出的诸多额外心血。官方这种"偏心"做法,实在该反省,给 PHP 开发者们一个交代!

✨ 特性

🚀 快速开始

环境要求

安装

基础使用

📋 使用条件

运行环境自适配

开发者条件

📁 项目结构

📚 详细使用指南

1. 用户授权(获取 Access Token)

获取授权 URL

参数 说明 默认值 示例值
cb_url 回调链接 - https://xxx.xxx.xxx
scope 授权范围(全部权限 null 即可) - -
state 自定义参数 your_custom_params -
type 授权类型 QC QC|AD

获取 Access Token

2. API 调用

配置重试机制

参数 说明 默认值 示例值
maxRetries 最大重试次数 3 5
retryDelay 重试延迟(毫秒) 1000 2000
retryableStatusCodes 可重试 HTTP 状态码 [408, 429, 500, 502, 503, 504] [408, 429, 500]
enableRetry 是否启用重试 true false
retryableBusinessCodes 可重试业务错误码 [40100, 40110, 50000] [40100, 50000]

说明:重试与超时配置只作用于当前 OceanEngineClient 实例,多实例并发互不影响。

补充说明:当请求参数中包含本地文件上传(例如 @/path/to/file 或 \CURLFile)时,SDK 会自动禁用该次请求的重试机制,避免 multipart/form-data 请求体在重试时无法重放而掩盖首次真实错误。普通 JSON、表单和纯 URL 上传请求仍按当前客户端的重试配置执行。

配置 TLS 证书校验

方法参数 说明 示例
enabled 是否启用证书校验 true / false
caPath CA 证书路径(仅 enabled=true 时生效) /etc/ssl/custom-ca.pem

文件上传请求

对于素材、资质、券码等文件上传接口,不要使用 application/json 传本地文件。SDK 支持以下两种文件参数写法,并会自动按 multipart/form-data 发送:

也支持:

其中 FileVideoAd 在 UPLOAD_BY_FILE 模式下必须传 video_file 和 video_signature;在 UPLOAD_BY_URL 模式下必须传 video_url。

当使用本地文件上传时,SDK 会自动关闭当前请求的重试,以避免网络重试阶段因请求体无法 rewind 而产生额外错误;如果是 UPLOAD_BY_URL,则仍沿用当前客户端的重试配置。

说明:

获取广告主信息

🔧 配置说明

环境变量配置

创建 .env 文件:

配置优先级

  1. 系统环境变量 (最高优先级)
  2. .env 文件
  3. 默认配置 (最低优先级)

🚨 错误处理

SDK 提供了完善的错误处理机制:

📊 开发进度

模块 链式调用 状态 文档
账户管理 $client->Account() ✅ 已完成 查看文档
素材管理 $client->Materials() ✅ 已完成 查看文档
数据报表 $client->DataReports() ✅ 已完成 查看文档
工具 $client->Tools() ✅ 已完成 查看文档
巨量广告 $client->JuLiangAds() ✅ 已完成 查看文档
巨量千川 $client->JuLiangQianChuan() ✅ 已完成 查看文档
巨量星图 $client->JuLiangStarMap() ✅ 已完成 查看文档
巨量本地推 $client->JuLiangLocalPush() ✅ 已完成 查看文档
企业号 $client->EnterpriseAccount() ⏳ 未开始 -

⚠️ 上述进度仅供参考,实际以源码为准。
🧠 欢迎查看源码深入探索,接口比文档更诚实!

📚 相关文档

🤝 贡献指南

欢迎提交 Issue 和 Pull Request。开始修改前请先阅读 AGENTS.md,并遵循以下简要规范。

1 分支规范

2 提交信息规范(Conventional Commits)

提交格式:

常用 type:

示例:

3 更新日志规范

4 提交前检查

5 Pull Request 要求

📄 开源协议

本项目采用 MIT 协议 - 查看 LICENSE 文件了解详情。

📞 问题反馈

如在使用过程中遇到问题、建议或灵感……请无视(开玩笑的)。

📨 实在憋不住可以提 Issue 或 PR ~


如果这个项目对您有帮助,请给个 ⭐️ 支持一下!

Made with ❤️ by westng


All versions of oceanengine-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package westng/oceanengine-sdk-php contains the following files

Loading the files please wait ...