form

package
v1.25.1 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Overview

Package form 表单组件API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CountConfig 

type CountConfig struct {
	// CountType 计数方式; 可选值：COUNT_TYPE_INCREMENT（递增计数）、COUNT_TYPE_DECREMENT（递减计数）
	CountType CountType `json:"count_type,omitempty"`
	// Prefix 计数文案前缀，例如：“截止目前已有”，不超过100个字符
	Prefix string `json:"prefix,omitempty"`
	// StartNum 起始数值
	StartNum int `json:"start_num,omitempty"`
	// Suffix 计数文案后缀，例如：“名用户参加”，不超过100个字符
	Suffix string `json:"suffix,omitempty"`
}

CountConfig 计数配置，包括递增/递减、计数开始值、计数文案模版

type CountType 

type CountType string

CountType 计数方式 

const (
	// COUNT_TYPE_INCREMENT 递增计数
	COUNT_TYPE_INCREMENT CountType = "COUNT_TYPE_INCREMENT"
	// COUNT_TYPE_DECREMENT 递减计数
	COUNT_TYPE_DECREMENT CountType = "COUNT_TYPE_DECREMENT"
)

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Name 表单名称，不超过20个字符
	Name string `json:"name,omitempty"`
	// ValidateType 线索验证类型，主要指C端是否进行短信验证，表单中含有电话类型时生效
	ValidateType enum.ClueValidateType `json:"validate_type,omitempty"`
	// SubmitText 提交文案说明，如“提交表单”，文案长度不超过8个字符
	SubmitText string `json:"submit_text,omitempty"`
	// EnableLayer 是否开启分层，默认不开启; 枚举值：0，1（0表示不启用，1表示启用）
	EnableLayer int `json:"enable_layer,omitempty"`
	// LayerSubmitText 分层提交文案说明，分层信息在Elements中，当不开启分层时，所有分层信息无效。文案长度不超过8个字符
	LayerSubmitText string `json:"layer_submit_text,omitempty"`
	// Elements 表单元素
	Elements []FormElement `json:"elements,omitempty"`
	// ExtendInfo 扩展属性
	ExtendInfo *ExtendInfo `json:"extend_info,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 struct {
		// InstanceID 创建的表单实例id
		InstanceID uint64 `json:"instance_id,omitempty"`
	} `json:"data,omitempty"`
}

CreateResponse 创建表单 API Response

type DeleteRequest 

type DeleteRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceID 表单实例ID
	InstanceID uint64 `json:"instance_id,omitempty"`
}

DeleteRequest 删除表单 API Request

func (DeleteRequest) Encode 

func (r DeleteRequest) Encode() []byte

Encode implement PostRequest interface

type DeleteResponse 

type DeleteResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// Success 删除结果，true表示成功，false表示失败
		Success bool `json:"success,omitempty"`
	} `json:"data,omitempty"`
}

DeleteResponse 删除表单 API Response

type DetailRequest 

type DetailRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceID 表单实例ID，可从【表单创建】【表单列表获取】接口获取到
	InstanceID uint64 `json:"instance_id,omitempty"`
}

DetailRequest 获取表单详情 API Request

func (DetailRequest) Encode 

func (r DetailRequest) Encode() string

Encode implement GetRequest interface

type DetailResponse 

type DetailResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// Form 表单详细
		Form *Form `json:"form,omitempty"`
	} `json:"data,omitempty"`
}

DetailResponse 获取表单详情 API Response

type ExtendInfo 

type ExtendInfo struct {
	// CountConfig 计数配置，包括递增/递减、计数开始值、计数文案模版
	CountConfig *CountConfig `json:"count_config,omitempty"`
	// SignUpConfig 报名信息配置
	SignUpConfig *SignUpConfig `json:"sign_up_config,omitempty"`
	// SuccessTip 提交成功后的文案提示，文案长度不超过128个字符
	SuccessTip string `json:"success_tip,omitempty"`
}

ExtendInfo 扩展属性

type Form 

type Form struct {
	// InstanceID 表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 表单名称，不超过20个字符
	Name string `json:"name,omitempty"`
	// FormType 表单类型，目前不支持设置，仅支持查询时返回; 可选值：NORMAL_FORM（普通落地页）、ADVANCED_CREATIVE_FORM（附加创意）、NATIVE_FORM（原生表单）
	FormType FormType `json:"form_type,omitempty"`
	// ValidateType 线索验证类型，主要指C端是否进行短信验证，表单中含有电话类型时生效; 可选值：CLUE_PRIORITY（线索量优先）、VALIDITY_PRIORITY（有效性优先）、NONE_VERIFICATION（全不出）、AUTO_VERIFICATION（智能验证，历史逻辑，效果等同于全不出）、ALL_VERIFICATION（全出），详情见【附录-青鸟表单线索验证类型】
	ValidateType enum.ClueValidateType `json:"validate_type,omitempty"`
	// SubmitText 提交文案说明，如“提交表单”，文案长度不超过8个字符
	SubmitText string `json:"submit_text,omitempty"`
	// EnableLayer 是否开启分层; 枚举值：0，1（0表示不启用，1表示启用）
	EnableLayer int `json:"enable_layer,omitempty"`
	// LayerSubmitText 分层提交文案说明，分层信息在Elements中，当不开启分层时，所有分层信息无效。文案长度不超过8个字符
	LayerSubmitText string `json:"layer_submit_text,omitempty"`
	// Elements 表单元素
	Elements []FormElement `json:"elements,omitempty"`
	// ExtendInfo 扩展属性
	ExtendInfo *ExtendInfo `json:"extend_info,omitempty"`
	// CreateTime 表单创建时间，格式：%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// UpdateTime 表单上一次修改时间，格式：%Y-%m-%d %H:%M:%S
	UpdateTime string `json:"update_time,omitempty"`
	// IsDel 是否已删除; 可选值：0，1（0表示未删除，1表示已删除）
	IsDel int `json:"is_del,omitempty"`
}

Form 表单详细

type FormElement 

type FormElement struct {
	// ElementID 元素ID
	ElementID uint64 `json:"element_id,omitempty"`
	// Label 元素标签名称，如“姓名“等，文案长度不超过8个字符
	Label string `json:"label,omitempty"`
	// ElementType 元素类型;可选值：NAME（姓名）、TELEPHONE（电话）、EMAIL（邮箱）、NUMBER（数值）、SEX（性别）、DATE（日期）、CITY（城市）、TEXT（文本）、TEXTAREA（文本域）、SELECT（下拉框）、RADIO（单选框）、CHECKBOX（多选框）、CALCULATOR（计算器）；暂不支持SELECT、RADIO、CHECKBOX、CALCULATOR的创建
	ElementType FormElementType `json:"element_type,omitempty"`
	// Sequence 元素排序，即元素流式展示分布的先后顺序，默认按list顺序
	Sequence int `json:"sequence,omitempty"`
	// DefaultValue 元素默认值，目前已开放的元素类中，目前仅支持element_type=NUMBER，即数值类型时填写，表示默认值
	DefaultValue float64 `json:"default_value,omitempty"`
	// Layer 是否分层元素，和enable_layer，layer_submit_text结合用; 可选值：0，1（0表示不是，1表示是）
	Layer int `json:"layer,omitempty"`
	// AllowEmpty 是否允许为空，默认允许; 可选值：0，1（0表示不允许，1表示允许）
	AllowEmpty int `json:"allow_empty,omitempty"`
	// IsUnique 同一表单是否限制不可重复提交，默认可重复; 可选值：0，1（0表示可重复，1表示唯一）
	IsUnique int `json:"is_unique,omitempty"`
}

FormElement 表单元素

type FormElementType 

type FormElementType string

FormElementType 表单元素类型 

const (
	// FormElementType_NAME 姓名
	FormElementType_NAME FormElementType = "NAME"
	// FormElementType_TELEPHONE 电话
	FormElementType_TELEPHONE FormElementType = "TELEPHONE"
	// FormElementType_EMAIL 邮箱
	FormElementType_EMAIL FormElementType = "EMAIL"
	// FormElementType_NUMBER 数值
	FormElementType_NUMBER FormElementType = "NUMBER"
	// FormElementType_SEX 性别
	FormElementType_SEX FormElementType = "SEX"
	// FormElementType_DATE 日期
	FormElementType_DATE FormElementType = "DATE"
	// FormElementType_CITY 城市
	FormElementType_CITY FormElementType = "CITY"
	// FormElementType_TEXT 文本
	FormElementType_TEXT FormElementType = "TEXT"
	// FormElementType_TEXTAREA 文本域
	FormElementType_TEXTAREA FormElementType = "TEXTAREA"
	// FormElementType_SELECT 下拉框
	FormElementType_SELECT FormElementType = "SELECT"
	// FormElementType_RADIO 单选框
	FormElementType_RADIO FormElementType = "RADIO"
	// FormElementType_CHECKBOX 多选框
	FormElementType_CHECKBOX FormElementType = "CHECKBOX"
	// FormElementType_CALCULATOR 计算器
	FormElementType_CALCULATOR FormElementType = "CALCULATOR"
)

type FormType 

type FormType string

FormType 表单类型 

const (
	// NORMAL_FORM 普通落地页
	NORMAL_FORM FormType = "NORMAL_FORM"
	// ADVANCED_CREATIVE_FORM 附加创意
	ADVANCED_CREATIVE_FORM FormType = "ADVANCED_CREATIVE_FORM"
	// NATIVE_FORM 原生表单
	NATIVE_FORM FormType = "NATIVE_FORM"
)

type ListRequest 

type ListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceIDs 表单实例ID，可从【表单创建】【表单列表获取】接口获取; 若指定instance_ids进行过滤，其他的过滤条件将不生效
	InstanceIDs []uint64 `json:"instance_ids,omitempty"`
	// StartTime 起始时间，格式：%Y-%m-%d，默认7天前，即不指定起止时间获取最近7天数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 截止时间，格式：%Y-%m-%d，默认当天，即不指定起止时间获取最近7天数据
	EndTime string `json:"end_time,omitempty"`
	// IsDel 删除标记，默认获取未删除的数据; 可选值：0，1（0表示未删除，1表示已删除）
	IsDel int `json:"is_del,omitempty"`
	// Page 起始页，默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页大小，默认值为10，最大不超过50
	PageSize int `json:"page_size,omitempty"`
}

ListRequest 获取表单列表 API Request

func (ListRequest) Encode 

func (r ListRequest) Encode() string

Encode implement GetRequest interface

type ListResponse 

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

ListResponse 获取表单列表 API Response

type ListResponseData 

type ListResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 表单列表
	List []Form `json:"list,omitempty"`
}

ListResponseData json返回值

type SignType 

type SignType string

SignType 表单报名配置展示形式 

const (
	// SIGN_TYPE_SCROLL_WALL 滚动墙展示
	SIGN_TYPE_SCROLL_WALL SignType = "SIGN_TYPE_SCROLL_WALL"
	// SIGN_TYPE_SCROLL_BAR 滚动条展示
	SIGN_TYPE_SCROLL_BAR SignType = "SIGN_TYPE_SCROLL_BAR"
)

type SignUpConfig 

type SignUpConfig struct {
	// SignType 表单报名配置展示形式; SIGN_TYPE_SCROLL_WALL（滚动墙展示）、SIGN_TYPE_SCROLL_BAR（滚动条展示）
	SignType SignType `json:"sign_type,omitempty"`
}

SignUpConfig 报名信息配置

type UpdateRequest 

type UpdateRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceID 表单实例ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 表单名称，不超过20个字符
	Name string `json:"name,omitempty"`
	// SubmitText 提交文案说明，如“提交表单”，文案长度不超过8个字符
	SubmitText string `json:"submit_text,omitempty"`
	// EnableLayer 是否开启分层，默认不开启; 枚举值：0，1（0表示不启用，1表示启用）
	EnableLayer int `json:"enable_layer,omitempty"`
	// LayerSubmitText 分层提交文案说明，分层信息在Elements中，当不开启分层时，所有分层信息无效。文案长度不超过8个字符
	LayerSubmitText string `json:"layer_submit_text,omitempty"`
	// ExtendInfo 扩展属性
	ExtendInfo *ExtendInfo `json:"extend_info,omitempty"`
}

UpdateRequest 更新表单 API Request

func (UpdateRequest) Encode 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateResponse 

type UpdateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// InstanceID 创建的表单实例id
		InstanceID uint64 `json:"instance_id,omitempty"`
	} `json:"data,omitempty"`
}

UpdateResponse 更新表单 API Response

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.