model

package

v1.29.0 Latest Latest Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 10 Imported by: 59

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bububa/oceanengine

Links

Open Source Insights

Documentation ¶

Overview ¶

Package model 包含API所需结构体

Index ¶

func CredentialSign(req *http.Request, content []byte, privateKey *rsa.PrivateKey, ...) (string, error)
type AdVersion
type BaseResponse
- func (r BaseResponse) APIRequestID() string
- func (r BaseResponse) Error() string
- func (r BaseResponse) IsError() bool
type Bool
- func (b Bool) String() string
- func (bl *Bool) UnmarshalJSON(b []byte) (err error)
- func (b Bool) Value() bool
type ConversionRequest
type CursorInfo
type DateRange
type Float64
- func (f64 Float64) String(prec int) string
- func (f64 *Float64) UnmarshalJSON(b []byte) (err error)
- func (f64 Float64) Value() float64
type FloatRange
type Geolocation
type GetRequest
type Int
- func (i Int) String() string
- func (i *Int) UnmarshalJSON(b []byte) (err error)
- func (i Int) Value() int
type Int64
- func (i64 Int64) String() string
- func (i64 *Int64) UnmarshalJSON(b []byte) (err error)
- func (i64 Int64) Value() int64
type JSONInt
- func JSONIntFromInt(v int) JSONInt
- func (i JSONInt) MarshalJSON() ([]byte, error)
- func (i *JSONInt) UnmarshalJSON(b []byte) (err error)
- func (i JSONInt) Value() int
type JSONInt64
- func JSONInt64FromInt64(v int64) JSONInt64
- func (i64 JSONInt64) MarshalJSON() ([]byte, error)
- func (i64 *JSONInt64) UnmarshalJSON(b []byte) (err error)
- func (i64 JSONInt64) Value() int64
type JSONUint64
- func JSONUint64FromUint64(v uint64) JSONUint64
- func (u64 JSONUint64) MarshalJSON() ([]byte, error)
- func (u64 *JSONUint64) UnmarshalJSON(b []byte) (err error)
- func (u64 JSONUint64) Value() uint64
type OnOffInt
- func (i OnOffInt) String() string
- func (ooi *OnOffInt) UnmarshalJSON(b []byte) (err error)
- func (i OnOffInt) Value() int
type PageInfo
type PostRequest
type Response
type ReverseOnOffInt
- func (i ReverseOnOffInt) String() string
- func (ooi *ReverseOnOffInt) UnmarshalJSON(b []byte) (err error)
- func (i ReverseOnOffInt) Value() int
type TrackRequest
type Uint64
- func (u64 Uint64) String() string
- func (u64 *Uint64) UnmarshalJSON(b []byte) (err error)
- func (u64 Uint64) Value() uint64
type UnixTime
- func (ut UnixTime) Time() time.Time
- func (ut *UnixTime) UnmarshalJSON(b []byte) (err error)
- func (ut UnixTime) Value() int64
type UploadField
type UploadRequest

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CredentialSign ¶ added in v1.16.7

func CredentialSign(req *http.Request, content []byte, privateKey *rsa.PrivateKey, credential enum.Credential) (string, error)

CredentialSign implement ConvertionRequest interface

Types ¶

type AdVersion ¶ added in v1.9.17

type AdVersion int

const (
	AdVersion_DEFAULT AdVersion = 1
	AdVersion_2       AdVersion = 2
)

type BaseResponse ¶

type BaseResponse struct {
	// Message 返回信息
	Message string `json:"message"`
	// RequestID 请求的日志id，唯一标识一个请求
	RequestID string `json:"request_id,omitempty"`
	// Code 返回码
	Code int `json:"code"`
}

BaseResponse shared api response data fields

func (BaseResponse) APIRequestID ¶ added in v1.27.0

func (r BaseResponse) APIRequestID() string

APIRequestID implement Response interface

func (BaseResponse) Error ¶

func (r BaseResponse) Error() string

Error implement Response interface

func (BaseResponse) IsError ¶

func (r BaseResponse) IsError() bool

IsError implement Response interface

type Bool ¶ added in v1.15.5

type Bool bool

Bool support number/string in json

func (Bool) String ¶ added in v1.19.2

func (b Bool) String() string

func (*Bool) UnmarshalJSON ¶ added in v1.15.5

func (bl *Bool) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (Bool) Value ¶ added in v1.19.2

func (b Bool) Value() bool

type ConversionRequest ¶ added in v1.9.5

type ConversionRequest interface {
	PostRequest
	Sign(req *http.Request, content []byte) (string, error)
	GetAppAccessToken() string
}

ConversionRequest

type CursorInfo ¶ added in v1.28.2

type CursorInfo struct {
	// Cursor 下一次分页拉取的游标值
	Cursor string `json:"cursor,omitempty"`
	// Count
	Count int `json:"count,omitempty"`
	// HasMore 是否有下一页
	HasMore bool `json:"has_more,omitempty"`
}

CursorInfo 分页信息

type DateRange ¶ added in v1.20.0

type DateRange struct {
	StartTime string `json:"start_time,omitempty"`
	EndTime   string `json:"end_time,omitempty"`
}

DateRange 日期范围

type Float64 ¶ added in v1.9.13

type Float64 float64

Float64 support string quoted number in json

func (Float64) String ¶ added in v1.19.2

func (f64 Float64) String(prec int) string

func (*Float64) UnmarshalJSON ¶ added in v1.9.13

func (f64 *Float64) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (Float64) Value ¶ added in v1.19.2

func (f64 Float64) Value() float64

type FloatRange ¶

type FloatRange struct {
	Min float64
	Max float64
}

FloatRange 通用浮点数字范围

type Geolocation ¶

type Geolocation struct {
	// City 城市名
	City string `json:"city,omitempty"`
	// StreetNumber 街道号
	StreetNumber string `json:"street_number,omitempty"`
	// Street 街道名
	Street string `json:"street,omitempty"`
	// District 区域名
	District string `json:"district,omitempty"`
	// Province 省份名
	Province string `json:"province,omitempty"`
	// Name 地点名称
	Name string `json:"name,omitempty"`
	// Radius 半径
	Radius int64 `json:"radius,omitempty"`
	// Long 经度
	Long float64 `json:"long,omitempty"`
	// Lat 纬度
	Lat float64 `json:"lat,omitempty"`
}

Geolocation 地理位置信息

type GetRequest ¶

type GetRequest interface {
	// Encode encode request to string
	Encode() string
}

GetRequest get request interface

type Int ¶ added in v1.20.8

type Int int

Int support string quoted number in json

func (Int) String ¶ added in v1.20.8

func (i Int) String() string

func (*Int) UnmarshalJSON ¶ added in v1.20.8

func (i *Int) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (Int) Value ¶ added in v1.20.8

func (i Int) Value() int

type Int64 ¶ added in v1.9.13

type Int64 int64

Int64 support string quoted number in json

func (Int64) String ¶ added in v1.19.2

func (i64 Int64) String() string

func (*Int64) UnmarshalJSON ¶ added in v1.9.13

func (i64 *Int64) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (Int64) Value ¶ added in v1.19.2

func (i64 Int64) Value() int64

type JSONInt ¶ added in v1.20.8

type JSONInt int

JSONInt support string quoted number in json and marshal to string

func JSONIntFromInt ¶ added in v1.20.8

func JSONIntFromInt(v int) JSONInt

func (JSONInt) MarshalJSON ¶ added in v1.20.8

func (i JSONInt) MarshalJSON() ([]byte, error)

func (*JSONInt) UnmarshalJSON ¶ added in v1.20.8

func (i *JSONInt) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (JSONInt) Value ¶ added in v1.20.8

func (i JSONInt) Value() int

type JSONInt64 ¶ added in v1.19.2

type JSONInt64 int64

JSONInt64 support string quoted number in json and marshal to string

func JSONInt64FromInt64 ¶ added in v1.19.2

func JSONInt64FromInt64(v int64) JSONInt64

func (JSONInt64) MarshalJSON ¶ added in v1.19.2

func (i64 JSONInt64) MarshalJSON() ([]byte, error)

func (*JSONInt64) UnmarshalJSON ¶ added in v1.19.2

func (i64 *JSONInt64) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (JSONInt64) Value ¶ added in v1.19.2

func (i64 JSONInt64) Value() int64

type JSONUint64 ¶ added in v1.15.8

type JSONUint64 uint64

JSONUint64 support string quoted number in json and marshal to string

func JSONUint64FromUint64 ¶ added in v1.19.2

func JSONUint64FromUint64(v uint64) JSONUint64

func (JSONUint64) MarshalJSON ¶ added in v1.15.8

func (u64 JSONUint64) MarshalJSON() ([]byte, error)

func (*JSONUint64) UnmarshalJSON ¶ added in v1.15.8

func (u64 *JSONUint64) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (JSONUint64) Value ¶ added in v1.19.2

func (u64 JSONUint64) Value() uint64

type OnOffInt ¶ added in v1.9.39

type OnOffInt int

func (OnOffInt) String ¶ added in v1.19.2

func (i OnOffInt) String() string

func (*OnOffInt) UnmarshalJSON ¶ added in v1.9.39

func (ooi *OnOffInt) UnmarshalJSON(b []byte) (err error)

func (OnOffInt) Value ¶ added in v1.19.2

func (i OnOffInt) Value() int

type PageInfo ¶

type PageInfo struct {
	// Page 当前页码
	Page int `json:"page,omitempty"`
	// PageSize 每页item个数
	PageSize int `json:"page_size,omitempty"`
	// TotalNumber 总item个数
	TotalNumber Int64 `json:"total_number,omitempty"`
	// TotalPage 总页数
	TotalPage int `json:"total_page,omitempty"`
	// HasMore 是否有下一页
	HasMore int `json:"has_more,omitempty"`
	// Count 过滤后返回的视频数量，注意，此处的数量不一定与入参的count一致，因为存在过滤逻辑
	Count int `json:"count,omitempty"`
	// Cursor 下一次分页拉取的游标值
	Cursor int `json:"cursor,omitempty"`
}

PageInfo 通用翻页数据

type PostRequest ¶

type PostRequest interface {
	// Encode encode request to bytes
	Encode() []byte
}

PostRequest post request interface

type Response ¶

type Response interface {
	// IsError 是否返回错误
	IsError() bool
	// Error implement error interface
	Error() string
	// APIRequestID 返回请求ID
	APIRequestID() string
}

Response api response interface

type ReverseOnOffInt ¶ added in v1.13.7

type ReverseOnOffInt int

func (ReverseOnOffInt) String ¶ added in v1.19.2

func (i ReverseOnOffInt) String() string

func (*ReverseOnOffInt) UnmarshalJSON ¶ added in v1.13.7

func (ooi *ReverseOnOffInt) UnmarshalJSON(b []byte) (err error)

func (ReverseOnOffInt) Value ¶ added in v1.19.2

func (i ReverseOnOffInt) Value() int

type TrackRequest ¶ added in v1.16.7

type TrackRequest interface {
	ConversionRequest
	RequestURI() string
}

TrackRequest

type Uint64 ¶ added in v1.9.28

type Uint64 uint64

Uint64 support string quoted number in json

func (Uint64) String ¶ added in v1.19.2

func (u64 Uint64) String() string

func (*Uint64) UnmarshalJSON ¶ added in v1.9.28

func (u64 *Uint64) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implement json Unmarshal interface

func (Uint64) Value ¶ added in v1.19.2

func (u64 Uint64) Value() uint64

type UnixTime ¶ added in v1.25.4

type UnixTime int64

UnixTime support number/string in json

func (UnixTime) Time ¶ added in v1.25.4

func (ut UnixTime) Time() time.Time

func (*UnixTime) UnmarshalJSON ¶ added in v1.25.4

func (ut *UnixTime) UnmarshalJSON(b []byte) (err error)

func (UnixTime) Value ¶ added in v1.25.4

func (ut UnixTime) Value() int64

type UploadField ¶ added in v1.1.3

type UploadField struct {
	// Reader upload file reader
	Reader io.Reader
	// Key field key
	Key string
	// Value field value
	Value string
}

UploadField multipart/form-data post request field struct

type UploadRequest ¶ added in v1.1.3

type UploadRequest interface {
	// Encode encode request to UploadFields
	Encode() []UploadField
}

UploadRequest multipart/form-data reqeust interface

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
ad Package ad 广告计划相关API models	Package ad 广告计划相关API models
advertiser Package advertiser 账号服务相关API models	Package advertiser 账号服务相关API models
agent Package agent 代理商相关API models	Package agent 代理商相关API models
assets Package assets 资产相关API models	Package assets 资产相关API models
creativecomponent Package creativecomponent 创意组件相关API models	Package creativecomponent 创意组件相关API models
audiencepackage Package audiencepackage 定向包管理	Package audiencepackage 定向包管理
businessplatform Package businessplatform 纵横组织相关 API	Package businessplatform 纵横组织相关 API
campaign Package campaign 广告计划相关API models	Package campaign 广告计划相关API models
clue Package clue 青鸟线索通API models	Package clue 青鸟线索通API models
coupon Package coupon 线索通卡券组件管理 API models	Package coupon 线索通卡券组件管理 API models
form Package form 表单组件API models	Package form 表单组件API models
smartphone Package smartphone 智能电话组件 API models	Package smartphone 智能电话组件 API models
wechat Package wechat 微信加粉组件	Package wechat 微信加粉组件
conversion Package conversion 新版转换回传API models	Package conversion 新版转换回传API models
creative Package creative 广告创意模块API models	Package creative 广告创意模块API models
customercenter Package customercenter 管家账号相关API models	Package customercenter 管家账号相关API models
dmp Package dmp DMP人群管理API models	Package dmp DMP人群管理API models
customaudience Package customaudience 人群包相关API models	Package customaudience 人群包相关API models
datasource Package datasource 数据源相关API models	Package datasource 数据源相关API models
dpa Package dpa 商品广告相关API models	Package dpa 商品广告相关API models
duoplus Package duoplus Dou+ 投放能力	Package duoplus Dou+ 投放能力
enterprise Package enterprise 企业号相关 API	Package enterprise 企业号相关 API
comment
eventmanager Package eventmanager 资产 - 事件管理相关API models	Package eventmanager 资产 - 事件管理相关API models
auth Package auth 鉴权管理接口	Package auth 鉴权管理接口
v3 Package v3 体验版事件管理	Package v3 体验版事件管理
file Package file 素材管理相关API models	Package file 素材管理相关API models
rebate Package rebate 【代理】返点明点化素材数据	Package rebate 【代理】返点明点化素材数据
v3
fund
keyword Package keyword 关键词管理	Package keyword 关键词管理
v3
local Package local 本地推相关	Package local 本地推相关
aweme Package aweme 抖音号相关	Package aweme 抖音号相关
clue Package clue 本地推线索管理相关	Package clue 本地推线索管理相关
customaudience Package customaudience 人群包相关	Package customaudience 人群包相关
file Package file 本地推素材管理相关	Package file 本地推素材管理相关
poi Package poi 门店相关	Package poi 门店相关
product Package product 商品相关	Package product 商品相关
project Package project 项目管理模块	Package project 项目管理模块
promotion Package promotion 广告管理模块	Package promotion 广告管理模块
report Package report 本地推数据报表相关	Package report 本地推数据报表相关
majordomo Package majordomo 管家账号相关API models	Package majordomo 管家账号相关API models
oauth Package oauth OAuth授权相关API models	Package oauth OAuth授权相关API models
privativeword Package privativeword 包含否定词相关API models	Package privativeword 包含否定词相关API models
v3
qianchuan Package qianchuan 巨量千穿	Package qianchuan 巨量千穿
ad Package ad 广告计划	Package ad 广告计划
advertiser Package advertiser 账户信息获取	Package advertiser 账户信息获取
aweme Package aweme 千川授权抖音号相关API models	Package aweme 千川授权抖音号相关API models
brand
campaign Package campaign 广告组管理	Package campaign 广告组管理
carousel
creative Package creative 广告创意	Package creative 广告创意
dmp Package dmp DMP人群管理	Package dmp DMP人群管理
file Package file 素材管理API models	Package file 素材管理API models
finance Package finance 资金管理相关API	Package finance 资金管理相关API
live Package live 直播间相关API	Package live 直播间相关API
material Package material 广告素材管理	Package material 广告素材管理
product Package product 千川商品相关API models	Package product 千川商品相关API models
product/analyse Package analyse 商品竞争分析相关API	Package analyse 商品竞争分析相关API
report Package report 数据报表	Package report 数据报表
shop Package shop 店铺相关	Package shop 店铺相关
tools Package tools 查询工具	Package tools 查询工具
uni_promotion Package unipromotion 全域推广	Package unipromotion 全域推广
report Package report 数据报表相关API models	Package report 数据报表相关API models
asynctask Package asynctask 异步数据报表相关API Models	Package asynctask 异步数据报表相关API Models
asynctask/v3 Package asynctask 升级版异步数据报表相关API Models	Package asynctask 升级版异步数据报表相关API Models
audience Package audience 受众分析数据报表 API models	Package audience 受众分析数据报表 API models
liveroom Package liveroom 直播分析数据报表 API models	Package liveroom 直播分析数据报表 API models
v3 Package v3 体验版数据报表	Package v3 体验版数据报表
servemarket Package servemarket 应用市场相关 API Models	Package servemarket 应用市场相关 API Models
spda Package spda SPDA 相关API models	Package spda SPDA 相关API models
spi Package spi SPI推送相关API models	Package spi SPI推送相关API models
star Package star 巨量星图	Package star 巨量星图
star-ad-unite-task Package task 获取星广联投(星图版)任务	Package task 获取星广联投(星图版)任务
subscribe Package subscribe RDS订阅adv_id增删查	Package subscribe RDS订阅adv_id增删查
tools Package tools 工具相关API models	Package tools 工具相关API models
abtest Package abtest AB实验工具	Package abtest AB实验工具
adconvert Package adconvert 转化目标管理 API Models	Package adconvert 转化目标管理 API Models
adpreview Package adpreview 广告预览相关API models	Package adpreview 广告预览相关API models
adpreview/v3 Package v3 广告升级版预览相关API models	Package v3 广告升级版预览相关API models
adraise Package adraise 一键起量相关API	Package adraise 一键起量相关API
adraise/v3
appmanagement Package appmanagement 应用管理相关API	Package appmanagement 应用管理相关API
aweme Package aweme 抖音达人	Package aweme 抖音达人
clue Package clue 线索及建站工具API 相关models	Package clue 线索及建站工具API 相关models
comment Package comment 评论管理	Package comment 评论管理
creativeword Package creativeword 动态创意词包管理	Package creativeword 动态创意词包管理
diagnosis Package diagnosis 获取计划诊断信息	Package diagnosis 获取计划诊断信息
diagnosis/v3 Package v3 获取计划诊断信息体验版	Package v3 获取计划诊断信息体验版
interestaction Package interestaction 行为兴趣关键词管理	Package interestaction 行为兴趣关键词管理
keywordsbidratio Package keywordsbidratio 账户优词提量	Package keywordsbidratio 账户优词提量
landinggroup Package landinggroup 程序化落地页管理 API models	Package landinggroup 程序化落地页管理 API models
log Package log 工具-查询工具-日志查询API models	Package log 工具-查询工具-日志查询API models
nativeanchor Package nativeanchor 原生锚点	Package nativeanchor 原生锚点
quickappmanagement Package quickappmanagement 快应用管理相关 API	Package quickappmanagement 快应用管理相关 API
rta Package rta RTA策略管理	Package rta RTA策略管理
security Package security 风控违规积分	Package security 风控违规积分
site Package site 橙子建站落地页管理 API models	Package site 橙子建站落地页管理 API models
sitetemplate Package sitetemplate 橙子建站模版管理 API models	Package sitetemplate 橙子建站模版管理 API models
taskraise Package taskraise 账户优选起量 API models	Package taskraise 账户优选起量 API models
thirdsite Package thirdsite 第三方落地页管理API models	Package thirdsite 第三方落地页管理API models
union Package union 穿山流量相关	Package union 穿山流量相关
v3 Package v3 升级版相关	Package v3 升级版相关
video
wechat Package wechat 微信小程序/小游戏管理	Package wechat 微信小程序/小游戏管理
track Package track 数据上报管理相关API models	Package track 数据上报管理相关API models
v3 Package v3 广告投放体验版	Package v3 广告投放体验版
blueflow
project Package project 项目管理模块	Package project 项目管理模块
promotion Package promotion 广告管理模块相关API models	Package promotion 广告管理模块相关API models

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL