campaign

Documentation

Index

• 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 GetResponseList
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte
• type UpdateResponse
• type UpdateResponseData
• type UpdateStatusRequest
  • func (r UpdateStatusRequest) Encode() []byte
• type UpdateStatusResponse
• type UpdateStatusResponseData

Types

type CreateRequest

type CreateRequest struct {
	AdvertiserID       uint64           `json:"advertiser_id,omitempty"`        // 广告主ID
	CampaignName       string           `json:"campaign_name,omitempty"`        // 广告组名称，长度为1-100个字符，其中1个中文字符算2位
	Operation          string           `json:"operation,omitempty"`            // 广告组状态, 允许值: "enable","disable"默认值：enable开启状态
	BudgetMode         enum.BudgetMode  `json:"budget_mode,omitempty"`          // 广告组预算类型
	Budget             float64          `json:"budget,omitempty"`               // 广告组预算，取值范围: ≥ 0; 当budget_mode为"BUDGET_MODE_DAY"时,必填,且日预算不少于300	元
	LandingType        enum.LandingType `json:"landing_type,omitempty"`         // 广告组推广目的
	UniqueFk           string           `json:"unique_fk,omitempty"`            // 第三方唯一键，传该值时保证接口重试的幂等性，请注意，带有相同unique_fk的请求服务端会视为同一个广告处理。仅在创建接口传入且无法修改，如果创建时传入了已存在的唯一键值，那么会返回该唯一键值所对应的广告组ID。该值可用于内部系统会生成的唯一ID与头条ID做关联的场景，避免超时重试实际上一次创建请求又成功导致的重复创建问题，通过unique_fk可与内部系统ID实现关联并避免重复创建，可结合实际场景选择使用，广告组中的unique_fk要求不重复，与计划中的unique_fk无相关。
	DeliveryRelatedNum enum.CampaignDPA `json:"delivery_related_num,omitempty"` // 广告组商品类型
}

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

type CreateResponse

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

type CreateResponseData

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

type GetFiltering

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

type GetRequest

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

func (GetRequest) Encode

func (r GetRequest) Encode() string

type GetResponse

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

type GetResponseData

type GetResponseData struct {
	List     []GetResponseList `json:"list,omitempty"`
	PageInfo *model.PageInfo   `json:"page_info,omitempty"`
}

type GetResponseList

type GetResponseList struct {
	ID                 uint64              `json:"id,omitempty"`                   // 广告组ID
	Name               string              `json:"name,omitempty"`                 // 广告组名称
	Budget             float64             `json:"budget,omitempty"`               // 广告组预算
	BudgetMode         enum.BudgetMode     `json:"budget_mode,omitempty"`          // 广告组预算类型
	LandingType        enum.LandingType    `json:"landing_type,omitempty"`         // 广告组推广目的
	Status             enum.CampaignStatus `json:"status,omitempty"`               // 广告组状态
	CampaignCreateTime string              `json:"campaign_create_time,omitempty"` // 广告组创建时间, 格式：yyyy-mm-dd hh:MM:ss
	CampaignModifyTime string              `json:"campaign_modify_time,omitempty"` // 广告组修改时间, 格式：yyyy-mm-dd hh:MM:ss
	UniqueFk           string              `json:"unique_fk,omitempty"`            // 第三方唯一键，传该值时保证接口重试的幂等性，带有相同unique_fk的请求服务端会视为同一个广告组处理。仅在创建接口传入且无法修改，如果创建时传入了已存在的唯一键值，那么会返回该唯一键值所对应的广告组ID。该值可用于内部系统会生成的唯一ID与头条ID做关联的场景，避免超时重试实际上一次创建请求又成功导致的重复创建问题，通过unique_fk可与内部系统ID实现关联并避免重复创建，可结合实际场景选择使用，广告组中的unique_fk要求不重复，与计划中的unique_fk无相关。
	DeliveryRelatedNum enum.CampaignDPA    `json:"delivery_related_num,omitempty"` // 广告组商品类型
	DeliveryMode       string              `json:"delivery_mode,omitempty"`        // 投放类型，允许值：MANUAL（手动）、PROCEDURAL（自动，投放管家）
}

type UpdateRequest

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

func (UpdateRequest) Encode

func (r UpdateRequest) Encode() []byte

type UpdateResponse

type UpdateResponse struct {
	model.BaseResponse
	Data *UpdateResponseData `json:"data,omitempty"`
}

type UpdateResponseData

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

type UpdateStatusRequest

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

func (UpdateStatusRequest) Encode

func (r UpdateStatusRequest) Encode() []byte

type UpdateStatusResponse

type UpdateStatusResponse struct {
	model.BaseResponse
	Data *UpdateStatusResponseData `json:"data,omitempty"`
}

type UpdateStatusResponseData

type UpdateStatusResponseData struct {
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"` // 广告组id
}