taskraise

Documentation

Overview

Package taskraise 账户优选起量 API models

Index

• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type DataGetRequest
  • func (r DataGetRequest) Encode() string
• type DataGetResponse
• type DataGetResponseData
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData
• type OptimizationIDsGetRequest
  • func (r OptimizationIDsGetRequest) Encode() string
• type OptimizationIDsGetResponse
• type Report
• type Stat
• type StatusStopRequest
  • func (r StatusStopRequest) Encode() []byte

Types

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// BudgetMode 预算设置，允许值: LIMIT 指定预算、NO_LIMIT 不限预算
	BudgetMode enum.TaskRaiseBudgetMode `json:"budget_mode,omitempty"`
	// PlatformVersion 创建优选起量任务的平台版本，不传值默认为巨量引擎平台原版，允许值：V2 巨量引擎体验版。可用于创建巨量引擎体验版上的账户优选起量任务
	PlatformVersion enum.PlatformVersion `json:"platform_version,omitempty"`
	// AllocatedBudget 日预算金额，当budget_mode为LIMIT时必填，范围：1000-9999999
	AllocatedBudget float64 `json:"allocated_budget,omitempty"`
	// EndTime 起量任务结束时间yyyy-mm-dd，传空为不限时长，起量将在指定日期0点结束
	EndTime string `json:"end_time,omitempty"`
	// RaiseMode 起量模式，允许值：常规起量CUSTOM（默认值）、强劲起量STRONG
	RaiseMode enum.TaskRaiseMode `json:"raise_mode,omitempty"`
}

CreateRequest 新建优选起量任务 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse

type CreateResponse struct {
	model.BaseResponse
	Data struct {
		// ReportID 任务id
		ReportID uint64 `json:"report_id,omitemtpy"`
	} `json:"data,omitempty"`
}

CreateResponse 新建优选起量任务 API Response

type DataGetRequest

type DataGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ReportID 任务id
	ReportID uint64 `json:"report_id,omitempty"`
}

DataGetRequest 查询优选起量任务数据 API Request

func (DataGetRequest) Encode

func (r DataGetRequest) Encode() string

Encode implement GetRequet interface

type DataGetResponse

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

DataGetResponse 查询优选起量任务数据 API Response

type DataGetResponseData

type DataGetResponseData struct {
	// Cost 消耗数据
	Cost Stat `json:"cost,omitempty"`
	// Show 展示数据
	ShowCnt Stat `json:"show_cnt,omitempty"`
	// Click 点击数据
	Click Stat `json:"click_cnt,omitempty"`
	// Convert 转化数据
	Convert Stat `json:"convert_cnt,omitempty"`
}

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformVersion 创建优选起量任务的平台版本，不传值默认为巨量引擎平台原版，允许值：V2 巨量引擎体验版。可用于创建巨量引擎体验版上的账户优选起量任务
	PlatformVersion enum.PlatformVersion `json:"platform_version,omitempty"`
	// Page 页数默认值: 1，page范围为[1,99999]
	Page int `json:"page,omitempty"`
	// PageSize 页面大小默认值:10，page_size范围为[1,100]
	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 {
	// Reports 任务详情
	Reports []Report `json:"reports,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

GetResponseData .

type OptimizationIDsGetRequest

type OptimizationIDsGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformVersion 创建优选起量任务的平台版本，不传值默认为巨量引擎平台原版，允许值：V2 巨量引擎体验版。可用于创建巨量引擎体验版上的账户优选起量任务
	PlatformVersion enum.PlatformVersion `json:"platform_version,omitempty"`
}

OptimizationIDsGetRequest 查询优选起量状态 API Request

func (OptimizationIDsGetRequest) Encode

func (r OptimizationIDsGetRequest) Encode() string

Encode implement GetRequest interface

type OptimizationIDsGetResponse

type OptimizationIDsGetResponse struct {
	model.BaseResponse
	Data struct {
		// Status 优选起量状态，枚举值: DISABLERAISE 不能开启起量、ENABLERAISE 可以开启起量、RAISING 起量中
		Status enum.TaskRaiseStatus `json:"status,omitemtpy"`
	} `json:"data,omitempty"`
}

OptimizationIDsGetResponse 查询优选起量状态 API Response

type Report

type Report struct {
	// ReportID 任务id
	ReportID uint64 `json:"report_id,omitempty"`
	// Name 任务名字
	Name string `json:"name,omitempty"`
	// RaiseMode 起量模式，允许值：常规起量CUSTOM、强劲起量STRONG
	RaiseMode enum.TaskRaiseMode `json:"raise_mode,omitempty"`
	// StartTime 任务开始时间
	StartTime string `json:"start_time,omitempty"`
	// Status 任务状态，枚举值: RAISING起量中、STOP 已结束
	Status enum.TaskRaiseStatus `json:"status,omitempty"`
	// BudgetMode 预算设置，枚举值: LIMIT 指定预算、NO_LIMIT 不限预算
	BudgetMode enum.TaskRaiseBudgetMode `json:"budget_model,omitemtpy"`
	// AllocatedBudget 日预算金额
	AllocatedBudget float64 `json:"allocated_budget,omitempty"`
	// IncreaseCost 消耗
	IncreaseCost float64 `json:"increase_cost,omitempty"`
	// Duration 生效天数
	Duration int `json:"duration,omitempty"`
}

Report 任务详情

type Stat

type Stat struct {
	// Base 基础数据
	Base string `json:"base_value,omitempty"`
	// Increased 起量任务数据
	Increased string `json:"increased_value,omitempty"`
}

type StatusStopRequest

type StatusStopRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ReportID 任务id
	ReportID uint64 `json:"report_id,omitempty"`
}

StatusStopRequest 关闭优选起量任务

func (StatusStopRequest) Encode

func (r StatusStopRequest) Encode() []byte

Encode implement PostRequest interface