api

package
v0.0.0-...-85f63e2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 1, 2021 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const ApplicationJson = "application/json"

Variables

This section is empty.

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	Cfg *conf.AdConfig

	// api service
	CampaignApi   *CampaignApiService
	AdApi         *AdApiService
	CreativeApi   *CreativeApiService
	MaterialApi   *MaterialApiService
	ToolsApi      *ToolsApiService
	AdvertiserApi *AdvertiserApiService
	// contains filtered or unexported fields
}

func NewAPIClient 

func NewAPIClient(cfg *conf.AdConfig) *APIClient

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type AdApiService 

type AdApiService service

func (*AdApiService) Add 

func (a *AdApiService) Add(ctx context.Context, params models.AdAdAddReq) (models.AdAdAddRspData, http.Header, error)

func (*AdApiService) BudgetUpdate 

func (a *AdApiService) BudgetUpdate(ctx context.Context, advId int64, data []models.AdBudgetData) (models.AdBudgetUpdateRspData, http.Header, error)

通过此接口用于更新广告计划的预算； 一次可以处理100个计划 24小时内修改预算操作，不能超过20次，24小时是指自然天的24小时； 单次修改预算幅度不能低于100元（增加或者减少）； 修改后预算金额，不能低于当前已消费金额的105%，以整百单位向上取整；

func (*AdApiService) Get 

func (a *AdApiService) Get(ctx context.Context, advId int64, opts models.AdAdGetOpts) (models.AdAdGetRspData, http.Header, error)

func (*AdApiService) UpdateStatus 

func (a *AdApiService) UpdateStatus(ctx context.Context, advId int64, adIds []int64, status models.AdStatus) (models.AdStatusUpdateRspData, http.Header, error)

通过此接口可对计划做启用/暂停/删除操作； 一次可以处理100个计划 对于删除的计划不能再进行状态操作，否则会报错！ 如果有一个计划有问题，全部计划修改都不会成功！请确保传入的计划属于此广告主以及处于非删除状态。

type AdvertiserApiService 

type AdvertiserApiService service

func (*AdvertiserApiService) BudgetUpdate 

func (a *AdvertiserApiService) BudgetUpdate(ctx context.Context, params models.AdvertiserBudgetUpdateReq) (http.Header, error)

func (AdvertiserApiService) GetDailyBudget 

func (a AdvertiserApiService) GetDailyBudget(ctx context.Context, advIds []int64) (models.AdvertiserDailyBudgetRspData, http.Header, error)

type CampaignApiService 

type CampaignApiService service

func (*CampaignApiService) Add 

func (a *CampaignApiService) Add(ctx context.Context, params models.AdCampaignAddReq) (models.AdCampaignAddRspData, http.Header, error)

创建广告组 doc https://ad.oceanengine.com/openapi/doc/index.html?id=295

此接口用于创建信息流广告组，对于搜索广告的创建可参照【搜索广告投放】 每个广告主账号下最多可允许创建500个广告组，如超出需要先删除一部分广告组后才可继续创建； 当选择日预算类型时，日预算不少于300元； 24小时内修改预算操作，不能超过20次，24小时是指自然天的24小时； 单次修改预算幅度不能低于100元（增加或者减少）； 修改后预算金额，不能低于当前已消费金额的105%，以整百单位向上取整；

func (*CampaignApiService) Get 

func (a *CampaignApiService) Get(ctx context.Context, advId int64, opts models.AdCampaignGetOpts) (models.AdCampaignGetRspData, http.Header, error)
  获取广告组
  doc https://ad.oceanengine.com/open_api/2/campaign/get/
	当预算类型为不限，返回的预算为0.0元
	支持filtering过滤，可按广告组ID、推广目的、广告组状态进行过滤筛选
	默认不获取删除的广告组，如果要获取删除的广告组，可在filtering中传入对应的status值；
	对于搜索广告组信息获取参见【搜索广告投放】

type CreativeApiService 

type CreativeApiService service

func (*CreativeApiService) Add 

func (a *CreativeApiService) Add(ctx context.Context, params models.AdCreativeAddReq) (models.AdCreativeAddRspData, http.Header, error)

https://ad.oceanengine.com/openapi/doc/index.html?id=519

type MaterialApiService 

type MaterialApiService service

func (*MaterialApiService) GetVideo 

func (m *MaterialApiService) GetVideo(ctx context.Context, advId int64, opts models.MaterialVideoGetOpts) (models.MaterialVideoGetRspData, http.Header, error)

通过此接口，用户可以获取经过一定条件过滤后的广告主下创意素材库对应的视频及视频信息。 注意 为保证接口使用的安全性，避免调取他人的图片信息，该接口针对素材URL的字段仅查询自己广告主下的素材才会返回，即需查询的广告主账号的主体需与APPID对应开发者的主体保持一致，才可获取到素材的预览URL的信息，否则会提示：“素材所属主体与开发者主体不一致无法获取URL”(第三方获取敏感物料信息可在授权时申请广告主授权敏感物料权限，可参考常见问题【敏感物料授权】）！ 对素材视频进行过滤的时候，video_ids（视频ID）、material_ids（素材ID）、signatures（视频的md5值）只能选择一个进行过滤！ 获取视频素材数据目前仅支持10000个！ https://ad.oceanengine.com/openapi/doc/index.html?id=351

func (*MaterialApiService) GetVideoCover 

func (m *MaterialApiService) GetVideoCover(ctx context.Context, advId int64, videoId string) (models.MaterialVideoCoverGetRspData, http.Header, error)

通过此接口，用户可以获取针对素材视频推荐的智能封面。智能封面是通过提取视频关键帧筛选出推荐封面，帮助发现视频内优质封面素材。 推荐封面图片的数量是1-13个，对于相似度极高的封面图片会进行去重等处理，由实际的视频内容和时长决定。 注意 智能封面不是实时获取，而需要先根据status判断封面获取的状态，然后再进行获取视频封面！ 新上传素材存在同步延迟情况，建议等待2-3分钟再尝试操作获取视频智能封面！ https://ad.oceanengine.com/open_api/2/tools/video_cover/suggest/

func (*MaterialApiService) PushMaterial 

func (m *MaterialApiService) PushMaterial(ctx context.Context, params models.MaterialPushReq) (models.MaterialPushRspData, http.Header, error)

通过此接口，用户可以进行同主体下不同广告主间的素材的推送。也就是说，将A广告主素材推送到，与A广告主主体（公司）相同的广告主。 注意 推送后素材的名称不会改变，将使用推送的原素材名！ 新上传素材存在同步延迟情况，建议等待2-3分钟再尝试操作推送！ 当素材已存在待推送的广告主的素材库内时，不会重复推送，推送失败的结果会在推送失败列表展示！ https://ad.oceanengine.com/openapi/doc/index.html?id=1458

func (*MaterialApiService) UploadImage 

func (m *MaterialApiService) UploadImage(ctx context.Context, params models.MaterialImageAddReq) (models.MaterialImageAddRspData, http.Header, error)

通过此接口，用户可以上传和广告相关的素材图片，例如创意素材。 图片格式：jpg、jpeg、png、bmp、gif，大小1.5M内 注意 上传的图片一定要符合格式，才会在投放平台素材库显示！ 若同一素材已进行上传，重新上传不会改名！ https://ad.oceanengine.com/openapi/doc/index.html?id=331

func (*MaterialApiService) UploadVideo 

func (m *MaterialApiService) UploadVideo(ctx context.Context, params models.MaterialVideoAddReq) (models.MaterialVideoAddRspData, http.Header, error)

通过此接口，用户可以上传和广告相关的素材视频。 视频格式：mp4、mpeg、3gp、avi 注意 视频设置了10s限制，超时会报错！ 若同一素材已进行上传，重新上传不会改名！ https://ad.oceanengine.com/openapi/doc/index.html?id=332

type SwaggerError 

type SwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func NewApiSwaggerError 

func NewApiSwaggerError(code int, body []byte, msg string, requestId string) SwaggerError

func (SwaggerError) Body 

func (e SwaggerError) Body() []byte

func (SwaggerError) Code 

func (e SwaggerError) Code() int

func (SwaggerError) Error 

func (e SwaggerError) Error() string

func (SwaggerError) Message 

func (e SwaggerError) Message() interface{}

func (SwaggerError) RequestId 

func (e SwaggerError) RequestId() string

type ToolsApiService 

type ToolsApiService service

func (*ToolsApiService) GetActionText 

func (t *ToolsApiService) GetActionText(ctx context.Context, advId int64, LandingType string, opts models.ToolsActionTextGetOpts) ([]string, http.Header, error)

获取行动号召字段内容，注意：结合附加创意类型以及广告主行业参数可以查询出更多细纬度的行动号召内容。 https://ad.oceanengine.com/openapi/doc/index.html?id=1366

func (*ToolsApiService) GetAdDiagnosis 

func (t *ToolsApiService) GetAdDiagnosis(ctx context.Context, advId int64, adIds []int64) (models.ToolsAdDiagnosisRspData, http.Header, error)

查询计划的广告质量度，只有产生过投放消耗的计划才会有质量度数据。

func (*ToolsApiService) GetAdLearnStat 

func (t *ToolsApiService) GetAdLearnStat(ctx context.Context, advId int64, adIds []int64) ([]models.ToolsAdStatExtraInfoRspData, http.Header, error)

获取广告计划学习期状态。关于学习期 最多传100个广告计划id。 https://ad.oceanengine.com/openapi/doc/index.html?id=1664566788147212

func (*ToolsApiService) GetAdQuality 

func (t *ToolsApiService) GetAdQuality(ctx context.Context, advId int64, adIds []int64) (models.ToolsAdQualityRspData, http.Header, error)

查询计划的广告质量度，只有产生过投放消耗的计划才会有质量度数据。

func (*ToolsApiService) GetIndustry 

func (t *ToolsApiService) GetIndustry(ctx context.Context, advId int64, opts models.ToolsIndustryGetOpts) ([]models.ToolsIndustryGetRspDataList, http.Header, error)

获取行业列表，通过接口可以获取到一级行业、二级行业、三级行业列表，其中代理商创建广告主时使用的是二级行业，而在创建创意填写创意分类时使用的是三级行业，请注意区分。 https://ad.oceanengine.com/openapi/doc/index.html?id=370

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.