Go SDK使用指南
概述
巨量引擎开放平台 Marketing API(以下简称API) SDK 提供了Token获取、请求封装、响应解释等功能,以本地化方式轻松完成API的调用和结果的获取,旨在帮助开发者快速搭建投放管理系统。
本文以 Go-SDK 为例,介绍如何使用、调试并接入巨量引擎开放平台API能力
使用条件
- 使用SDK需要首先注册成为巨量引擎开发者,请参考开发者快速入门文档
- 使用SDK需要先拥有API的访问权限,所有SDK的使用与应用拥有的权限组相关联
安装
github地址:https://github.com/oceanengine/ad_open_sdk_go
使用
sdk包结构
- client.go 为 sdk 的入口文件,包含 sdk 的初始化以及 api 对象获取函数
- api 目录下包含了生成的 api 调用代码逻辑、api client 以及中间件逻辑
- config 目录包含sdk配置结构的声明
- example 目录中包含了每个接口的调用样例代码
- middleware 目录中包含默认中间件逻辑
- models 目录中包含每个接口的模型、枚举定义
配置
使用默认配置
配置定义如下
初始化client
可参考下面的代码初始化 client,并可修改 client 的属性
自定义中间件
需要实现如下函数
可参考默认中间件的实现
获取Access Token
注:本示例适用于授权时通过Authorization Code获取Access Token和Refresh Token,如需更新Access Token请参考 ./examples/oauth2_refresh_token_example.go 示例
调用接口
在请求参数内给app_id、secret、auth_code进行赋值,并调用接口即可获得access_token
调用API接口
API 调用的方法名与API接口一一对应,如/open_api/v3.0/project/list/接口就对应ProjectListV30Api().Get()方法,以下为 project/list 接口的调用样例
其余的接口调用示例可参考 examples 目录下文件
通用接口调用
- 如果想使用 sdk 调用未生成代码的接口,可使用 CommonApi 接口进行调用
- 通用接口支持 Get Post PostMultipart 三种方式调用
- Get 方法使用 RequestQuery 方法传入参数
- Post 方式使用 RequestBody 方法传入参数
- PostMultipart 方法使用 RequestForm 方法传入参数, RequestFile 方法传入文件
- 更多示例可参考 examples/common_api_example.go
问题建议与反馈
如果您在使用SDK过程中有任何问题与建议,请随时登录开发者官网,点击右下角的'咨询'按钮,与我们的客服支持人员联系

