sitetemplate

package
v1.27.4 Latest Latest
Warning

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

 Go to latest Published: Aug 28, 2024 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Overview

Package sitetemplate 橙子建站模版管理 API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppointEvent 

type AppointEvent struct {
	// GameID 游戏站ID
	GameID string `json:"game_id,omitempty"`
	// Link 链接信息
	Link *Link `json:"link,omitempty"`
}

AppointEvent appointEvent事件行为描述

type Brick 

type Brick struct {
	// Type 组件类型，枚举值：BUTTON 按钮组件、COUPON 卡券组件、FORM 表单组件、PICTURE 图片组件、PICTURE_GROUP 组图组件、RICH_TEXT 富文本组件、SIMPLE_TEXT 文本组件、VIDEO 视频组件
	Type BrickType `json:"type,omitempty"`
	// Index 组件在模板中的位置描述
	Index string `json:"index,omitempty"`
	// Video 视频组件描述
	Video *VideoBrick `json:"video,omitempty"`
	// Picture 图片组件描述
	Picture *PictureBrick `json:"picture,omitempty"`
	// PictureGroup 组图组件描述
	PictureGroup *PictureGroupBrick `json:"picture_group,omitempty"`
	// Text 文本组件描述
	Text *TextBrick `json:"text,omitempty"`
	// Button 按钮组件描述
	Button *ButtonBrick `json:"button,omitempty"`
	// Form 表单组件描述
	Form *FormBrick `json:"form,omitempty"`
	// Coupon 发券组件描述
	Coupon *CouponBrick `json:"coupon,omitempty"`
	// WechatGame 微信小游戏组件
	WechatGame *WechatGameBrick `json:"wechat_game,omitempty"`
}

Brick 组件

type BrickType 

type BrickType string

BrickType 组件类型 

const (
	// BrickType_BUTTON 按钮组件
	BrickType_BUTTON BrickType = "BUTTON"
	// BrickType_COUPON 卡券组件
	BrickType_COUPON BrickType = "COUPON"
	// BrickType_FORM 表单组件
	BrickType_FORM BrickType = "FORM"
	// BrickType_PICTURE 图片组件
	BrickType_PICTURE BrickType = "PICTURE"
	// BrickType_PICTURE_GROUP 组图组件
	BrickType_PICTURE_GROUP BrickType = "PICTURE_GROUP"
	// BrickType_RICH_TEXT 富文本组件
	BrickType_RICH_TEXT BrickType = "RICH_TEXT"
	// BrickType_SIMPLE_TEXT 文本组件
	BrickType_SIMPLE_TEXT BrickType = "SIMPLE_TEXT"
	// BrickType_VIDEO 视频组件
	BrickType_VIDEO BrickType = "VIDEO"
	// BrickType_WECHAT_GAME 微信小游戏组件
	BrickType_WECHAT_GAME = "WECHAT_GAME"
)

type ButtonBrick 

type ButtonBrick struct {
	// EventType 事件行为类型，当button不为空时，有返回值，枚举值：APPOINT_EVENT 预约事件行为、DOWNLOAD_EVENT 下载事件行为、LINK_ENENT 链接事件行为、TELEPHONE_EVENT 电话事件行为
	EventType EventType `json:"event_type,omitempty"`
	// DownloadEvent downloadEvent事件行为描述
	DownloadEvent *DownloadEvent `json:"download_event,omitempty"`
	// LinkEvent linkEvent事件行为描述
	LinkEvent *LinkEvent `json:"link_event,omitempty"`
	// PhoneEvent phoneEvent事件行为描述
	PhoneEvent *PhoneEvent `json:"phone_event,omitempty"`
	// AppointEvent appointEvent事件行为描述
	AppointEvent *AppointEvent `json:"appoint_event,omitempty"`
}

ButtonBrick 按钮组件描述

type CouponBrick 

type CouponBrick struct {
	// ActivityID 活动ID，当coupon不为空时，有返回值。用户可以通过【获取卡券列表】接口或【青鸟线索通平台】获取活动ID
	ActivityID uint64 `json:"activity_id,omitempty"`
}

CouponBrick 发券组件描述

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// SiteID 站点ID，可通过【橙子建站】平台或【获取橙子建站站点列表】接口获取
	SiteID uint64 `json:"site_id,omitempty"`
	// TemplateName 模板名称，默认模版名称为原站点名词
	TemplateName string `json:"template_name,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 *Template `json:"data,omitempty"`
}

CreateResponse 基于站点创建模板 API Response

type DownloadEvent 

type DownloadEvent struct {
	// IOSLink ios链接信息
	IOSLink *Link `json:"ios_link,omitempty"`
	// AndroidLink 安卓链接信息
	AndroidLink *Link `json:"android_link,omitempty"`
}

DownloadEvent downloadEvent事件行为描述

type EventType 

type EventType string

EventType 按钮事件类型 

const (
	// EventType_APPOINT_EVENT 预约事件行为
	EventType_APPOINT_EVENT EventType = "APPOINT_EVENT"
	// EventType_DOWNLOAD_EVENT 下载事件行为
	EventType_DOWNLOAD_EVENT EventType = "DOWNLOAD_EVENT"
	// EventType_LINK_EVENT 链接事件行为
	EventType_LINK_EVENT EventType = "LINK_EVENT"
	// EventType_TELEPHONE_EVENT 电话事件行为
	EventType_TELEPHONE_EVENT EventType = "TELEPHONE_EVENT"
)

type FormBrick 

type FormBrick struct {
	// InstanceID 表单ID，当form不为空时，有返回值。用户可以通过【获取表单列表】接口或【青鸟线索通平台】获取表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
}

FormBrick 表单组件描述

type GetFilter 

type GetFilter struct {
	// TemplateIDs 模板ID数组，数量限制100
	TemplateIDs []uint64 `json:"template_ids,omitempty"`
	// SiteIDs 站点ID，可通过【橙子建站】平台或【获取橙子建站站点列表】获取
	SiteIDs []uint64 `json:"site_ids,omitempty"`
	// KeywordOfName 模板名称关键词
	KeywordOfName string `json:"keyword_of_name,omitempty"`
}

GetFilter 过滤条件

type GetRequest 

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filter 过滤条件
	Filter *GetFilter `json:"filter,omitempty"`
	// Page 页码，默认值是1，范围page >=1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值是20，范围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 {
	// List 模板列表
	List []Template `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

GetResponseData json返回值 

type Link struct {
	// URL 链接地址，当link_type为url时，必填
	URL string `json:"url,omitempty"`
	// Scheme scheme地址，当link_type为scheme时，必填
	Scheme string `json:"scheme,omitempty"`
	// QuickApp 快应用地址，当link_type为quick_app时，必填;获取快应用链接可参考【快应用官方网站】
	QuickApp string `json:"quick_app,omitempty"`
	// LinkType 链接类型，可传值有:url：链接地址,sheme：scheme地址,quickApp：快应用地址,当传递链接信息参数时，必填
	LinkType LinkType `json:"link_type,omitempty"`
	// Description 应用描述，为了展示效果，推荐12个中文字符长度
	Description string `json:"description,omitempty"`
}

Link 跳转链接信息

type LinkEvent 

type LinkEvent struct {
	// Link 链接信息
	Link *Link `json:"link,omitempty"`
}

LinkEvent LinkEvent事件行为描述

type LinkType 

type LinkType string

LinkType 链接类型 

const (
	// LinkType_URL 链接地址
	LinkType_URL LinkType = "URL"
	// LinkType_SCHEME scheme地址
	LinkType_SCHEME LinkType = "SCHEME"
	// LinkType_QUICK_APP 快应用地址
	LinkType_QUICK_APP LinkType = "QUICK_APP"
)

type PhoneEvent 

type PhoneEvent struct {
	// InstanceID 智能电话ID，当phone_event不为空时，有返回值。用户可以通过【获取智能电话列表】接口或【青鸟线索通平台】获取智能电话ID
	InstanceID uint64 `json:"instance_id,omitempty"`
}

PhoneEvent phoneEvent事件行为描述

type PicURLGetRequest added in v1.17.10 

type PicURLGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// SiteID 站点id
	SiteID uint64 `json:"site_id,omitempty"`
	// TemplateID 模板id
	TemplateID uint64 `json:"template_id,omitempty"`
}

PicURLGetRequest 获取模板/站点URL API Request

func (PicURLGetRequest) Encode added in v1.17.10 

func (r PicURLGetRequest) Encode() string

Encode implement GetRequest interface

type PicURLGetResponse added in v1.17.10 

type PicURLGetResponse struct {
	model.BaseResponse
	Data struct {
		// URLMap uri
		URLMap map[string]string `json:"url_map,omitempty"`
	} `json:"data,omitempty"`
}

PicURLGetResponse 获取模板/站点URL API Response

type PictureBrick 

type PictureBrick struct {
	// URL 图片url，当picture不为空时，有返回值
	URL string `json:"url,omitempty"`
	// Link 图片跳转链接信息
	Link *Link `json:"link_dto,omitempty"`
	// Tag 标签，用户自定义标注
	Tag string `json:"tag,omitempty"`
}

PictureBrick 图片组件描述

type PictureGroupBrick 

type PictureGroupBrick struct {
	// Content 组图内容列表
	Content []PictureBrick `json:"content,omitempty"`
}

PictureGroupBrick 组图组件描述

type PreviewRequest 

type PreviewRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// TemplateID 模板ID，可通过【获取站点模版列表】查询模板ID
	TemplateID uint64 `json:"template_id,omitempty"`
}

PreviewRequest 获取模版预览链接 API Request

func (PreviewRequest) Encode 

func (r PreviewRequest) Encode() string

Encode implement GetRequest interface

type PreviewResponse 

type PreviewResponse struct {
	model.BaseResponse
	Data struct {
		// PreviewURL 预览URL，模板的预览地址，有效期：20分钟
		PreviewURL string `json:"preview_url,omitempty"`
	} `json:"data,omitempty"`
}

PreviewResponse 获取模版预览链接 API Response

type SiteCreateRequest 

type SiteCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// SiteID 站点ID，可通过【橙子建站】平台或【获取橙子建站站点列表】接口获取
	SiteID uint64 `json:"site_id,omitempty"`
	// TemplateID 模板ID，可通过【获取站点模版列表】查询模板ID
	TemplateID uint64 `json:"template_id,omitempty"`
	// Name 站点名称，范围：长度 >= 1
	Name string `json:"name,omitempty"`
	// Bricks 组件列表，可按需填充部分组件，未填充部分会使用原模板内容。
	Bricks []Brick `json:"bricks,omitempty"`
}

SiteCreateRequest 基于模板创建站点 API Request

func (SiteCreateRequest) Encode 

func (r SiteCreateRequest) Encode() []byte

Encode implement PostRequest interface

type SiteCreateResponse 

type SiteCreateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// SiteID 站点ID
		SiteID uint64 `json:"site_id,omitempty"`
	} `json:"data,omitempty"`
}

SiteCreateResponse 基于模板创建站点 API Response

type Template 

type Template struct {
	// TemplateID 模板ID
	TemplateID uint64 `json:"template_id,omitempty"`
	// SiteID 站点ID，可通过【橙子建站】平台或【获取橙子建站站点列表】接口获取
	SiteID uint64 `json:"site_id,omitempty"`
	// TemplateName 模板名称
	TemplateName string `json:"template_name,omitempty"`
	// Bricks 组件列表
	Bricks []Brick `json:"bricks,omitempty"`
}

Template 模板

type TextBrick 

type TextBrick struct {
	// Content 文本内容，长度至少为1
	Content string `json:"content,omitempty"`
	// Link 跳转链接信息
	Link *Link `json:"link_dto,omitempty"`
}

TextBrick 文本组件描述

type Video 

type Video struct {
	// VideoID 视频ID，本地视频上传后可得到视频ID，可通过【获取视频素材】接口获取，当local_video不为空时，有返回值
	VideoID string `json:"video_id,omitempty"`
	// PosterURL 视频封面图片URL，当local_video不为空时，有返回值
	PosterURL string `json:"poster_url,omitempty"`
	// OriginURL 视频原始链接，例如https://v.youku.com/v_show/id_xxx.html，当online_video不为空时，有返回值
	OriginURL string `json:"origin_url,omitempty"`
}

Video 视频信息

type VideoBrick 

type VideoBrick struct {
	// LocalVideo 本地视频内容
	LocalVideo *Video
	// OnlineVideo 在线视频内容
	OnlineVideo *Video
}

VideoBrick 视频组件

type WechatGameBrick added in v1.5.8 

type WechatGameBrick struct {
	// InstanceID 微信小游戏组件ID，当wechat_game不为空时，有返回值。用户可以通过【青鸟线索通平台】获取微信小游戏组件ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// GamePath 微信小游戏的路径参数
	GamePath string `json:"game_path,omitempty"`
	// Items 标签，个数不超过2，字数不超过5个中文字符
	Items []string `json:"items,omitempty"`
	// Introduction 简介，长度不超过40个中文字符
	Introduction string `json:"introduction,omitempty"`
	Logo string `json:"logo,omitempty"`
}

WechatGameBrick 微信小游戏组件

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.