Documentation
¶
Overview ¶
Package promotion 广告管理模块相关API models
Index ¶
- type BidUpdateData
- type BidUpdateRequest
- type BudgetUpdateData
- type BudgetUpdateRequest
- type ComponentMaterial
- type CostProtectStatus
- type CostProtectStatusGetRequest
- type CostProtectStatusGetResponse
- type CreateRequest
- type CreateResponse
- type DeepBidUpdateData
- type DeepBidUpdateRequest
- type DeleteRequest
- type Image
- type ImageMaterial
- type ListFilter
- type ListRequest
- type ListResponse
- type ListResponseData
- type LowQualityMaterial
- type MaterialReject
- type MaterialScoreInfo
- type NativeSetting
- type ProductInfo
- type Promotion
- func (p Promotion) GetAdvertiserID() uint64
- func (p Promotion) GetBudget() float64
- func (p Promotion) GetCampaignID() uint64
- func (p Promotion) GetCpaBid() float64
- func (p Promotion) GetDeepCpaBid() float64
- func (p Promotion) GetExternalURLs() []string
- func (p Promotion) GetID() uint64
- func (p Promotion) GetName() string
- func (p Promotion) GetOptStatus() enum.AdOptStatus
- func (p Promotion) IsProject() bool
- func (p Promotion) Version() model.AdVersion
- type PromotionMaterial
- type PromotionReject
- type RejectData
- type RejectReason
- type RejectReasonRequest
- type RejectReasonResponse
- type StatusUpdateData
- type StatusUpdateRequest
- type TitleMaterial
- type UpdateError
- type UpdateRequest
- type UpdateResponse
- type UpdateResponseData
- type VideoMaterial
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BidUpdateData ¶
type BidUpdateData struct { // PromotionID 广告ID,广告ID需要属于广告主 PromotionID uint64 `json:"promotion_id,omitempty"` // Bid 出价,单位“元”,精度:两位小数。 Bid float64 `json:"deepbid,omitempty"` }
BidUpdateData 修改信息
type BidUpdateRequest ¶
type BidUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Data 批量修改,包含广告id和出价 Data []BidUpdateData `json:"data,omitempty"` }
BidUpdateRequest 更新出价 API Request
func (BidUpdateRequest) Encode ¶
func (r BidUpdateRequest) Encode() []byte
Encode implement PostRequest interface
type BudgetUpdateData ¶
type BudgetUpdateData struct { // PromotionID 广告ID,广告ID需要属于广告主 PromotionID uint64 `json:"promotion_id,omitempty"` // Budget 预算,单位“元”,精度:两位小数。 Budget float64 `json:"budget,omitempty"` }
BudgetUpdateData 修改信息
type BudgetUpdateRequest ¶
type BudgetUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Data 批量修改,包含广告id和出价 Data []BudgetUpdateData `json:"data,omitempty"` }
BudgetUpdateRequest 更新广告预算 API Request
func (BudgetUpdateRequest) Encode ¶
func (r BudgetUpdateRequest) Encode() []byte
Encode implement PostRequest interface
type ComponentMaterial ¶
type ComponentMaterial struct { // ComponentID 组件id ComponentID uint64 `json:"component_id,omitempty"` }
ComponentMaterial 创意组件信息
type CostProtectStatus ¶
type CostProtectStatus struct { // QueryID 计划id QueryID uint64 `json:"query_id,omitempty"` // Status 计划成本保障状态 Status string `json:"status,omitempty"` // CompensationStatus 成本保障状态 枚举值: // DEFAULT_STATUS: 当前计划未产生首次send或者不在成本保障范围内 // IN_EFFECT: 成本保障生效中 // INVALID: 成本保障已失效 // CONFIRMING: 成本保障确认中 // PAID: 成本保障已到账 // ENDED: 成本保障已结束 CompensationStatus string `json:"compensate_status,omitempty"` // InvalidReasons 成本保障失效原因 枚举值: // AUD_CHANGES单日修改定向超过2次, // BID_CHANGES单日修改出价超过2次 // ROI_CHANGES单日修改roi_goal超过2次 // ANTI_SPAM命中反作弊 // BID_TYPE_EXPIRED选择的出价产品暂不支持成本保障 // MANUAL_JUDGE_SPAM有异常的作弊行为 // AUD_BID_CHANGES单日修改定向/出价超过2次 // AUD_ROI_CHANGES单日修改定向/ROI目标超过2次 InvalidReasons map[string]string `json:"invalid_reasons,omitempty"` // EndReasons 成本保障结束原因 // UN_OBERCOST 超成本比例没有达到1.2倍 // ROI_REAL_EXPECTED实际roi大于目标roi的80% // CONVERT_UNDER_THRESHOLD转化数没有达到门槛 // CURRENCY_PRECISION赔付金额小于0.01元 EndReasons map[string]string `json:"end_reasons,omitempty"` // CompensationAmount 赔付金额 CompensationAmount float64 `json:"compensation_amount,omitempty"` // URL 赔付规则链接 URL string `json:"url,omitempty"` }
CostProtectStatus guan广告成本保护状态
type CostProtectStatusGetRequest ¶
type CostProtectStatusGetRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PromotionIDs 广告id,每次最多传入50个 PromotionIDs []uint64 `json:"promotion_ids,omitempty"` }
CostProtectStatusGetRequest 批量获取计划成本保障状态 API Request
func (CostProtectStatusGetRequest) Encode ¶
func (r CostProtectStatusGetRequest) Encode() string
Encode implement GetRequest interface
type CostProtectStatusGetResponse ¶
type CostProtectStatusGetResponse struct { model.BaseResponse // Data json 返回值 Data struct { // List . List []CostProtectStatus `json:"compensate_status_info_list,omitempty"` } `json:"data,omitempty"` }
CostProtectStatusGetResponse 批量获取计划成本保障状态 API Response
type CreateRequest ¶
type CreateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // ProjectID 项目ID ProjectID uint64 `json:"project_id,omitempty"` // Name 广告名称,长度是1-50个字(两个英文字符占1个字)。名称不可重复 Name string `json:"name,omitempty"` // Operation 广告状态, 允许值: ENABLE开启(默认值)、DISABLE关闭 Operation enum.OptStatus `json:"operation,omitempty"` // PromotionMaterials 广告素材组合 PromotionMaterials *PromotionMaterial `json:"promotion_materials,omitempty"` // NativeSetting 原生广告设置 NativeSetting *NativeSetting `json:"native_setting,omitempty"` // Source 广告来源,字数限制:[1-10] // 当landing_type = LINK、MICRO_GAME时必填 Source string `json:"source,omitempty"` // Budget 预算(出价方式为OCPM时,不少于300元;24小时内修改预算操作,不能超过20次,24小时是指自然天的24小时;单次修改预算幅度不能低于100元(增加或者减少);修改后预算金额,不能低于当前已消费金额的105%,以整百单位向上取整;取值范围: ≥ 0 Budget float64 `json:"budget,omitempty"` // CpaBid 目标转化出价/预期成本, 取值范围:0.1-10000元 // 注意:当 bid_type = NO_BID时,不填写该字段,否则会报错 CpaBid float64 `json:"cpa_bid,omitempty"` // DeepCpaBid 深度优化出价,deep_bid_type = DEEP_BID_MIN 时必填。取值范围:0.1~10000元 // 注意:当 bid_type = NO_BID时,不填写该字段,否则会报错 DeepCpaBid float64 `json:"deep_cpabid,omitempty"` // RoiGoal 深度转化ROI系数, 范围(0,5],精度:保留小数点后四位,当 deep_bid_type = ROI_COEFFICIENT 时必填 // 注意:当 bid_type=NO_BID时,不填写该字段,否则会报错 RoiGoal float64 `json:"roi_goal,omitempty"` }
CreateRequest 创建广告 API Request
func (CreateRequest) Encode ¶
func (r CreateRequest) Encode() []byte
Encode implement PostRequest interface
type CreateResponse ¶
type CreateResponse struct { model.BaseResponse Data struct { // PromotionID 广告ID PromotionID uint64 `json:"promotion_id,omitempty"` } `json:"data,omitempty"` }
CreateResponse 创建广告 API Response
type DeepBidUpdateData ¶
type DeepBidUpdateData struct { // PromotionID 广告计划ID,广告计划ID需要属于广告主 PromotionID uint64 `json:"promotion_id,omitempty"` // DeepBid 出价,单位“元”,精度:两位小数。 DeepBid float64 `json:"deepbid,omitempty"` }
DeepBidUpdateData 修改信息
type DeepBidUpdateRequest ¶
type DeepBidUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Data 批量修改,包含计划id和出价 Data []DeepBidUpdateData `json:"data,omitempty"` }
DeepBidUpdateRequest 更新深度出价 API Request
func (DeepBidUpdateRequest) Encode ¶
func (r DeepBidUpdateRequest) Encode() []byte
Encode implement PostRequest interface
type DeleteRequest ¶
type DeleteRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PromotionIDs 广告ID集合,list长度限制1~10 PromotionIDs []uint64 `json:"promotion_ids,omitempty"` }
DeleteRequest 批量删除广告 API Request
func (DeleteRequest) Encode ¶
func (r DeleteRequest) Encode() []byte
Encode implement PostRequest interface
type Image ¶
type Image struct { // ImageID 图片ID ImageID string `json:"image_id,omitempty"` // MaterialID 素材ID MaterialID model.Uint64 `json:"material_id,omitempty"` // MaterialStatus 素材审核状态,枚举值: // MATERIAL_STATUS_OK 投放中、MATERIAL_STATUS_DELETE 已删除、MATERIAL_STATUS_PROJECT_OFFLINE_BUDGET 项目超出预算、MATERIAL_STATUS_PROJECT_PREOFFLINE_BUDGET 项目接近预算、MATERIAL_STATUS_TIME_NO_REACH 未到达投放时间、MATERIAL_STATUS_TIME_DONE 已完成、MATERIAL_STATUS_NO_SCHEDULE 不在投放时段、MATERIAL_STATUS_AUDIT 新建审核中、MATERIAL_STATUS_REAUDIT 修改审核中、MATERIAL_STATUS_OFFLINE_AUDIT 审核不通过、MATERIAL_STATUS_OFFLINE_BUDGET 广告超出预算、MATERIAL_STATUS_ OFFLINE_BALANCE 账户余额不足、MATERIAL_STATUS_ PREOFFLINE_BUGDET 广告接近预算、MATERIAL_STATUS_PROJECT_DISABLE 已被项目暂停、MATERIAL_STATUS_DISABLE 已暂停、MATERIAL_STATUS_PROMOTION_DISABLE 已被广告暂停、MATERIAL_STATUS_MATERIAL_DELETE 已删除 MaterialStatus enum.MaterialStatus `json:"material_status,omitempty"` }
Image 图片
type ImageMaterial ¶
type ImageMaterial struct { // ImageMode 素材类型 ImageMode enum.ImageMode `json:"image_mode,omitempty"` // Images 图片ID数组 Images []Image `json:"images,omitempty"` }
ImageMaterial 创意图片素材
type ListFilter ¶
type ListFilter struct { // IDs 按广告ID过滤,范围为1-100 IDs []uint64 `json:"ids,omitempty"` // Name 广告名称,长度是1-50个字(两个英文字符占1个字,该字段采取模糊查询的方式) Name string `json:"name,omitempty"` // ProjectID 按项目id过滤 ProjectID uint64 `json:"project_id,omitempty"` // DeliveryMode 投放模式,允许值:MANUAL手动投放 (默认值),PROCEDURAL自动投放 DeliveryMode enum.DeliveryMode `json:"delivery_mode,omitempty"` // Status 广告状态过滤,允许值: // NOT_DELETED 不限 、ALL 不限(包含已删除)、OK 投放中、DELETED 已删除、PROJECT_OFFLINE_BUDGET 项目超出预算、PROJECT_PREOFFLINE_BUDGET 项目接近预算、TIME_NO_REACH 未到达投放时间、TIME_DONE 已完成、NO_SCHEDULE 不在投放时段、AUDIT 新建审核中、REAUDIT 修改审核中、FROZEN 已终止、AUDIT_DENY 审核不通过、OFFLINE_BUDGET 广告超出预算、OFFLINE_BALANCE 账户余额不足、PREOFFLINE_BUDGET 广告接近预算、DISABLED 已暂停、PROJECT_DISABLED 已被项目暂停、LIVE_ROOM_OFF 关联直播间不可投、PRODUCT_OFFLINE 关联商品不可投,、AWEME_ACCOUNT_DISABLED 关联抖音账号不可投、AWEME_ANCHOR_DISABLED 锚点不可投、DISABLE_BY_QUOTA 已暂停(配额达限) Status enum.PromotionStatus `json:"status,omitempty"` // PromotionCreateTime 广告创建时间,格式yyyy-mm-dd,表示过滤出当天创建的广告项目 PromotionCreateTime string `json:"promotion_create_time,omitempty"` // PromotionModifyTime 广告更新时间,格式yyyy-mm-dd,表示过滤出当天更新的广告项目 PromotionModifyTime string `json:"promotion_modify_time,omitempty"` // RejectReasonType 审核建议类型,允许值:NONE 无建议、REVIEW_REJECT 审核不通过、LOW_MATERAIL 低质素材、DISCOMFORT 引人不适、QUALITY_POOR 素材质量低、EXAGGERATION 夸大宣传、ELSE 其他 RejectReasonType enum.PromotionRejectReasonType `json:"reject_reason_type,omitempty"` // LearningPhase 学习期状态 允许值:LEARNING(学习期中)、LEARNED(学习期结束)、LEARN_FAILED(学习期失败) LearningPhase []enum.LearningPhase `json:"learning_phase,omitempty"` }
ListFilter 过滤条件
func (ListFilter) GetCreateTime ¶ added in v1.9.19
func (f ListFilter) GetCreateTime() string
func (ListFilter) GetIDs ¶ added in v1.9.19
func (f ListFilter) GetIDs() []uint64
func (ListFilter) GetModifyTime ¶ added in v1.9.19
func (f ListFilter) GetModifyTime() string
func (ListFilter) GetName ¶ added in v1.9.19
func (f ListFilter) GetName() string
type ListRequest ¶
type ListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Filtering 过滤条件 Filtering *ListFilter `json:"filtering,omitempty"` // Fields 查询字段集合,如果指定则应答结果仅返回指定字段 // 可参考应答参数返回的指标字段 Fields []string `json:"fields,omitempty"` // Page 页数默认值: 1,page必须大于0 Page int `json:"page,omitempty"` // PageSize 页面大小默认值:10,page_size范围为1-10 PageSize int `json:"page_size,omitempty"` }
ListRequest 获取广告列表 API Request
func (ListRequest) Encode ¶
func (r ListRequest) Encode() string
Encode implement GetRequest interface
type ListResponse ¶
type ListResponse struct { model.BaseResponse Data *ListResponseData `json:"data,omitempty"` }
ListResponse 获取广告列表 API Response
type ListResponseData ¶
type LowQualityMaterial ¶
type LowQualityMaterial struct { // LowQualityVideoIDs 低质视频素材 LowQualityVideoIDs []string `json:"low_quality_video_ids,omitempty"` // LowQualityImageIDs 低质图片素材 LowQualityImageIDs []string `json:"low_quality_image_ids,omitempty"` }
LowQualityMaterial 低质素材信息
type MaterialReject ¶
type MaterialReject struct { // Type 素材类型,枚举值: // CREATIVE_IMAGE 图片、CREATIVE_VIDEO 视频、CREATIVE_TITLE 标题、CALL_TO_ACTION 行动号召、CREATIVE_URL 创意详情页、PRODUCT_IMAGE 产品主图、PRODUCT_SELLING_POINTS 产品卖点、PRODUCT_DESCRIBE 产品名称 CREATIVE_COMPONENT 创意组件 Type enum.MaterialType `json:"type,omitempty"` // Item 根据不同素材类型返回相应的值 // - CREATIVE_URL 创意详情页:web_url;external_url;playable_url // - CREATIVE_TITLE 标题:title // - CREATIVE_IMAGE 图片:image_id // - CREATIVE_VIDEO 视频:video_id // - CALL_TO_ACTION 行动号召:号召文案 // - PRODUCT_IMAGE 产品主图:image_id // - PRODUCT_SELLING_POINTS 产品卖点:产品卖点文案 // - PRODUCT_DESCRIB 产品名称:产品名称文案 // CREATIVE_COMPONENT 创意组件:component_id Item string `json:"item,omitempty"` // RejectReason 审核建议 RejectReason []string `json:"reject_reason,omitempty"` // Suggestion 审核建议 Suggestion []string `json:"suggestion,omitempty"` }
MaterialReject 素材维度审核建议
type MaterialScoreInfo ¶
type MaterialScoreInfo struct { // ScoreNumOfMaterial 素材数量评级分数,枚举值:LEVEL1 较差、LEVEL2 一般、LEVEL3 良好、LEVEL4 极佳、LEVEL5 完美 ScoreNumOfMaterial string `json:"score_num_of_material,omitempty"` // ScoreTypeOfMaterial 素材类型评级分数,枚举值:LEVEL1 较差、LEVEL2 一般、LEVEL3 良好、LEVEL4 极佳、LEVEL5 完美 ScoreTypeOfMaterial string `json:"score_type_of_material,omitempty"` // ScoreValueOfMaterial 素材品质评级分数,枚举值:LEVEL1 较差、LEVEL2 一般、LEVEL3 良好、LEVEL4 极佳、LEVEL5 完美 ScoreValueOfMaterial string `json:"score_value_of_material,omitempty"` // MaterialAdvice 素材评级建议 MaterialAdvice []string `json:"material_advice,omitempty"` // LowQualityMaterialList 低质素材信息 LowQualityMaterialList []LowQualityMaterial `json:"low_quality_material_list,omitempty"` }
MaterialScoreInfo 素材评级信息
type NativeSetting ¶ added in v1.9.28
type NativeSetting struct { // AwemeID 授权抖音号id,可通过【获取抖音号授权关系】接口获得 // 当传入抖音号表示原生广告开启 AwemeID string `json:"aweme_id,omitempty"` // IsFeedAndFavSee 主页作品列表隐藏广告内容 // 允选值:OFF(不隐藏),ON(隐藏) // 默认值:OFF IsFeedAndFavSee string `json:"is_feed_and_fav_see,omitempty"` // AnchorRelatedType 原生锚点启用开关,允许值: // 不启用 OFF,自动生成 AUTO,手动选择 SELECT // 默认值为 OFF AnchorRelatedType string `json:"anchor_related_type,omitempty"` }
NativeSetting 原生广告设置
type ProductInfo ¶
type ProductInfo struct { // Titles 产品名称 Titles []string `json:"titles,omitempty"` // ImageIDs 产品主图 ImageIDs []string `json:"image_ids,omitempty"` // SellingPoints 产品卖点 SellingPoints []string `json:"selling_points,omitempty"` }
ProductInfo 产品信息
type Promotion ¶
type Promotion struct { // PromotionID 广告ID PromotionID uint64 `json:"promotion_id,omitempty"` // PromotionName 广告名称 PromotionName string `json:"promotion_name,omitempty"` // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // ProjectID 项目ID ProjectID uint64 `json:"project_id,omitempty"` // ModifyTime 计划上次修改时间标识(用于更新计划时提交,服务端判断是否基于最新信息修改) ModifyTime string `json:"modify_time,omitempty"` // PromotionModifyTime 广告更新时间,格式yyyy-MM-dd HH:mm:ss PromotionModifyTime string `json:"promotion_modify_time,omitempty"` // AdCreateTime 广告创建时间,格式yyyy-MM-dd HH:mm:ss PromotionCreateTime string `json:"promotion_create_time,omitempty"` // LearningPhase 学习期状态,枚举值:DEFAULT(默认,不在学习期中)、LEARNING(学习中)、LEARNED(学习成功)、LEARN_FAILED(学习失败) LearningPhase enum.LearningPhase `json:"learning_phase,omitempty"` // Status 广告状态,枚举值:NOT_DELETED 不限 、ALL 不限(包含已删除)、OK 投放中、DELETED 已删除、PROJECT_OFFLINE_BUDGET 项目超出预算、PROJECT_PREOFFLINE_BUDGET 项目接近预算、TIME_NO_REACH 未到达投放时间、TIME_DONE 已完成、NO_SCHEDULE 不在投放时段、AUDIT 新建审核中、REAUDIT 修改审核中、FROZEN 已终止、AUDIT_DENY 审核不通过、OFFLINE_BUDGET 广告超出预算、OFFLINE_BALANCE 账户余额不足、PREOFFLINE_BUDGET 广告接近预算、DISABLED 已暂停、PROJECT_DISABLED 已被项目暂停、LIVE_ROOM_OFF 关联直播间不可投、PRODUCT_OFFLINE 关联商品不可投,、AWEME_ACCOUNT_DISABLED 关联抖音账号不可投、AWEME_ANCHOR_DISABLED 锚点不可投、DISABLE_BY_QUOTA 已暂停(配额达限)、CREATE 新建、ADVERTISER_OFFLINE_BUDGET 账号超出预算、ADVERTISER_PREOFFLINE_BUDGET 账号接近预算 Status enum.PromotionStatus `json:"status,omitempty"` // OptStatus 操作状态 OptStatus enum.OptStatus `json:"opt_status,omitempty"` // NativeSetting 原生广告设置 NativeSetting *NativeSetting `json:"native_setting,omitempty"` // PromotionMaterials 广告素材组合 PromotionMaterials *PromotionMaterial `json:"promotion_materials,omitempty"` // Source 广告来源 Source string `json:"source,omitempty"` // Budget 预算 Budget float64 `json:"budget,omitempty"` // CpaBid 目标转化出价/预期成本 CpaBid float64 `json:"cpa_bid,omitempty"` // DeepCpaBid 深度优化出价 DeepCpaBid float64 `json:"deep_cpabid,omitempty"` // RoiGoal 深度转化ROI系数 RoiGoal float64 `json:"roi_goal,omitempty"` // MaterialScoreInfo 素材评级信息 MaterialScoreInfo *MaterialScoreInfo `json:"material_score_info,omitempty"` }
Promotion 广告信息
func (Promotion) GetAdvertiserID ¶ added in v1.9.17
func (Promotion) GetCampaignID ¶ added in v1.9.17
func (Promotion) GetDeepCpaBid ¶ added in v1.9.17
func (Promotion) GetExternalURLs ¶ added in v1.9.21
func (Promotion) GetOptStatus ¶ added in v1.9.17
func (p Promotion) GetOptStatus() enum.AdOptStatus
type PromotionMaterial ¶
type PromotionMaterial struct { // VideoMaterialList 视频素材信息 VideoMaterialList []VideoMaterial `json:"video_material_list,omitempty"` // ImageMaterialList 创意图片素材 ImageMaterialList []ImageMaterial `json:"image_material_list,omitempty"` // TitleMaterialList 标题素材 TitleMaterialList []TitleMaterial `json:"title_material_list,omitempty"` // ComponentMaterialList 创意组件信息 ComponentMaterialList []ComponentMaterial `json:"component_material_list,omitempty"` // ExternalURLMaterialList 普通落地页链接素材 ExternalURLMaterialList []string `json:"external_url_material_list,omitempty"` // WebURLMaterialList Android应用下载详情页 WebURLMaterialList []string `json:"web_url_material_list,omitempty"` // PlayableURLMaterialList 试玩落地页素材 PlayableURLMaterialList []string `json:"playable_url_material_list,omitempty"` // OpenURL 直达链接,用于打开电商app,调起店铺 // 仅在电商店铺推广目的下有效 OpenURL string `json:"open_url,omitempty"` // Ulink 直达备用链接,支持穿山甲和站内广告位 Ulink string `json:"ulink,omitempty"` // ProductInfo 产品信息 ProductInfo *ProductInfo `json:"product_info,omitempty"` // CallToActionButtons 行动号召文案 CallToActionButtons []string `json:"call_to_action_buttons,omitempty"` }
PromotionMaterial 广告素材
type PromotionReject ¶
type PromotionReject struct { // Content 审核项 Content string `json:"content,omitempty"` // RejectReason 审核建议 RejectReason []string `json:"reject_reason,omitempty"` // Suggestion 审核建议 Suggestion []string `json:"suggestion,omitempty"` }
PromotionReject 广告维度审核建议
type RejectData ¶
type RejectData struct { // RejectItem 审核项 RejectItem string `json:"reject_item,omitempty"` }
RejectData 审核建议数据
type RejectReason ¶
type RejectReason struct { // PromotionID 广告ID PromotionID uint64 `json:"promotion_id,omitempty"` // PromotionReject 广告维度审核建议 PromotionReject *PromotionReject `json:"promotion_reject,omitempty"` // MaterialReject 素材维度审核建议 MaterialReject []MaterialReject `json:"material_reject,omitempty"` }
RejectReason 计划审核意见
type RejectReasonRequest ¶
type RejectReasonRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PromotionIDs 广告计划 ID,最多传10个广告计划ID PromotionIDs []uint64 `json:"promotion_ids,omitempty"` }
RejectReasonRequest 获取计划审核建议 API Request
func (RejectReasonRequest) Encode ¶
func (r RejectReasonRequest) Encode() string
Encode implement GetRequest interface
type RejectReasonResponse ¶
type RejectReasonResponse struct { model.BaseResponse Data struct { List []RejectReason `json:"list,omitempty"` } `json:"data,omitempty"` }
RejectReasonResponse 获取计划审核建议 API Response
type StatusUpdateData ¶
type StatusUpdateRequest ¶
type StatusUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Data Data []StatusUpdateData `json:"data,omitempty"` }
StatusUpdateRequest 更新广告状态 API Request
func (StatusUpdateRequest) Encode ¶
func (r StatusUpdateRequest) Encode() []byte
Encode implement PostRequest interface
type TitleMaterial ¶
type TitleMaterial struct { // Title 创意标题 Title string `json:"title,omitempty"` // WordList 动态词包ID WordList []uint64 `json:"word_list,omitempty"` }
TitleMaterial 标题素材
type UpdateError ¶
type UpdateError struct { // PromotionID 广告计划ID PromotionID uint64 `json:"promotion_id,omitempty"` // ObjectType 错误对象类型 // 枚举值: BASIC 广告基本设置、MATERIAL 广告素材组合、BUDGET 广告预算 ObjectType string `json:"object_type,omitempty"` // ErrorCode 错误信息 ErrorCode int `json:"error_code,omitempty"` // ErrorMessage 错误信息 ErrorMessage string `json:"error_message"` }
UpdateError 更新失败的广告计划
type UpdateRequest ¶
type UpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PromotionID 广告ID,广告ID要属于广告主ID PromotionID uint64 `json:"promotion_id,omitempty"` // Name 广告名称,长度是1-50个字(两个英文字符占1个字)。名称不可重复 Name string `json:"name,omitempty"` // PromotionMaterials 广告素材组合 PromotionMaterials *PromotionMaterial `json:"promotion_materials,omitempty"` // NativeSetting 原生广告设置 NativeSetting *NativeSetting `json:"native_setting,omitempty"` // Source 广告来源,字数限制:[1-10] // 当landing_type = LINK、MICRO_GAME时必填 Source string `json:"source,omitempty"` // Budget 预算(出价方式为OCPM时,不少于300元;24小时内修改预算操作,不能超过20次,24小时是指自然天的24小时;单次修改预算幅度不能低于100元(增加或者减少);修改后预算金额,不能低于当前已消费金额的105%,以整百单位向上取整;取值范围: ≥ 0 Budget float64 `json:"budget,omitempty"` // CpaBid 目标转化出价/预期成本, 取值范围:0.1-10000元 // 注意:当 bid_type = NO_BID时,不填写该字段,否则会报错 CpaBid float64 `json:"cpa_bid,omitempty"` // DeepCpaBid 深度优化出价,deep_bid_type = DEEP_BID_MIN 时必填。取值范围:0.1~10000元 // 注意:当 bid_type = NO_BID时,不填写该字段,否则会报错 DeepCpaBid float64 `json:"deep_cpabid,omitempty"` // RoiGoal 深度转化ROI系数, 范围(0,5],精度:保留小数点后四位,当 deep_bid_type = ROI_COEFFICIENT 时必填 // 注意:当 bid_type=NO_BID时,不填写该字段,否则会报错 RoiGoal float64 `json:"roi_goal,omitempty"` }
UpdateRequest 修改广告列API Request
func (UpdateRequest) Encode ¶
func (r UpdateRequest) Encode() []byte
Encode implement PostRequest interface
type UpdateResponse ¶
type UpdateResponse struct { model.BaseResponse // Data json返回值 Data *UpdateResponseData `json:"data,omitempty"` }
UpdateResponse 更新计划API Response
type UpdateResponseData ¶
type UpdateResponseData struct { // PromotionID 广告计划ID PromotionID uint64 `json:"promotion_id,omitempty"` // PromotionIDs 广告计划ID集合 PromotionIDs []uint64 `json:"promotion_ids,omitempty"` // Errors 更新失败的广告计划列表 Errors []UpdateError `json:"errors,omitempty"` }
UpdateResponseData json返回值
type VideoMaterial ¶
type VideoMaterial struct { // ImageMode 素材类型 ImageMode enum.ImageMode `json:"image_mode,omitempty"` // VideoID 视频ID VideoID string `json:"video_id,omitempty"` // VideoCoverID 视频封面图片ID VideoCoverID string `json:"video_cover_id,omitempty"` // ItemID 抖音短视频ID ItemID string `json:"item_id,omitempty"` // MaterialID 素材ID MaterialID model.Uint64 `json:"material_id,omitempty"` // MaterialStatus 素材审核状态,枚举值: // MATERIAL_STATUS_OK 投放中、MATERIAL_STATUS_DELETE 已删除、MATERIAL_STATUS_PROJECT_OFFLINE_BUDGET 项目超出预算、MATERIAL_STATUS_PROJECT_PREOFFLINE_BUDGET 项目接近预算、MATERIAL_STATUS_TIME_NO_REACH 未到达投放时间、MATERIAL_STATUS_TIME_DONE 已完成、MATERIAL_STATUS_NO_SCHEDULE 不在投放时段、MATERIAL_STATUS_AUDIT 新建审核中、MATERIAL_STATUS_REAUDIT 修改审核中、MATERIAL_STATUS_OFFLINE_AUDIT 审核不通过、MATERIAL_STATUS_OFFLINE_BUDGET 广告超出预算、MATERIAL_STATUS_ OFFLINE_BALANCE 账户余额不足、MATERIAL_STATUS_ PREOFFLINE_BUGDET 广告接近预算、MATERIAL_STATUS_PROJECT_DISABLE 已被项目暂停、MATERIAL_STATUS_DISABLE 已暂停、MATERIAL_STATUS_PROMOTION_DISABLE 已被广告暂停、MATERIAL_STATUS_MATERIAL_DELETE 已删除 MaterialStatus enum.MaterialStatus `json:"material_status,omitempty"` }
VideoMaterial 视频素材信息