campaign

Documentation

Overview

Package campaign 广告计划相关API models

Index

• type Campaign
• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type CreateResponseData
• type GetFiltering
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData
• type UpdateError
  • func (r UpdateError) Error() string
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte
• type UpdateResponse
• type UpdateResponseData
• type UpdateStatusRequest
  • func (r UpdateStatusRequest) Encode() []byte

Types

type Campaign

type Campaign struct {
	// ID 广告组ID
	ID uint64 `json:"id,omitempty"`
	// Name 广告组名称
	Name string `json:"name,omitempty"`
	// Budget 广告组预算
	Budget float64 `json:"budget,omitempty"`
	// BudgetMode 广告组预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// LandingType 广告组推广目的
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// Status 广告组状态
	Status enum.CampaignStatus `json:"status,omitempty"`
	// CampaignCreateTime 广告组创建时间, 格式：yyyy-mm-dd hh:MM:ss
	CampaignCreateTime string `json:"campaign_create_time,omitempty"`
	// CampaignModifyTime 广告组修改时间, 格式：yyyy-mm-dd hh:MM:ss
	CampaignModifyTime string `json:"campaign_modify_time,omitempty"`
	// MarketingPurpose 营销目的，允许值"CONVERSION"行动转化、"INTENTION"用户意向、"ACKNOWLEDGE"品牌认知
	MarketingPurpose enum.MarketingPurpose `json:"marketing_purpose,omitempty"`
	// DeliveryRelatedNum 广告组商品类型
	DeliveryRelatedNum enum.CampaignDPA `json:"delivery_related_num,omitempty"`
	// DeliveryMode 投放类型，允许值：MANUAL（手动）、PROCEDURAL（自动，投放管家）
	DeliveryMode string `json:"delivery_mode,omitempty"`
	// CampaignBudgetOptimization 支持预算择优分配允许值：
	// ON 开启，OFF 不开启(默认值)
	// 广告主商品类型为CAMPAIGN_DPA_MULTI_DELIVERY时不允许开启预算择优分配
	CampaignBudgetOptimization enum.OnOff `json:"campaign_budget_optimization,omitempty"`
	// SmartBidType 出价方式（投放场景），campaign_budget_optimization为ON时必填，且必须为SMART_BID_NO_BID
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
}

Campaign 广告组信息

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignName 广告组名称，长度为1-100个字符，其中1个中文字符算2位
	CampaignName string `json:"campaign_name,omitempty"`
	// Operation 广告组状态, 允许值: "enable","disable"默认值：enable开启状态
	Operation string `json:"operation,omitempty"`
	// BudgetMode 广告组预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 广告组预算，取值范围: ≥ 0; 当budget_mode为"BUDGET_MODE_DAY"时,必填,且日预算不少于300	元
	Budget float64 `json:"budget,omitempty"`
	// LandingType 广告组推广目的
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// CampaignType 广告组类型，允许值FEED信息流、SEARCH搜索广告
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
	// MarketingPurpose 营销目的，允许值CONVERSION行动转化、INTENTION用户意向、ACKNOWLEDGE品牌认知
	// 创建新版营销链路广告组，该字段必填
	MarketingPurpose enum.MarketingPurpose `json:"marketing_purpose,omitempty"`
	// DeliveryRelatedNum 广告组商品类型
	DeliveryRelatedNum enum.CampaignDPA `json:"delivery_related_num,omitempty"`
	// CampaignBudgetOptimization 支持预算择优分配允许值：
	// ON 开启，OFF 不开启(默认值)
	// 广告主商品类型为CAMPAIGN_DPA_MULTI_DELIVERY时不允许开启预算择优分配
	CampaignBudgetOptimization enum.OnOff `json:"campaign_budget_optimization,omitempty"`
	// SmartBidType 出价方式（投放场景），campaign_budget_optimization为ON时必填，且必须为SMART_BID_NO_BID
	SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"`
	// UniqueFk 第三方唯一键，传该值时保证接口重试的幂等性，请注意，带有相同unique_fk的请求服务端会视为同一个广告处理。仅在创建接口传入且无法修改，如果创建时传入了已存在的唯一键值，那么会返回该唯一键值所对应的广告组ID。该值可用于内部系统会生成的唯一ID与头条ID做关联的场景，避免超时重试实际上一次创建请求又成功导致的重复创建问题，通过unique_fk可与内部系统ID实现关联并避免重复创建，可结合实际场景选择使用，广告组中的unique_fk要求不重复，与计划中的unique_fk无相关。
	UniqueFk string `json:"unique_fk,omitempty"`
}

CreateRequest 创建广告组 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse

type CreateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *CreateResponseData `json:"data,omitempty"`
}

CreateResponse 创建广告组 API Response

type CreateResponseData

type CreateResponseData struct {
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
}

CreateResponseData json返回值

type GetFiltering

type GetFiltering struct {
	// IDs 广告组ID过滤，数组，不超过100个
	IDs []uint64 `json:"ids,omitempty"`
	// CampaignName 广告组name过滤，长度为1-30个字符，其中1个中文字符算2位
	CampaignName string `json:"campaign_name,omitempty"`
	// LandingType 广告组推广目的过滤
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// Status 广告组状态过滤，默认为返回“所有不包含已删除”，如果要返回所有包含已删除有对应枚举表示
	Status enum.CampaignStatus `json:"status,omitempty"`
	// CampaignCreateTime 广告组创建时间，格式yyyy-mm-dd，表示过滤出当天创建的广告组
	CampaignCreateTime string `json:"campaign_create_time,omitempty"`
}

GetFiltering 过滤条件

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件，若此字段不传，或传空则视为无限制条件
	Filtering *GetFiltering `json:"filtering,omitempty"`
	// Fields 查询字段集合, 如果指定, 则返回结果数组中, 每个元素是包含所查询字段的字典；允许值:"id", "name","budget", "budget_mode","landing_type","status","modify_time", "status","modify_time","campaign_modify_time","campaign_create_time"一定会返回
	Fields []string `json:"fields,omitempty"`
	// Page 当前页码: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小 默认值: 10， 取值范围：1-1000
	PageSize int `json:"page_size,omitempty"`
}

GetRequest 获取广告组 API Request

func (GetRequest) Encode

func (r GetRequest) Encode() string

Encode implement GetRequest interface

type GetResponse

type GetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *GetResponseData `json:"data,omitempty"`
}

GetResponse 获取广告组 API Response

type GetResponseData

type GetResponseData struct {
	// List campaign list
	List []Campaign `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

GetResponseData json返回值

type UpdateError

type UpdateError struct {
	// CampaignID 广告组ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// ErrorMessage 错误信息
	ErrorMessage string `json:"error_message,omitempty"`
}

UpdateError 更新失败错误

func (UpdateError) Error

func (r UpdateError) Error() string

Error implement error interface

type UpdateRequest

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告组ID，广告组ID需要属于广告主ID，否则会报错！
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// ModifyTime 时间戳（从campaign/get/接口得到,用于判断是否基于最新信息修改，正确获取与填写，以免报错！)
	ModifyTime string `json:"modify_time,omitempty"`
	// CampaignName 广告组名称，长度为1-100个字符，其中1个中文字符算2位
	CampaignName string `json:"campaign_name,omitempty"`
	// BudgetMode 广告组预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 广告组预算，取值范围: ≥ 0; 当budget_mode为"BUDGET_MODE_DAY"时,必填,且日预算不少于300	元
	Budget float64 `json:"budget,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 {
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignIDs 广告组id
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
	// Errors 更新失败的广告组列表
	Errors []UpdateError `json:"errors,omitempty"`
}

UpdateResponseData json返回值

type UpdateStatusRequest

type UpdateStatusRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignIDs 广告组ID，不超过100个，且广告组ID属于广告主ID否则会报错；
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
	// OptStatus 操作, "enable"表示启用, "delete"表示删除, "disable"表示暂停；允许值: "enable", "delete", "disable",; 对于删除的广告组不可进行任何操作，否则会报错哈
	OptStatus string `json:"opt_status,omitempty"`
}

UpdateStatusRequest 广告组更新状态 API Request

func (UpdateStatusRequest) Encode

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface