pentraprism

package
v1.2.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package pentraprism 包含五棱镜任务API相关结构体

https://open.taobao.com/API.htm?docType=2&docId=52767

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type OpenTaskInfoVo 

type OpenTaskInfoVo struct {
	// 任务奖励对象
	Rewards []TaskRewardVo `json:"rewards,omitempty" xml:"rewards>task_reward_vo,omitempty"`
	// 扩展型任务子列表对象
	SubList []OpenTaskInfoVo `json:"sub_list,omitempty" xml:"sub_list>open_task_info_vo,omitempty"`
	// 任务信息token，用于回流输入
	FromToken string `json:"from_token,omitempty" xml:"from_token,omitempty"`
	// 任务状态
	Status string `json:"status,omitempty" xml:"status,omitempty"`
	// 任务子类型
	TaskSubType string `json:"task_sub_type,omitempty" xml:"task_sub_type,omitempty"`
	// 任务类型
	TaskType string `json:"task_type,omitempty" xml:"task_type,omitempty"`
	// 做任务时间
	Time string `json:"time,omitempty" xml:"time,omitempty"`
	// 任务分组ID
	GroupId int64 `json:"group_id,omitempty" xml:"group_id,omitempty"`
	// 任务分组所在位置，用户再次排序
	GroupIndex int64 `json:"group_index,omitempty" xml:"group_index,omitempty"`
	// 投放ID
	Id int64 `json:"id,omitempty" xml:"id,omitempty"`
	// 分组内位置
	Index int64 `json:"index,omitempty" xml:"index,omitempty"`
	// 任务进度对象
	Progress *TaskProgressVo `json:"progress,omitempty" xml:"progress,omitempty"`
	// 扩展类任务标记，标记是否为当前任务
	IsCurrent bool `json:"is_current,omitempty" xml:"is_current,omitempty"`
	// 是否今天完成的
	IsToday bool `json:"is_today,omitempty" xml:"is_today,omitempty"`
}

OpenTaskInfoVo 结构体

type OpenTaskPo 

type OpenTaskPo struct {
	// 应用名称
	AppName string `json:"app_name,omitempty" xml:"app_name,omitempty"`
	// 应用版本
	AppVersion string `json:"app_version,omitempty" xml:"app_version,omitempty"`
	// 来源详细标识
	FromAppName string `json:"from_app_name,omitempty" xml:"from_app_name,omitempty"`
	// 分享任务的token，回流的时候传入
	FromToken string `json:"from_token,omitempty" xml:"from_token,omitempty"`
	// 幂等ID，业务控制
	ImplId string `json:"impl_id,omitempty" xml:"impl_id,omitempty"`
	// 做任务时间
	Now string `json:"now,omitempty" xml:"now,omitempty"`
	// 请求对应任务的token，从五棱镜后台生成
	OpenToken string `json:"open_token,omitempty" xml:"open_token,omitempty"`
	// 操作系统名称
	Platform string `json:"platform,omitempty" xml:"platform,omitempty"`
	// 领奖励位置，默认为null
	AwardIndex int64 `json:"award_index,omitempty" xml:"award_index,omitempty"`
	// 任务系统后台配置投放ID
	DeliveryId int64 `json:"delivery_id,omitempty" xml:"delivery_id,omitempty"`
	// 任务系统后台配置场景ID
	SceneId int64 `json:"scene_id,omitempty" xml:"scene_id,omitempty"`
	// 用户类别，微博用户写死userType=2
	UserType int64 `json:"user_type,omitempty" xml:"user_type,omitempty"`
	// 是否忽略任务规则
	IgnoreRules bool `json:"ignore_rules,omitempty" xml:"ignore_rules,omitempty"`
}

OpenTaskPo 结构体

type TaobaoPentaprismTaskQueryitemAPIRequest added in v1.2.0 

type TaobaoPentaprismTaskQueryitemAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaoPentaprismTaskQueryitemAPIRequest 查询任务当前进度 API请求 taobao.pentaprism.task.queryitem

外网用户查询五棱镜任务系统当前进度

func NewTaobaoPentaprismTaskQueryitemRequest 

func NewTaobaoPentaprismTaskQueryitemRequest() *TaobaoPentaprismTaskQueryitemAPIRequest

NewTaobaoPentaprismTaskQueryitemRequest 初始化TaobaoPentaprismTaskQueryitemAPIRequest对象

func (TaobaoPentaprismTaskQueryitemAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoPentaprismTaskQueryitemAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaoPentaprismTaskQueryitemAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoPentaprismTaskQueryitemAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaoPentaprismTaskQueryitemAPIRequest) GetOpenPo added in v1.2.0 

func (r TaobaoPentaprismTaskQueryitemAPIRequest) GetOpenPo() *OpenTaskPo

GetOpenPo OpenPo Getter

func (TaobaoPentaprismTaskQueryitemAPIRequest) GetRawParams added in v1.2.8 

func (r TaobaoPentaprismTaskQueryitemAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (*TaobaoPentaprismTaskQueryitemAPIRequest) SetOpenPo added in v1.2.0 

func (r *TaobaoPentaprismTaskQueryitemAPIRequest) SetOpenPo(_openPo *OpenTaskPo) error

SetOpenPo is OpenPo Setter TOP接口标准入参

type TaobaoPentaprismTaskQueryitemAPIResponse 

type TaobaoPentaprismTaskQueryitemAPIResponse struct {
	model.CommonResponse
	TaobaoPentaprismTaskQueryitemAPIResponseModel
}

TaobaoPentaprismTaskQueryitemAPIResponse 查询任务当前进度 API返回值 taobao.pentaprism.task.queryitem

外网用户查询五棱镜任务系统当前进度

type TaobaoPentaprismTaskQueryitemAPIResponseModel added in v1.2.0 

type TaobaoPentaprismTaskQueryitemAPIResponseModel struct {
	XMLName xml.Name `xml:"pentaprism_task_queryitem_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// TOP接口标准出参
	Result *TaskResult `json:"result,omitempty" xml:"result,omitempty"`
}

TaobaoPentaprismTaskQueryitemAPIResponseModel is 查询任务当前进度 成功返回结果

type TaobaoPentaprismTaskTriggerAPIRequest added in v1.2.0 

type TaobaoPentaprismTaskTriggerAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

TaobaoPentaprismTaskTriggerAPIRequest 推进单条任务进度 API请求 taobao.pentaprism.task.trigger

外网用户推进单条五棱镜任务进度

func NewTaobaoPentaprismTaskTriggerRequest 

func NewTaobaoPentaprismTaskTriggerRequest() *TaobaoPentaprismTaskTriggerAPIRequest

NewTaobaoPentaprismTaskTriggerRequest 初始化TaobaoPentaprismTaskTriggerAPIRequest对象

func (TaobaoPentaprismTaskTriggerAPIRequest) GetApiMethodName added in v1.2.0 

func (r TaobaoPentaprismTaskTriggerAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (TaobaoPentaprismTaskTriggerAPIRequest) GetApiParams added in v1.2.0 

func (r TaobaoPentaprismTaskTriggerAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (TaobaoPentaprismTaskTriggerAPIRequest) GetOpenPo added in v1.2.0 

func (r TaobaoPentaprismTaskTriggerAPIRequest) GetOpenPo() *OpenTaskPo

GetOpenPo OpenPo Getter

func (TaobaoPentaprismTaskTriggerAPIRequest) GetRawParams added in v1.2.8 

func (r TaobaoPentaprismTaskTriggerAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (*TaobaoPentaprismTaskTriggerAPIRequest) SetOpenPo added in v1.2.0 

func (r *TaobaoPentaprismTaskTriggerAPIRequest) SetOpenPo(_openPo *OpenTaskPo) error

SetOpenPo is OpenPo Setter TOP接口标准入参

type TaobaoPentaprismTaskTriggerAPIResponse 

type TaobaoPentaprismTaskTriggerAPIResponse struct {
	model.CommonResponse
	TaobaoPentaprismTaskTriggerAPIResponseModel
}

TaobaoPentaprismTaskTriggerAPIResponse 推进单条任务进度 API返回值 taobao.pentaprism.task.trigger

外网用户推进单条五棱镜任务进度

type TaobaoPentaprismTaskTriggerAPIResponseModel added in v1.2.0 

type TaobaoPentaprismTaskTriggerAPIResponseModel struct {
	XMLName xml.Name `xml:"pentaprism_task_trigger_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// TOP接口标准出参
	Result *TaskResult `json:"result,omitempty" xml:"result,omitempty"`
}

TaobaoPentaprismTaskTriggerAPIResponseModel is 推进单条任务进度 成功返回结果

type TaskProgressVo 

type TaskProgressVo struct {
	// 任务完成时间
	FinishedTime string `json:"finished_time,omitempty" xml:"finished_time,omitempty"`
	// 任务状态，“INIT”为初始化状态
	Status string `json:"status,omitempty" xml:"status,omitempty"`
	// 任务冷却时间，-1标识无冷却
	CdTime int64 `json:"cd_time,omitempty" xml:"cd_time,omitempty"`
	// 扩展性任务索引
	Index int64 `json:"index,omitempty" xml:"index,omitempty"`
	// 触发多少次任务算完成
	LoopTimes int64 `json:"loop_times,omitempty" xml:"loop_times,omitempty"`
	// 任务完成最大上限
	MaxTimes int64 `json:"max_times,omitempty" xml:"max_times,omitempty"`
	// 还需要做多少次任务才能做完
	NeedTimes int64 `json:"need_times,omitempty" xml:"need_times,omitempty"`
	// 任务周期
	Period int64 `json:"period,omitempty" xml:"period,omitempty"`
	// 任务已经触发的次数
	Times int64 `json:"times,omitempty" xml:"times,omitempty"`
	// 是否达到任务上限
	ReachLimit bool `json:"reach_limit,omitempty" xml:"reach_limit,omitempty"`
}

TaskProgressVo 结构体

type TaskResult 

type TaskResult struct {
	// 错误码
	ErrorCode string `json:"error_code,omitempty" xml:"error_code,omitempty"`
	// 错误详细信息
	ErrorMsg string `json:"error_msg,omitempty" xml:"error_msg,omitempty"`
	// 做任务时间
	Now string `json:"now,omitempty" xml:"now,omitempty"`
	// 任务完成个数
	FinishCount int64 `json:"finish_count,omitempty" xml:"finish_count,omitempty"`
	// 任务数据返回对象
	Model *OpenTaskInfoVo `json:"model,omitempty" xml:"model,omitempty"`
	// 匹配命中任务数量
	TotalCount int64 `json:"total_count,omitempty" xml:"total_count,omitempty"`
	// 请求是否成功
	Success bool `json:"success,omitempty" xml:"success,omitempty"`
}

TaskResult 结构体

type TaskRewardItemVo 

type TaskRewardItemVo struct {
	// 奖励发放图标
	Icon string `json:"icon,omitempty" xml:"icon,omitempty"`
	// 激励模式 用于展示 "NONE"表示无激励
	Mode string `json:"mode,omitempty" xml:"mode,omitempty"`
	// 总库存格式化带单位 万/亿
	OwnCountText string `json:"own_count_text,omitempty" xml:"own_count_text,omitempty"`
	// 奖励类型
	Type string `json:"type,omitempty" xml:"type,omitempty"`
	// 单位 用于展示
	Unit string `json:"unit,omitempty" xml:"unit,omitempty"`
	// 基础发放量
	BaseCount int64 `json:"base_count,omitempty" xml:"base_count,omitempty"`
	// 奖励模板ID
	ConfigId int64 `json:"config_id,omitempty" xml:"config_id,omitempty"`
	// 奖励激励值
	Encourage int64 `json:"encourage,omitempty" xml:"encourage,omitempty"`
	// 最终奖励发放数量
	FinalCount int64 `json:"final_count,omitempty" xml:"final_count,omitempty"`
	// 奖励区间最大值 用于展示
	MaxCount int64 `json:"max_count,omitempty" xml:"max_count,omitempty"`
	// 奖励区间最小值 用于展示
	MinCount int64 `json:"min_count,omitempty" xml:"min_count,omitempty"`
	// 库存量
	OwnCount int64 `json:"own_count,omitempty" xml:"own_count,omitempty"`
	// 成就点
	PointCount int64 `json:"point_count,omitempty" xml:"point_count,omitempty"`
}

TaskRewardItemVo 结构体

type TaskRewardVo 

type TaskRewardVo struct {
	// 查询奖励错误码
	ErrorCode string `json:"error_code,omitempty" xml:"error_code,omitempty"`
	// 发奖励类型
	Type string `json:"type,omitempty" xml:"type,omitempty"`
	// 奖励详细信息
	Result *TaskRewardItemVo `json:"result,omitempty" xml:"result,omitempty"`
	// 发奖励时间
	Time int64 `json:"time,omitempty" xml:"time,omitempty"`
	// 查询奖励详细错误信息
	Success bool `json:"success,omitempty" xml:"success,omitempty"`
	// 是否领奖
	Win bool `json:"win,omitempty" xml:"win,omitempty"`
}

TaskRewardVo 结构体

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.