campaign

Documentation

Overview

Package campaign 广告计划相关API

Index

• type CreateRequest
  • func (r CreateRequest) Encode() []byte
  • func (r CreateRequest) Url() string
• type CreateResponse
• type Details
• type ListRequest
  • func (r ListRequest) Encode() []byte
  • func (r ListRequest) Url() string
• type ListResponse
• type UpdateBudgetRequest
  • func (r UpdateBudgetRequest) Encode() []byte
  • func (r UpdateBudgetRequest) Url() string
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte
  • func (r UpdateRequest) Url() string
• type UpdateResponse
• type UpdateStatusRequest
  • func (r UpdateStatusRequest) Encode() []byte
  • func (r UpdateStatusRequest) Url() string
• type UpdateStatusResponse

Types

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：商品库推广 13：小店商品推广 14：直播推广
	Type int `json:"type,omitempty"`
	// SubType 商品广告类型;5：SDPA 4:DPA 当type为9时，sub_type必为4、5两者之一。（目前只支持类型5：SDPA）
	SubType int `json:"sub_type,omitempty"`
	// DayBudget 单日预算金额;单位：厘，指定0表示预算不限，默认为0；不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget_schedule不能同时传，不能低于该计划下任一广告组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,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 Details

type Details struct {
	Status            int     `json:"status"`
	CampaignId        uint64  `json:"campaign_id"`
	CampaignName      string  `json:"campaign_name"`
	PutStatus         int     `json:"put_status"`
	CreateChannel     int     `json:"create_channel"`
	DayBudget         int64   `json:"day_budget"`
	DayBudgetSchedule []int64 `json:"day_budget_schedule"`
	CampaignType      int     `json:"campaign_type"`
	CampaignSubType   int     `json:"campaign_sub_type"`
	CreateTime        string  `json:"create_time"`
	UpdateTime        string  `json:"update_time"`

	AdType int `json:"ad_type"`
}

type ListRequest

type ListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID; 过滤筛选条件，若不传或传空则视为无限制条件
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// UnitID 广告组ID; 过滤筛选条件，若不传或传空则视为无限制条件
	UnitID uint64 `json:"unit_id,omitempty"`
	// UnitName 广告组名称
	UnitName string `json:"unit_name,omitempty"`
	// UnitIDs 广告组ID集
	UnitIDs []uint64 `json:"unit_ids,omitempty"`
	// Status 广告组状态;过滤筛选条件；-2：所有包含已删除 10：只包含已删除 不传：所有不包含已删除 其他值无效
	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"`
	Details    []Details `json:"details"`
}

ListResponse 获取广告计划信息 API Response

type UpdateBudgetRequest

type UpdateBudgetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignID 广告计划ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// DayBudget 单日预算金额;单位：厘，指定0表示预算不限，默认为0；不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget_schedule不能同时传，不能低于该计划下任一广告组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,omitempty"`
}

UpdateBudgetRequest 修改广告计划预算 API Request

func (UpdateBudgetRequest) Encode

func (r UpdateBudgetRequest) Encode() []byte

Encode implement PostRequest interface

func (UpdateBudgetRequest) Url

func (r UpdateBudgetRequest) Url() string

Url implement PostRequest interface

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"`
	// DayBudget 单日预算金额;单位：厘，指定0表示预算不限，默认为0；不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget_schedule不能同时传，不能低于该计划下任一广告组出价
	DayBudget int64 `json:"day_budget,omitempty"`
	// DayBudgetSchedule 分日预算; 单位：厘，指定0表示预算不限，默认为0；每天不小于500元，不超过100000000元，仅支持输入数字；修改预算不得低于该计划当日花费的120%，与day_budget不能同时传，均不能低于该计划下任一广告组出价
	DayBudgetSchedule []int64 `json:"day_budget_schedule,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