Documentation ¶
Overview ¶
Package ad 广告计划
Index ¶
- func CompensateStatusGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]ad.CompensateStatus, error)
- func Create(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.CreateResult, error)
- func DetailGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.Ad, error)
- func EstimateEffect(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.EstimateEffectResult, error)
- func Get(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.GetResponseData, error)
- func KeywordCheck(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.KeywordCheckData, error)
- func KeywordPackageGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]ad.WordPackage, error)
- func KeywordsGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.KeywordsGetResult, error)
- func KeywordsUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) error
- func LearningStatusGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]ad.LearningStatus, error)
- func LqAdGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]uint64, error)
- func MaterialDelete(ctx context.Context, clt *core.SDKClient, accessToken string, ...) error
- func MaterialGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.MaterialGetResult, error)
- func PrivatewordsGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.PrivateWords, error)
- func PrivatewordsUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.PrivatewordsUpdateResult, error)
- func QuotaGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.QuotaGetResult, error)
- func RecommendKeywordsGet(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.RecommendKeywordsGetResult, error)
- func RegionUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
- func RejectReason(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]ad.RejectReasonList, error)
- func RoiGoalUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) ([]ad.RoiGoalUpdateResult, error)
- func ScheduleDateUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
- func ScheduleFixedRangeUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
- func ScheduleTimeUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
- func SuggestBid(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.SuggestBidResult, error)
- func SuggestBudget(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.SuggestBudgetResult, error)
- func SuggestRoiGoal(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.SuggestRoiResult, error)
- func Update(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.CreateResult, error)
- func UpdateBid(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
- func UpdateBudget(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
- func UpdateStatus(ctx context.Context, clt *core.SDKClient, accessToken string, ...) (*ad.UpdateResponseData, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CompensateStatusGet ¶ added in v1.20.5
func CompensateStatusGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.CompensateStatusGetRequest) ([]ad.CompensateStatus, error)
CompensateStatusGet 获取计划成本保障状态
func Create ¶
func Create(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.CreateRequest) (*ad.CreateResult, error)
Create 创建计划(含创意生成规则) 用于创建一条完整的广告计划,包括投放规则(出价预算)、定向规则、创意(自定义创意/程序化创意) 与非千川的计划创建接口差异点在于,该接口将同时创建创意,即通过本接口可完成完整计划的创建 支持专业版和极速版计划的创建,具体传参要求参见字段描述 短视频带货目前暂不支持创建“计划托管”的广告计划
func DetailGet ¶
func DetailGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.DetailGetRequest) (*ad.Ad, error)
DetailGet 获取计划详情(含创意信息) 用于获取千川广告账户下创建的单个计划的规则信息(含创意生成规则),以及计划下的创意 注意: 程序化创意在通过审核后才可以获取到
func EstimateEffect ¶ added in v1.16.0
func EstimateEffect(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.EstimateEffectRequest) (*ad.EstimateEffectResult, error)
EstimateEffect 获取预估效果接口 推直播间-日常销售-通投-托管-放量投放场景获取预估效果
func Get ¶
func Get(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.GetRequest) (*ad.GetResponseData, error)
Get 获取账户下计划列表(不含创意) 用于获取千川广告账户下创建的计划列表(不含创意部分) 默认可以拉取全部计划详情,可以通过过滤拉取部分计划
func KeywordCheck ¶ added in v1.16.0
func KeywordCheck(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.KeywordCheckRequest) (*ad.KeywordCheckData, error)
KeywordCheck 关键词合规校验 用于确认创建搜索广告之前提供关键词合规校验及违规提醒
func KeywordPackageGet ¶ added in v1.19.9
func KeywordPackageGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.KeywordPackageGetRequest) ([]ad.WordPackage, error)
KeywordPackageGet 获取词包推荐关键词
func KeywordsGet ¶ added in v1.16.0
func KeywordsGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.KeywordsGetRequest) (*ad.KeywordsGetResult, error)
KeywordsGet 获取计划的搜索关键词
func KeywordsUpdate ¶ added in v1.16.0
func KeywordsUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.KeywordsUpdateRequest) error
KeywordsUpdate 更新关键词 用于更新搜索计划关键词
func LearningStatusGet ¶ added in v1.20.5
func LearningStatusGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.LearningStatusGetRequest) ([]ad.LearningStatus, error)
LearningStatusGet 获取计划学习期状态
func LqAdGet ¶ added in v1.16.0
func LqAdGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.LqAdGetRequest) ([]uint64, error)
LqAdGet 获取低效计划列表 用于获取千川广告账户下的低效计划列表 注意: 低效计划一定是在投计划;关停或删除后,将不再是低效计划 创意重复度高或低活跃的计划,都有可能是低效计划。具体定义待平台后续公布 请勿使用定时任务高频轮询;建议实现“低效计划暂停/清理”功能,由前端触发调用该接口
func MaterialDelete ¶ added in v1.25.7
func MaterialDelete(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.MaterialDeleteRequest) error
MaterialDelete 删除广告创意
func MaterialGet ¶ added in v1.25.7
func MaterialGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.MaterialGetRequest) (*ad.MaterialGetResult, error)
MaterialGet 获取计划下素材列表 获取计划下的素材信息,包括素材的元信息,审核状态,关联创意ID,派生信息,是否删除等。
func PrivatewordsGet ¶ added in v1.16.0
func PrivatewordsGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.PrivatewordsGetRequest) (*ad.PrivateWords, error)
PrivatewordsGet 获取否定词列表
func PrivatewordsUpdate ¶ added in v1.16.0
func PrivatewordsUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.PrivatewordsUpdateRequest) (*ad.PrivatewordsUpdateResult, error)
PrivatewordsUpdate 全量更新否定词 用于全量更新搜索计划否定词
func QuotaGet ¶ added in v1.17.2
func QuotaGet(ctx context.Context, clt *core.SDKClient, accessToken string, advertiserID uint64) (*ad.QuotaGetResult, error)
QuotaGet 获取在投计划配额信息 此接口用于获取对应广告主的在投计划配额的相关信息,相关文档可见「在投计划配额」介绍文档
func RecommendKeywordsGet ¶ added in v1.16.0
func RecommendKeywordsGet(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.RecommendKeywordsGetRequest) (*ad.RecommendKeywordsGetResult, error)
RecommendKeywordsGet 获取系统推荐的搜索关键词 获取巨量千川广告账户下,系统推荐的搜索关键词,以用于创编搜索广告
func RegionUpdate ¶ added in v1.18.5
func RegionUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.RegionUpdateRequest) (*ad.UpdateResponseData, error)
RegionUpdate 更新计划地域定向 批量更新计划定向地域,已关联定向包的计划和托管计划不支持修改地域
func RejectReason ¶
func RejectReason(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.RejectReasonRequest) ([]ad.RejectReasonList, error)
RejectReason 获取计划审核建议 通过此接口用于获取广告计划纬度的审核意见
func RoiGoalUpdate ¶ added in v1.16.0
func RoiGoalUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.RoiGoalUpdateRequest) ([]ad.RoiGoalUpdateResult, error)
RoiGoalUpdate 更新计划的支付ROI目标 此接口用于批量更新广告计划的支付ROI目标
func ScheduleDateUpdate ¶ added in v1.18.5
func ScheduleDateUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.ScheduleDateUpdateRequest) (*ad.UpdateResponseData, error)
ScheduleDateUpdate 更新计划投放时间 批量更新计划投放时间,对于live_schedule_type=SCHEDULE_TIME_FIXEDRANGE的计划不支持
func ScheduleFixedRangeUpdate ¶ added in v1.18.5
func ScheduleFixedRangeUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.ScheduleFixedRangeUpdateRequest) (*ad.UpdateResponseData, error)
ScheduleFixedRangeUpdate 更新计划投放时长 批量更新计划固定时长,仅支持marketing_goal=LIVE_PROM_GOODS&live_schedule_type=SCHEDULE_TIME_FIXEDRANGE计划支持
func ScheduleTimeUpdate ¶ added in v1.18.5
func ScheduleTimeUpdate(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.ScheduleTimeUpdateRequest) (*ad.UpdateResponseData, error)
ScheduleTimeUpdate 更新计划投放时段 批量更新计划投放时段,对于live_schedule_type=SCHEDULE_TIME_FIXEDRANGE的计划不支持
func SuggestBid ¶ added in v1.16.0
func SuggestBid(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.SuggestBidRequest) (*ad.SuggestBidResult, error)
SuggestBid 获取非ROI目标建议出价 支持通过该接口获取非ROI目标建议出价
func SuggestBudget ¶ added in v1.16.0
func SuggestBudget(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.SuggestBudgetRequest) (*ad.SuggestBudgetResult, error)
SuggestBudget 获取建议预算接口
func SuggestRoiGoal ¶ added in v1.16.0
func SuggestRoiGoal(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.SuggestRoiGoalRequest) (*ad.SuggestRoiResult, error)
SuggestRoiGoal 获取支付ROI目标建议
func Update ¶
func Update(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.UpdateRequest) (*ad.CreateResult, error)
Update 更新计划(含创意生成规则) 用于更新一条完整的广告计划,包括投放规则(出价预算),定向规则,创意(自定义创意/程序化创意) 与非千川的计划更新接口差异点在于,该接口将同时更新创意,即通过本接口可完成完整计划的更新 目前的更新方式为全量更新,可先通过【获取计划详情】接口获取计划详情内容后,再进行更新 支持专业推广和极速推广计划的更新,具体可参看字段表
func UpdateBid ¶
func UpdateBid(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.UpdateBidRequest) (*ad.UpdateResponseData, error)
UpdateBid 更新计划出价 用于更新广告计划的出价 bid,一次可以处理10个计划 注意: 修改的出价不能大于当前预算
func UpdateBudget ¶
func UpdateBudget(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.UpdateBudgetRequest) (*ad.UpdateResponseData, error)
UpdateBudget 更新计划预算 通过此接口用于更新广告计划的预算,一次可以处理10个计划 24小时内修改预算操作,不能超过20次,24小时是指自然天的24小时 单次修改预算幅度不能低于100元(增加或者减少) 修改后预算金额,不能低于当前已消费金额的105%,以整百单位向上取整 可能存在部分计划更新成功的情况,更新失败的计划id及原因将会在返回体中返回
func UpdateStatus ¶
func UpdateStatus(ctx context.Context, clt *core.SDKClient, accessToken string, req *ad.UpdateStatusRequest) (*ad.UpdateResponseData, error)
UpdateStatus 更新计划状态 通过此接口可对计划做启用/暂停/删除操作,一次可以处理10个计划 对于删除的计划不能再进行状态操作,否则会报错 可能存在部分计划更新成功的情况,更新失败的计划id及原因将会在返回体中返回
Types ¶
This section is empty.
Source Files ¶
- compensate_status_get.go
- create.go
- detail_get.go
- doc.go
- estimate_effect.go
- get.go
- keyword_check.go
- keyword_package_get.go
- keywords_get.go
- keywords_update.go
- learning_status_get.go
- lq_ad_get.go
- material_delete.go
- material_get.go
- privatewords_get.go
- privatewords_update.go
- quota_get.go
- recommend_keywords_get.go
- region_update.go
- reject_reason.go
- roi_goal_update.go
- schedule_date_update.go
- schedule_fixed_range_update.go
- schedule_time_update.go
- suggest_bid.go
- suggest_budget.go
- suggest_roi_goal.go
- update.go
- update_bid.go
- update_budget.go
- update_status.go