campaign

Documentation

Overview

Package campaign 广告组管理

Index

• type Campaign
• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type CreateResponseData
• type ListGetFiltering
• type ListGetRequest
  • func (r ListGetRequest) Encode() string
• type ListGetResponse
• type ListGetResponseData
• type UpdateError
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte
• type UpdateStatusRequest
  • func (r UpdateStatusRequest) Encode() []byte
• type UpdateStatusResponse
• type UpdateStatusResponseData

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"`
	// MarketingGoal 广告组营销目标，VIDEO_PROM_GOODS：短视频带货、LIVE_PROM_GOODS：直播带货。
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Status 广告组状态
	Status string `json:"status,omitempty"`
	// CreateDate 广告组创建日期, 格式：yyyy-mm-dd
	CreateDate string `json:"create_date,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"`
	// MarketingGoal 营销目标
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// BudgetMode 广告组预算类型
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 广告组预算，取值范围: ≥ 0; 当budget_mode为"BUDGET_MODE_DAY"时,必填,且日预算不少于300	元
	Budget float64 `json:"budget,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 ListGetFiltering

type ListGetFiltering struct {
	// IDs 广告组ID列表，目前只支持一个
	IDs []uint64 `json:"ids,omitempty"`
	// Name 广告组名称关键字，长度为1-30个字符，其中1个中文字符算2位
	Name string `json:"name,omitempty"`
	// MarketingGoal 广告组营销目标，允许值：VIDEO_PROM_GOODS：短视频带货、LIVE_PROM_GOODS：直播带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// Status 广告组状态，允许值：ALL：所有包含已删除、ENABLE：启用、DISABLE：暂停、DELETE：已删除。不传入即默认返回“所有不包含已删除”
	Status string `json:"status,omitempty"`
}

ListGetFiltering 过滤条件

type ListGetRequest

type ListGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件，若此字段不传，或传空则视为无限制条件
	Filtering *ListGetFiltering `json:"filtering,omitempty"`
	// Page 当前页码: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小 默认值: 10， 取值范围：1-1000
	PageSize int `json:"page_size,omitempty"`
}

ListGetRequest 获取广告组 API Request

func (ListGetRequest) Encode

func (r ListGetRequest) Encode() string

Encode implement GetRequest interface

type ListGetResponse

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

ListGetResponse 广告组列表获取 API Response

type ListGetResponseData

type ListGetResponseData struct {
	// PageInfo 分页信息
	PageInfo model.PageInfo `json:"page_info,omitempty"`
	// List 广告组列表
	List []Campaign `json:"list,omitempty"`
}

ListGetResponseData json返回值

type UpdateError

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

UpdateError 更新失败错误

type UpdateRequest

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告组ID，广告组ID需要属于广告主ID，否则会报错！
	CampaignID uint64 `json:"campaign_id,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 UpdateStatusRequest

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

UpdateStatusRequest 广告组更新状态 API Request

func (UpdateStatusRequest) Encode

func (r UpdateStatusRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateStatusResponse

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

type UpdateStatusResponseData

type UpdateStatusResponseData struct {
	// Success 更新成功的广告组ID列表
	Success []uint64 `json:"success,omitempty"`
	// Errors 更新失败的广告组列表
	Errors []UpdateError `json:"errors,omitempty"`
}

UpdateStatusResponseData json返回值