v3

Documentation

Index

• type AppointedTime
• type PromotionRaiseStatus
• type RaiseInfo
• type RepeatedDayType
• type SetRequest
  • func (r SetRequest) Encode() []byte
• type StatusGetRequest
  • func (r StatusGetRequest) Encode() string
• type StatusGetResponse
• type StopRequest
  • func (r StopRequest) Encode() []byte
• type SuggestBudget
• type SuggestBudgetGetRequest
  • func (r SuggestBudgetGetRequest) Encode() string
• type SuggestBudgetGetResponse
• type Version
• type VersionGetRequest
  • func (r VersionGetRequest) Encode() string
• type VersionGetResponse
• type VersionGetResponseData

Types

type AppointedTime

type AppointedTime struct {
	// RepeatedDay 重复周期，仅生效一次。不传则不重复，传入EVERY_DAY则每天重复
	// 允许值：
	// PER_MONDAY；PER_TUESDAY；PER_WEDNESDAY；PER_THURSDAY；PER_FRIDAY：PER_SATURDAY；PER_SUNDAY；EVERY_DAY
	// EVERY_DAY和其他允许值不可同时传入
	RepeatedDay []RepeatedDayType `json:"repeated_day,omitempty"`
	// RaiseTime 起量时间
	// 重复周期不传时，格式为yyyy-mm-dd HH:MM
	// 传重复周期时，格式为HH:MM
	RaiseTime string `json:"raise_time,omitempty"`
}

type PromotionRaiseStatus

type PromotionRaiseStatus struct {
	// RaiseInfo 起量信息
	RaiseInfo []RaiseInfo `json:"raise_info,omitempty"`
}

type RaiseInfo

type RaiseInfo struct {
	// RaiseBudget 起量预算，单位：元，允许小数点后两位起量预算需大于等于计划出价，小于等于计划预算
	RaiseBudget float64 `json:"raise_budget,omitempty"`
	// IsEffectiveNow 是否立即生效，仅支持广告状态为“投放中”的广告，仅支持1个方案设置“立即生效”，传入True时不支持填写appointed_time
	IsEffectiveNow bool `json:"is_effective_now,omitempty"`
	// AppointedTime 指定投放时间，当is_effective_now为FALSE时填写有效
	AppointedTime *AppointedTime `json:"appointed_time,omitempty"`
}

RaiseInfo 起量信息

type RepeatedDayType

type RepeatedDayType string

RepeatedDayType 重复周期

const (
	PER_MONDAY    RepeatedDayType = "PER_MONDAY"
	PER_TUESDAY   RepeatedDayType = "PER_TUESDAY"
	PER_WEDNESDAY RepeatedDayType = "PER_WEDNESDAY"
	PER_THURSDAY  RepeatedDayType = "PER_THURSDAY"
	PER_FRIDAY    RepeatedDayType = "PER_FRIDAY"
	PER_SATURDAY  RepeatedDayType = "PER_SATURDAY"
	PER_SUNDAY    RepeatedDayType = "PER_SUNDAY"
	EVERY_DAY     RepeatedDayType = "EVERY_DAY"
)

type SetRequest

type SetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PromotionID 广告计划id
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// RaiseInfo 起量信息，最多支持6个，如果需要删除请传[]
	RaiseInfo []RaiseInfo `json:"raise_info,omitempty"`
}

SetRequest 设置一键起量 API Request

func (SetRequest) Encode

func (r SetRequest) Encode() []byte

Encode implement PostRequest interface

type StatusGetRequest

type StatusGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PromotionIDs 广告ID列表，目前仅支持1个
	PromotionIDs []uint64 `json:"promotion_ids,omitempty"`
}

StatusGetRequest 获取一键起量方案列表 API Request

func (StatusGetRequest) Encode

func (r StatusGetRequest) Encode() string

Encode implement GetRequest interface

type StatusGetResponse

type StatusGetResponse struct {
	model.BaseResponse
	// Data 返回数据
	Data struct {
		List []PromotionRaiseStatus `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

StatusGetResponse 获取广告建议起量预算 API Response

type StopRequest

type StopRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PromotionIDs 广告id
	PromotionIDs []uint64 `json:"promotion_ids,omitempty"`
}

StopRequest 关停一键起量 API Request

func (StopRequest) Encode

func (r StopRequest) Encode() []byte

Encode implement PostRequest interface

type SuggestBudget

type SuggestBudget struct {
	// PromotionID 广告ID
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// PromotionBudget 广告预算
	PromotionBudget float64 `json:"promotion_budget,omitempty"`
	// SuggestBudget 建议起量预算
	SuggestBudget float64 `json:"suggest_budget,omitempty"`
}

SuggestBudget 预算

type SuggestBudgetGetRequest

type SuggestBudgetGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PromotionIDs 广告ID列表，目前仅支持1个
	PromotionIDs []uint64 `json:"promotion_ids,omitempty"`
}

SuggestBudgetGetRequest 获取广告建议起量预算 API Request

func (SuggestBudgetGetRequest) Encode

func (r SuggestBudgetGetRequest) Encode() string

Encode implement GetRequest interface

type SuggestBudgetGetResponse

type SuggestBudgetGetResponse struct {
	model.BaseResponse
	Data struct {
		// List 预算列表
		List []SuggestBudget `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

SuggestBudgetGetResponse 获取广告建议起量预算 API Response

type Version

type Version struct {
	// RaiseVersion 起量版本号
	RaiseVersion uint64 `json:"raise_version,omitempty"`
	// StartTime 当前版本起量开始时间，格式：2021-03-31 16:00:00
	StartTime string `json:"start_time,omitempty"`
	// EndTime 当前起量版本结束时间，格式：2021-03-31 17:00:00
	EndTime string `json:"end_time,omitempty"`
}

Version 起量版本

type VersionGetRequest

type VersionGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PromotionID 广告ID
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// Page 页码，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，允许值：1-100，默认值：10
	PageSize int `json:"page_size,omitempty"`
}

VersionGetRequest 获取起量版本信息 API Request

func (VersionGetRequest) Encode

func (r VersionGetRequest) Encode() string

Encode implement GetRequest interface

type VersionGetResponse

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

VersionGetResponse 获取起量版本信息 API Response

type VersionGetResponseData

type VersionGetResponseData struct {
	// List 起量版本列表
	List []Version `json:"ad_raise_version_list,omitempty"`
	// PageInfo 页面信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

VersionGetResponseData json 返回值