campaign

package
v1.10.1 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package campaign 广告计划

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 计划id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignName 计划名称
	CampaignName string `json:"campaign_name,omitempty"`
	// PutStatus 投放状态（操作结果）
	// 1：投放中；2：暂停 3：删除
	PutStatus int `json:"put_status,omitempty"`
	// Status 计划状态
	// 1：广告计划已暂停；3：广告计划超预算；4：有效；5：广告计划已删除；6：账户余额不足； -2：不限
	Status int `json:"status,omitempty"`
	// DayBudget 当日预算
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算
	// 优先级高于day_budget
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
	// CampaignType 营销目标类型
	CampaignType int `json:"campaign_type"`
	// CampaignSubType 计划子类型
	// 商品库推广计划类型的老数据会返回【后续会进行下线】。4：DPA，5：SDPA
	CampaignSubType int `json:"campaign_sub_type"`
	// AdType 广告计划类型
	// 0:信息流，1:搜索
	AdType int `json:"ad_type,omitempty"`
	// BidType 出价类型
	BidType int `json:"bid_type,omitempty"`
	// AutoAdjust 自动调控开关
	// 0:关闭，1:开启
	AutoAdjust int `json:"auto_adjust,omitempty"`
	// AutoBuild 自动基建开关
	// 0:关闭，1:开启
	AutoBuild int `json:"auto_build,omitempty"`
	// AutoBuildNameRule 自动基建广告命名规则
	AutoBuildNameRule *AutoBuildNameRule `json:"auto_build_name_rule,omitempty"`
	// AutoManage 智能投放开关
	// 0:关闭，1:开启
	AutoManage int `json:"auto_manage,omitempty"`
	// CampaignOcpxActionType 智能模式下的优化目标
	CampaignOcpxActionType int `json:"campaign_ocpx_action_type,omitempty"`
	// CampaignOcpxActionTypeName 智能模式下的优化目标名称
	CampaignOcpxActionTypeName string `json:"campaign_ocpx_action_type_name,omitempty"`
	// CampaignDeepConversionType 智能模式下的深度优化目标
	CampaignDeepConversionType int `json:"campaign_deep_conversion_type,omitempty"`
	// CampaignDeepConversionTypeName 智能模式下的深度优化目标名称
	CampaignDeepConversionTypeName string `json:"campaign_deep_conversion_type_name,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// UpdateTime 更新时间
	UpdateTime string `json:"update_time,omitempty"`
	// CapRoiRatio cost cap的roi约束(广告成本约束-ROI约束)
	// 范围：0~100
	CapRoiRatio float64 `json:"cap_roi_ratio,omitempty"`
	// CapBid cost cap的广告成本约束(广告成本约束-非ROI单/双约束)
	// 单位：厘，范围：0~8000元
	CapBid int64 `json:"cap_bid,omitempty"`
	// ÇonstraintCpa 浅层成本约束(广告成本约束-非ROI双约束)
	// 单位：厘，范围：0~8000元
	ConstraintCpa int64 `json:"constraint_cpa,omitempty"`
}

Campaign 广告计划

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 账号ID，在获取 access_token 的时候返回
	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：小程序推广 30：快手号-短剧推广
	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：开启
	AutoAdjust int `json:"auto_adjust,omitempty"`
	// AutoBuild 自动基建开关
	// 0：关闭，1：开启
	AutoBuild int `json:"auto_build,omitempty"`
	// AutoBuildNameRule 自动基建命名规则
	// 仅在auto_build为1时，此字段生效，开启自动基建时必填命名规则，组、创意命名规则均必须同时包含[日期]和[序号]宏变量【注：白名单功能】
	AutoBuildNameRule *AutoBuildNameRule `json:"auto_build_name_rule,omitempty"`
	// CapRoiRatio cost cap的roi约束(广告成本约束-ROI约束)
	// 默认0表示“不限”，新建计划时仅支持“不限”，当计划下存在广告组选择ROI出价，编辑时支持修为该约束
	CapRoiRatio float64 `json:"cap_roi_ratio,omitempty"`
	//  CapBid cost cap的成本约束(广告成本约束-非ROI单/双约束)
	// 默认0表示“不限”，新建计划时仅支持“不限”，当计划下存在广告组选择非ROI出价，编辑时支持修为该约束
	CapBid int64 `json:"cap_bid,omitempty"`
	// ConstraintCpa 浅层成本约束(广告成本约束-非ROI双约束)
	// 默认0表示“不限”，新建计划时仅支持“不限”，当计划下存在广告组选择自然日次日留存，编辑时支持修为该约束
	ConstraintCpa int64 `json:"constrait_cpa,omitempty"`
	// AutoManage 全自动投放开关 (UAX，支持UAA和UAL)
	// 0：关闭，1：开启 【注：此字段设置为开启时， 需要开启auto_adjust和auto_build 字段】 根据行业区分UAA&UAL具体详情可联系对应运营加白
	AutoManage int `json:"auto_manage,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
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划 ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignName 计划名称
	CampaignName string `json:"campaign_name,omitempty"`
	// CampaignIDs 广告计划Id集
	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 开始时间
	// 与 end_date 同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应 update_time 信息
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间
	// 与 start_date 同时传或同时不传；过滤筛选条件，格式为"yyyy-MM-dd"，参数值对应 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 int        `json:"total_count,omitempty"`
	Details    []Campaign `json:"details,omitempty"`
}

ListResponse 获取广告计划信息 API Response

type UpdateRequest 

type UpdateRequest struct {
	// AdvertiserID 账号ID，在获取 access_token 的时候返回
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划 ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignName 广告计划名称
	// 长度为 1-100 个字符，同一个账号下面计划名称不能重复
	CampaignName string `json:"campaign_name,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"`
	// AutoAdjust 自动调控开关
	// 0：关闭，1：开启
	AutoAdjust *int `json:"auto_adjust,omitempty"`
	// AutoBuild 自动基建开关
	// 0：关闭，1：开启
	AutoBuild *int `json:"auto_build,omitempty"`
	// AutoBuildNameRule 自动基建命名规则
	// 仅在auto_build为1时，此字段生效，开启自动基建时必填命名规则，组、创意命名规则均必须同时包含[日期]和[序号]宏变量【注：白名单功能】
	AutoBuildNameRule *AutoBuildNameRule `json:"auto_build_name_rule,omitempty"`
	// CapRoiRatio cost cap的roi约束(广告成本约束-ROI约束)
	// 默认0表示“不限”，新建计划时仅支持“不限”，当计划下存在广告组选择ROI出价，编辑时支持修为该约束
	CapRoiRatio *float64 `json:"cap_roi_ratio,omitempty"`
	//  CapBid cost cap的成本约束(广告成本约束-非ROI单/双约束)
	// 默认0表示“不限”，新建计划时仅支持“不限”，当计划下存在广告组选择非ROI出价，编辑时支持修为该约束
	CapBid *int64 `json:"cap_bid,omitempty"`
	// ConstraintCpa 浅层成本约束(广告成本约束-非ROI双约束)
	// 默认0表示“不限”，新建计划时仅支持“不限”，当计划下存在广告组选择自然日次日留存，编辑时支持修为该约束
	ConstraintCpa *int64 `json:"constrait_cpa,omitempty"`
	// PutStatus 投放状态
	// 1-投放中、2-暂停、3-删除
	PutStatus int `json:"put_status,omitempty"`
	// AutoManage 全自动投放开关 (UAX，支持UAA和UAL)
	// 0：关闭，1：开启 【注：此字段设置为开启时， 需要开启auto_adjust和auto_build 字段】 根据行业区分UAA&UAL具体详情可联系对应运营加白
	AutoManage *int `json:"auto_manage,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

type UpdateStatusRequest 

type UpdateStatusRequest struct {
	// AdvertiserID 广告主 ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划 ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignIDs 与原有的 campaign_id 字段可以同时填，也可以只填一个
	// 1.传入的计划 id 不得重复，且至少有一个;传入的 campaign_id 总数最多 20 个。2.put_status 为 3 时，会删除广告计划，和计划下的所有广告组，程序化创意，创意
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
	// PutStatus 操作码
	// 1-投放、2-暂停、3-删除，传其他数字非法
	PutStatus int `json:"put_status,omitempty"`
}

UpdateStatusRequest 修改广告计划状态 API Request

func (UpdateStatusRequest) Encode 

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateStatusRequest) Url 

func (r UpdateStatusRequest) Url() string

Url implement PostRequest interface

type UpdateStatusResponse 

type UpdateStatusResponse struct {
	// CampaignIDs 所有修改状态成功的计划 id
	// 假如接口的入参 campaign_id 传了值且修改状态成功，则此广告计划 id 也会包含在返回值 campaign_ids 里面。
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
}

UpdateStatusResponse 修改广告计划状态 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.