Java SDK使用指南
概述
巨量引擎开放平台 Marketing API(以下简称API) SDK 提供了Token获取、请求封装、响应解释等功能,以本地化方式轻松完成API的调用和结果的获取,旨在帮助开发者快速搭建投放管理系统。
本文以 Java-SDK 为例,介绍如何使用、调试并接入巨量引擎开放平台API能力
使用条件
- 使用SDK需要首先注册成为巨量引擎开发者,请参考开发者快速入门文档
- 使用SDK需要先拥有API的访问权限,所有SDK的使用与应用拥有的权限组相关联
安装
如果出现nosuchmethod报错请检查是否出现依赖冲突,可自行上网搜寻解决方案
jar包所在的maven仓库:https://artifact.bytedance.com/repository/releases/
代码所在仓库:https://github.com/oceanengine/ad_open_sdk_java
在项目的pom文件添加如下代码,即可获取最新的jar包
如果自己设置了镜像源(比如阿里云),导致拉取不到sdk,需要在maven的settings里做一点改动,!OceanengineOpenApi,如下(或者不使用第三方镜像源)
使用
sdk包结构
- api 目录下包含了生成的 api 调用代码逻辑、api client 以及中间件逻辑
- examples 目录中包含了每个接口的调用样例代码
- model 目录中包含每个接口的模型、枚举定义
配置
初始化client
可参考下面的代码初始化 client,并可修改 client 的属性
调用API接口
API 调用的方法名与API接口一一对应,如/open_api/v3.0/douplus/order/report/接口就对应DouplusOrderReportV30Api().openApiV30DouplusOrderReportGet()方法,以下为 接口的调用样例
其余的接口调用示例可参考 examples 目录下文件
通用接口调用
- 如果想使用 sdk 调用未生成代码的接口,可使用 CommonReqApi 接口进行调用
- 通用接口支持 Get Post 两种种方式调用
- Get 方法使用 queryParams 传入参数
- Post 方式使用 requestBody 传入参数
- 更多示例可参考 examples/commonReqApiExample.go
问题建议与反馈
如果您在使用SDK过程中有任何问题与建议,请随时登录开发者官网,点击右下角的"咨询"按钮,与我们的客服支持人员联系

