spi

Documentation

Overview

Package spi SPI推送相关API models

Index

• func IsValidToken(secret []byte, token []byte, data []byte) bool
• func Sign(secret []byte, data []byte) string
• func VerifyTokenHeader(secret []byte, data []byte, tokenFromHeader string) bool
• type AccountRelation
• type BaseResponse
• type ChallengeRequest
• type ChallengeResponse
• type CommentUser
• type EventContent
• type Message
• type MessageData
• type MessageDataBase
• type MessageDataV2

Functions

func IsValidToken

func IsValidToken(secret []byte, token []byte, data []byte) bool

IsValidToken 验证签名

func Sign

func Sign(secret []byte, data []byte) string

Sign 生成签名

func VerifyTokenHeader

func VerifyTokenHeader(secret []byte, data []byte, tokenFromHeader string) bool

VerifyTokenHeader 验证签名

Types

type AccountRelation

type AccountRelation struct {
	// AgentIDs 代理商授权
	AgentIDs map[string][]uint64 `json:"agent_ids,omitempty"`
	// CoreUserIDs 用户授权账号
	CoreUserIDs map[string][]uint64 `json:"core_user_ids,omitempty"`
	// AdvertiserIDs 广告主id直接授权
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
	// CcIDs 巨量纵横账号
	Ccids map[string][]uint64 `json:"cc_ids,omitempty"`
}

AccountRelation 账号对应关系，包含所有advertiser_ids的授权关系

type BaseResponse

type BaseResponse struct {
	// StatusCode 执行状态码，200表示成功，4xx 业务异常不重试，5xx 系统异常重试
	StatusCode int `json:"StatusCode,omitempty"`
	// StatusMessage 执行结果
	StatusMessage string `json:"StatusMessage,omitempty"`
}

BaseResponse 返回信息基类

type ChallengeRequest

type ChallengeRequest struct {
	// Challenge 随机数
	Challenge int64 `form:"challenge" json:"challenge" binding:"required"`
	// Event 固定值，传递verify_webhook
	Event string `form:"event" json:"event" binding:"required"`
}

ChallengeRequest .

type ChallengeResponse

type ChallengeResponse struct {
	BaseResp BaseResponse `json:"BaseResp"`
	// 回传challenge数据
	Challenge int64 `json:"challenge"`
}

ChallengeResponse .

type CommentUser

type CommentUser struct {
	// OpenID 抖音ID
	OpenID string `json:"open_id,omitempty"`
	// AvatarURL 头像
	AvatarURL string `json:"avatar_url,omitempty"`
	// NickName 昵称
	NickName string `json:"nick_name,omitempty"`
}

CommentUser 用户信息

type EventContent

type EventContent struct {
	// SiteID 站点ID
	SiteID uint64 `json:"site_id,omitempty"`
	// EventType 事件变更类型，枚举值：
	// 1 站点状态变更 、2 站点审核状态变更 、3 站点影子审核状态变更 、4 站点线上内容数据变更 、5 站点送审内容数据变更
	EventType int `json:"event_type,omitempty"`
	// AdvID 广告主ID
	AdvID uint64 `json:"adv_id,omitempty"`
	// From 变更前数据
	From json.RawMessage `json:"from,omitempty"`
	// To 变更后数据
	To json.RawMessage `json:"to,omitempty"`
	// Extra 额外数据
	Extra string `json:"extra,omitempty"`
	// MessageType 消息类型，枚举值：text 文本消息、emoji 表情消息、h5/poi H5/POI类卡片消息
	MessageType string `json:"message_type,omitempty"`
	// Text 文本消息内容
	Text string `json:"text,omitempty"`
	// ResourceType 资源类型
	ResourceType string `json:"resource_type,omitempty"`
	// ResourceHeight 资源高度
	ResourceHeight int `json:"resource_height,omitempty"`
	// ResourceWidth 资源宽度
	ResourceWidth int `json:"resource_width,omitempty"`
	// ResourceURL 资源链接
	ResourceURL string `json:"resource_url,omitempty"`
	// Title 卡片标题
	Title string `json:"title,omitempty"`
	// IconURL 卡片图标
	IconURL string `json:"icon_url,omitempty"`
	// Description 卡片描述
	Description string `json:"description,omitempty"`
	// LinkURL 跳转链接
	LinkURL string `json:"link_url,omitempty"`
	// Object 来源场景对应id（video对应视频id）
	Object string `json:"object,omitempty"`
	// CommentUser 用户信息
	CommentUser *CommentUser `json:"comment_user,omitempty"`
	// CommentContent 评论内容
	CommentContent string `json:"comment_content,omitempty"`
	// CommentItemOwnerID 内容所属者open_id
	CommentItemOwnerID string `json:"comment_item_owner_id,omitempty"`
	// CreateTime 评论时间
	CreateTime int64 `json:"create_time,omitempty"`
	// IsReply 是否回复
	IsReply bool `json:"is_reply,omitempty"`
	// ReplyToCommentID 回复的评论id
	ReplyToCommentID string `json:"reply_to_comment_id,omitempty"`
	// ReplyToCommentUser 回复评论的用户信息
	ReplyToCommentUser *CommentUser `json:"reply_to_comment_user,omitempty"`
	// ReplyToCommentContent 回复的评论内容
	ReplyToCommentContent string `json:"reply_to_comment_content,omitempty"`
	// Message 通知内容，示例："尊敬的客户，您好！因您当前账户下的【所有广告】低效在投计划数过多，已经严重影响您的账户健康度，根据平台相关规则，【所有广告】已被【限制投放】。限制不会自动解除。建议您及时清理账户中的低效计划，完成清理后，可以联系和您对接的销售同学进行解除限制申诉（如您没有对接销售可通过平台右下方智能客服提工单反馈），感谢您对巨量引擎的支持。"
	Message string `json:"message,omitempty"`
	// AdIDs 被暂停的计划列表
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// GroupIDs 被暂停的管家项目列表
	GroupIDs []uint64 `json:"group_ids,omitempty"`
	// PromotionIDs 成功占用配额的巨量引擎体验版的广告列表
	PromotionIDs []uint64 `json:"promotion_ids,omitempty"`
	// SumQuota 变化后在投计划配额
	SumQuota int64 `json:"sum_quota,omitempty"`
	// SumQuotaBefore 变化前在投计划配额
	SumQuotaBefore int64 `json:"sum_quota_before,omitempty"`
	// CampaignType 广告组类型，FEED 信息流、 SEARCH 搜索广告
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
	// DeliveryRange 允许值: DEFAULT默认（默认值）, UNION穿山甲,
	// 当campaign_type = feed && delivery_range= default可获取所有广告配额;
	// 当campaign_type = feed && delivery_range= union时可获取穿山甲广告配额;
	// 当campaign_type = search && delivery_range= default时可获取搜索广告配额;
	DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"`
}

EventContent 事件内容

type Message

type Message struct {
	// MessageID 唯一标识一条推送消息/数据; 64字符
	MessageID string `json:"message_id,omitempty"`
	// SubscribeTaskID 订阅任务id，订阅任务的主键; 64字符
	SubscribeTaskID uint64 `json:"subscribe_task_id,omitempty"`
	// AdvertiserIDs 消息对应的广告主账号，report.advertiser.beforeday 时返回所有已产出的广告主ID组，其余服务类型一次仅返回一个广告主ID
	AdvertiserIDs []uint64 `json:"advertiser_ids,omitempty"`
	// AccountRelation 推送广告主账号的订阅来源，是订阅的哪个账号下的广告主数据; min=1，max=1k
	AccountRelation string `json:"account_relation,omitempty"`
	// ServiceLabel 订阅服务类型
	ServiceLabel string `json:"service_label,omitempty"`
	// Data 推送数据信息，具体结构参考子文档
	Data string `json:"data,omitempty"`
	// PublishTime 消息实际产生时间
	PublishTime int64 `json:"publish_time,omitempty"`
	// Timestamp 毫秒时间戳，本条消息实际推送时间
	Timestamp int64 `json:"timestamp,omitempty"`
	// Nonce 随机数，和timestamp组合防重放
	Nonce int64 `json:"nonce,omitempty"`
}

Message 正文数据

type MessageData

type MessageData struct {
	MessageDataBase
	// Content 事件内容
	Content *EventContent `json:"content,omitempty"`
}

MessageData .

type MessageDataBase

type MessageDataBase struct {
	// AppID 应用APPID
	AppID uint64 `json:"app_id,omitempty"`
	// UserID 创意归属广告主id
	UserID uint64 `json:"user_id,omitempty"`
	// FromUserID 触发事件发送者open_id
	FromUserID string `json:"from_user_id,omitempty"`
	// ToUserID 触发事件接收者open_id
	ToUserID string `json:"to_user_id,omitempty"`
	// CoreUserID 登陆用户id
	CoreUserID uint64 `json:"core_user_id,omitempty"`
	// AdvertiserID 广告主I D
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CoreUserIDs 登陆用户ids
	CoreUserIDs []uint64 `json:"core_user_ids,omitempty"`
	// AdID 创意归属计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// AdIDs 聚合周期内发生指标变更的计划列表，service_label 为report.ad.activeprogram时有值
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// CreativeIDs 聚合周期内发生指标变更的创意列表，service_label 为report.creative.activeprogram时有值
	CreativeIDs []uint64 `json:"creative_ids,omitempty"`
	// ProjectIDs 状态发生变更的项目ids
	ProjectIDs []uint64 `json:"project_ids,omitempty"`
	// PromotionIDs 状态发生变更的广告ids
	PromotionIDs []uint64 `json:"promotion_ids,omitempty"`
	// Event 事件名称
	Event string `json:"event,omitempty"`
}

MessageDataBase .

type MessageDataV2

type MessageDataV2 struct {
	MessageDataBase
	// Content 事件内容
	Content string `json:"content,omitempty"`
}

MessageDataV2 .