campaign

package
v0.0.0-...-80d2d60 Latest Latest
Warning

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

 Go to latest Published: Aug 9, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoBuildNameRule 

type AutoBuildNameRule struct {
	// UnitNameRule 广告组名称命名规则; 必须同时包含[日期]和[序号]宏变量，eg: 系统自动搭建_[日期][序号]
	UnitNameRule string `json:"unit_name_rule,omitempty"`
	// CreativeNameRule 广告创意名称命名规则; 必须同时包含[日期]和[序号]宏变量，eg: 系统自动搭建_[日期][序号]
	CreativeNameRule string `json:"creative_name_rule,omitempty"`
}

AutoBuildNameRule 自动基建命名规则

type Campaign 

type Campaign struct {
	CampaignID                     uint64            `json:"campaign_id"`                                  // 计划id
	CampaignName                   string            `json:"campaign_name,omitempty"`                      // 计划名称
	PutStatus                      int               `json:"put_status,omitempty"`                         // 投放状态（操作结果） 1：投放中；2：暂停；3：删除
	Status                         int               `json:"status,omitempty"`                             // 计划状态 1：广告计划已暂停；3：广告计划超预算；4：有效；5：广告计划已删除；6：账户余额不足；-2：不限
	DayBudget                      int64             `json:"day_budget,omitempty"`                         // 当日预算
	DayBudgetSchedule              []int64           `json:"day_budget_schedule,omitempty"`                // 分日预算 优先级高于day_budget
	CampaignType                   int               `json:"campaign_type,omitempty"`                      // 计划类型
	CampaignSubType                int               `json:"campaign_sub_type,omitempty"`                  // 计划子类型 商品库推广计划类型的老数据会返回【后续会进行下线】。4：DPA，5：SDPA
	AdType                         int               `json:"ad_type,omitempty"`                            // 广告计划类型 0:信息流，1:搜索
	BidType                        int               `json:"bid_type,omitempty"`                           // 出价类型
	AutoAdjust                     int               `json:"auto_adjust,omitempty"`                        // 自动调控开关 0:关闭，1:开启
	AutoBuild                      int               `json:"auto_build,omitempty"`                         // 自动基建开关 0:关闭，1:开启
	AutoBuildNameRule              AutoBuildNameRule `json:"auto_build_name_rule,omitempty"`               // 自动基建广告命名规则
	AutoManage                     int               `json:"auto_manage,omitempty"`                        // 智能投放开关 0:关闭，1:开启
	CampaignOCPXActionType         int               `json:"campaign_ocpx_action_type,omitempty"`          // 智能模式下的优化目标
	CampaignOCPXActionName         string            `json:"campaign_ocpx_action_type_name,omitempty"`     // 智能模式下的优化目标名称
	CampaignDeepConversionType     int               `json:"campaign_deep_conversion_type,omitempty"`      // 智能模式下的深度优化目标
	CampaignDeepConversionTypeName string            `json:"campaign_deep_conversion_type_name,omitempty"` // 智能模式下的深度优化目标名称
	CreateTime                     string            `json:"create_time,omitempty"`                        // 创建时间
	UpdateTime                     string            `json:"update_time,omitempty"`                        // 更新时间
}

Campaign 包含广告计划信息

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignName 广告计划名称; 长度为1-100个字符，计划名称不能重复
	CampaignName string `json:"campaign_name,omitempty"`
	// Type 计划类型; 2：提升应用安装；3：获取电商下单；4：推广品牌活动；5：收集销售线索；7：提高应用活跃；9：商品库推广（此营销目标下创建的默认为DPA广告）；16：粉丝/直播推广；19：小程序推广
	Type int `json:"type,omitempty"`
	// DayBudget 单日预算金额; 单位：厘，指定0表示预算不限，默认为0；不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget_schedule不能同时传，不能低于该计划下任一广告组出价。当bid_type=1时，day_budget或者budget_schedule二选一必填
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价。事例：时间周期为周一到周日，样例："day_budget_schedule":[11110000,22220000,0,0,0,0,0]，优先级高于day_budget。当bid_type=1时，day_budget或者budget_schedule二选一必填
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// AdType 广告计划类型; 0:信息流，1:搜索；不填默认信息流
	AdType int `json:"ad_type,omitempty"`
	// BidType 出价类型; 0:默认1:最大转化（添加后不可修改）
	BidType int `json:"bid_type,omitempty"`
	// AutoAdjust 自动调控开关; 0：关闭，1：开启【注：此字段设置为关闭时，auto_build字段也必须为关闭，白名单功能】
	AutoAdjust int `json:"auto_adjust,omitempty"`
	// AutoBuild 自动基建开关; 0：关闭，1：开启【注：此字段设置为开启时，auto_adjust字段也必须为开启，白名单功能】
	AutoBuild int `json:"auto_build,omitempty"`
	// AutoBuildNameRule 自动基建命名规则; 仅在auto_build为1时，此字段生效，开启自动基建时必填命名规则，组、创意命名规则均必须同时包含[日期]和[序号]宏变量【注：白名单功能】
	AutoBuildNameRule *AutoBuildNameRule `json:"auto_build_name_rule,omitempty"`
}

CreateRequest 创建广告计划 API Request

func (CreateRequest) Encode 

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

func (CreateRequest) Url 

func (r CreateRequest) Url() string

Url implement PostRequest interface

type CreateResponse 

type CreateResponse struct {
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
}

CreateResponse 创建广告计划 API Response

type ListRequest 

type ListRequest struct {
	// AdvertiserID 广告主 ID，在获取 access_token 的时候返回，必填
	AdvertiserID uint64 `json:"advertiser_id"`
	// CampaignID 广告计划 ID，过滤筛选条件，若不传或传空则视为无限制条件
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignName 计划名称，过滤筛选条件，若不传或传空则视为无限制条件
	CampaignName string `json:"campaign_name,omitempty"`
	// CampaignIDs 广告计划 ID 集，不超过 200 个
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
	// PutStatusList 计划投放状态筛选，1：投放；2：暂停；3：删除。传了该参数会覆盖 status 参数筛选，因为二者是相同筛选项
	PutStatusList int `json:"put_status_list,omitempty"`
	// Status 计划状态，过滤筛选条件；1：广告计划已暂停；4：有效；5：广告计划已删除； -2 不限
	Status int `json:"status,omitempty"`
	// StartDate 开始时间，格式为"yyyy-MM-dd"，与 end_date 同时传或同时不传；过滤筛选条件，参数值对应 update_time 信息
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式为"yyyy-MM-dd"，与 start_date 同时传或同时不传；过滤筛选条件，参数值对应 update_time 信息
	EndDate string `json:"end_date,omitempty"`
	// TimeFilterType 按创建时间，还是更新时间进行筛选。1.如传入此字段时不传"start_date"，与"end_date"字段，则不根据时间筛选。2.传入"start_date"，与"end_date"字段，且此字段为 1 时，按照创建时间进行筛选。3.传入"start_date"，与"end_date"字段，此字段不传，或传值为 0 时，则按照更新时间进行筛选
	TimeFilterType int `json:"time_filter_type,omitempty"`
	// Page 请求的页码数，默认为 1
	Page int `json:"page,omitempty"`
	// PageSize 请求的每页行数，默认为 20
	PageSize int `json:"page_size,omitempty"`
}

ListRequest 获取广告计划信息 API Request

func (ListRequest) Encode 

func (r ListRequest) Encode() []byte

Encode implement PostRequest interface

func (ListRequest) Url 

func (r ListRequest) Url() string

Url implement PostRequest interface

type ListResponse 

type ListResponse struct {
	// TotalCount 数据总数
	TotalCount int `json:"total_count,omitempty"`
	// Details 返回值详情
	Details []Campaign `json:"details,omitempty"`
}

ListResponse 获取广告计划信息 API Response

type StatusUpdateRequest 

type StatusUpdateRequest struct {
	// advertiser_id	long	必填	广告主 ID	在获取 access_token 的时候返回
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// unit_ids	long	必填	广告计划 ID
	CampaignIds []uint64 `json:"campaign_ids,omitempty"`
	// 1-投放、2-暂停、3-删除，传其他数字非法
	PutStatus int `json:"put_status,omitempty"`
}

StatusUpdateRequest 广告计划状态更新 API Request

func (StatusUpdateRequest) Encode 

func (r StatusUpdateRequest) Encode() []byte

Encode implement PostRequest interface

func (StatusUpdateRequest) Url 

func (r StatusUpdateRequest) Url() string

Url implement PostRequest interface

type StatusUpdateResponse 

type StatusUpdateResponse struct {
	// CampaignIds 所有修改状态成功的计划 id
	CampaignIds []uint64 `json:"campaign_ids,omitempty"`
}

StatusUpdateResponse 广告计划状态更新 API Response

type UpdateRequest 

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID
	CampaignId uint64 `json:"campaign_id,omitempty"`
	// CampaignName 广告计划名称; 长度为1-100个字符，计划名称不能重复
	CampaignName string `json:"campaign_name,omitempty"`
	// Type 计划类型; 2：提升应用安装；3：获取电商下单；4：推广品牌活动；5：收集销售线索；7：提高应用活跃；9：商品库推广（此营销目标下创建的默认为DPA广告）；16：粉丝/直播推广；19：小程序推广
	Type int `json:"type,omitempty"`
	// DayBudget 单日预算金额; 单位：厘，指定0表示预算不限，默认为0；不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget_schedule不能同时传，不能低于该计划下任一广告组出价。当bid_type=1时，day_budget或者budget_schedule二选一必填
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价。事例：时间周期为周一到周日，样例："day_budget_schedule":[11110000,22220000,0,0,0,0,0]，优先级高于day_budget。当bid_type=1时，day_budget或者budget_schedule二选一必填
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// AdType 广告计划类型; 0:信息流，1:搜索；不填默认信息流
	AdType int `json:"ad_type,omitempty"`
	// BidType 出价类型; 0:默认1:最大转化（添加后不可修改）
	BidType int `json:"bid_type,omitempty"`
	// AutoAdjust 自动调控开关; 0：关闭，1：开启【注：此字段设置为关闭时，auto_build字段也必须为关闭，白名单功能】
	AutoAdjust int `json:"auto_adjust,omitempty"`
	// AutoBuild 自动基建开关; 0：关闭，1：开启【注：此字段设置为开启时，auto_adjust字段也必须为开启，白名单功能】
	AutoBuild int `json:"auto_build,omitempty"`
	// AutoBuildNameRule 自动基建命名规则; 仅在auto_build为1时，此字段生效，开启自动基建时必填命名规则，组、创意命名规则均必须同时包含[日期]和[序号]宏变量【注：白名单功能】
	AutoBuildNameRule *AutoBuildNameRule `json:"auto_build_name_rule,omitempty"`
	// auto_manage	int	选填	是	智能投放开关	0：关闭，1：开启。【注：此字段修改为关闭时，需同时关闭 auto_adjust、auto_build 字段。此字段修改为开启时，该计划下必须存在在投广告组且campaign_ocpx_action_type、campaign_deep_conversion_type必须设置为与任一在投广告组优化目标和深层优化目标值一致，白名单功能】
	AutoManage int `json:"auto_manage,omitempty"`
	// campaign_ocpx_action_type	int	选填	是	智能投放优化目标	auto_manage 设置为开启时可填，必须与该计划下任一广告组的优化目标保持一致
	CampaignOcpxActionType int `json:"campaign_ocpx_action_type,omitempty"`
	// campaign_deep_conversion_type	int	选填	是	智能投放深度优化目标	auto_manage 设置为开启时可填，必须与该计划下任一广告组的深度优化目标保持一致
	CampaignDeepConversionType int `json:"campaign_deep_conversion_type,omitempty"`
	// PutStatus 1-投放、2-暂停、3-删除，传其他数字非法
	PutStatus int `json:"put_status,omitempty"`
}

UpdateRequest 更新广告计划 API Request

func (UpdateRequest) Encode 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateRequest) Url 

func (r UpdateRequest) Url() string

Url implement PostRequest interface

type UpdateResponse 

type UpdateResponse struct {
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
}

UpdateResponse 更新广告计划 API Response

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.