eventmanager

package
v1.20.2 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2023 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Overview

Package eventmanager 资产 - 事件管理 相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App 

type App struct {
	AssetBaseInfo
	// Name 快应用名称，长度限制为20，一个字符长度为1
	Name string `json:"name,omitempty"`
	// AppName 应用名
	AppName string `json:"app_name,omitempty"`
	// AppType 应用类型
	AppType string `json:"app_type,omitempty"`
	// DownloadURL 应用下载链接
	DownloadURL string `json:"download_url,omitempty"`
	// AppID 应用ID
	AppID uint64 `json:"app_id,omitempty"`
	// PackageID 母包ID
	PackageID string `json:"package_id,omitempty"`
	// PackageName 应用包名
	PackageName string `json:"package_name,omitempty"`
	// AppPackageName 应用包名，精确搜索
	AppPackageName string `json:"app_package_name,omitempty"`
	// Role 资产来源
	Role string `json:"role,omitempty"`
}

App 应用数据

type AssetBaseInfo 

type AssetBaseInfo struct {
	// AssetID 快应用资产ID
	AssetID uint64 `json:"asset_id,omitempty"`
	// AssetName 快应用名称
	AssetName string `json:"asset_name,omitempty"`
}

AssetBaseInfo 资产基本数据“

type AssetsCreateRequest 

type AssetsCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetType 资产类型，目前仅支持THIRD_EXTERNAL 三方落地页
	AssetType enum.AssetType `json:"asset_type,omitempty"`
	// ThirdPartAsset 三方落地页资产信息
	ThirdPartAsset *LandingPage `json:"third_part_asset,omitempty"`
	// QuickAppAsset 快应用资产信息
	QuickAppAsset *QuickApp `json:"quick_app_asset,omitempty"`
	// AppAsset 应用信息
	AppAsset *App `json:"app_asset,omitempty"`
	// SiteAsset 橙子落地页信息
	SiteAsset *Site `json:"site_asset,omitempty"`
	// MiniProgramAsset 字节小程序资产信息
	MiniProgramAsset *MiniProgram `json:"mini_program_asset,omitempty"`
}

AssetsCreateRequest 创建事件资产 API Request

func (AssetsCreateRequest) Encode 

func (r AssetsCreateRequest) Encode() []byte

Encode implement PostRequest interface

type AssetsCreateResponse 

type AssetsCreateResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// AssetID 资产ID
		AssetID uint64 `json:"asset_id,omitempty"`
	} `json:"data,omitempty"`
}

AssetsCreateResponse 创建事件资产 API Response

type AssetsGetFiltering 

type AssetsGetFiltering struct {
	// LandingPage 三方落地页数据
	LandingPage *AssetBaseInfo `json:"landing_page,omitempty"`
	// QuickApp 快应用数据
	QuickApp *QuickApp `json:"quick_app,omitempty"`
	// App 应用数据
	App *App `json:"app,omitempty"`
	// MiniProgram 字节小程序快应用资产
	MiniProgram *AssetBaseInfo `json:"mini_program,omitempty"`
}

AssetsGetFiltering 过滤条件

type AssetsGetRequest 

type AssetsGetRequest struct {
	// AdvertiserID 广告主 id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetType 资产类型，允许值：THIRD_EXTERNAL：三方落地页
	AssetType enum.AssetType `json:"asset_type,omitempty"`
	// Filtering 过滤条件
	Filtering *AssetsGetFiltering `json:"filtering,omitempty"`
	// SortType 排序方式，允许值：ASC：升序 DESC：降序
	// 默认值ASC
	SortType enum.OrderType `json:"sort_type,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值10，最大30
	PageSize int `json:"page_size,omitempty"`
}

AssetsGetRequest 获取已创建资产列表 API Request

func (AssetsGetRequest) Encode 

func (r AssetsGetRequest) Encode() string

Encode implement GetRequest interface

type AssetsGetResponse 

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

AssetsGetResponse 获取已创建资产列表 API Response

type AssetsGetResponseData 

type AssetsGetResponseData struct {
	// LandingPages 三方数据集合
	LandingPages []LandingPage `json:"landing_pages,omitempty"`
	// QuickApp 快应用数据
	QuickApp []QuickApp `json:"quick_app,omitempty"`
	// App 应用数据`
	App []App `json:"app,omitempty"`
	// MiniProgram 字节小程序快应用资产
	MiniProgram []MiniProgram `json:"mini_program,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

AssetsGetResponseData json返回值

type AttributionConfiguration 

type AttributionConfiguration struct {
	// AttributionWindow 归因窗口
	AttributionWindow int64 `json:"attribution_window,omitempty"`
}

AttributionConfiguration 属性配置

type AvailableEventsGetRequest 

type AvailableEventsGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetID 资产ID
	AssetID uint64 `json:"asset_id,omitempty"`
}

AvailableEventsGetRequest 获取可创建事件列表 API Request

func (AvailableEventsGetRequest) Encode 

func (r AvailableEventsGetRequest) Encode() string

Encode implement GetRequest interface

type AvailableEventsGetResponse 

type AvailableEventsGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// List 可创建事件列表
		List []EventConfig `json:"event_configs,omitempty"`
	} `json:"data,omitempty"`
}

AvailableEventsGetResponse 获取可创建事件列表 API Response

type EventConfig 

type EventConfig struct {
	// EventID 事件ID
	EventID uint64 `json:"event_id,omitempty"`
	// EventType 事件类型
	EventType string `json:"event_type,omitempty"`
	// EventCnName 事件中文名称
	EventCnName string `json:"event_cn_name,omitempty"`
	// Description 事件描述信息
	Description string `json:"description,omitempty"`
	// AttributionConfiguration 属性配置
	AttributionConfiguration *AttributionConfiguration `json:"attribution_configuration,omitempty"`
	// DebugingStatus 激活免联调状态，枚举值：Active 已激活、Inactive 未激活
	DebugingStatus string `json:"debuging_status,omitempty"`
	// StatisticalType 统计方式，枚举值：ONLY_ONE 仅一次
	StatisticalType string `json:"statistical_type,omitempty"`
	// TrackTypes 事件回传方式列表，枚举值：JSSDK JS埋码 、EXTERNAL_API API回传 、XPATH XPath圈选
	TrackTypes []enum.EventTrackType `json:"track_types,omitempty"`
	// CreateTime 事件创建时间
	CreateTime string `json:"create_time,omitempty"`
	// Properties 事件的附加属性
	Properties []EventConfigProperty `json:"properties,omitempty"`
}

EventConfig 事件详情

type EventConfigProperty 

type EventConfigProperty struct {
	// Field 附加属性英文名称
	Field string `json:"field,omitempty"`
	// FieldName 附加属性中文名称
	FieldName string `json:"field_name,omitempty"`
	// VariableType 附加属性值类型
	VariableType string `json:"variable_type,omitempty"`
	// EnumValue 附加属性枚举值
	EnumValue interface{} `json:"enum_value,omitempty"`
	// Unit 附加属性单位
	Unit string `json:"unit,omitempty"`
	// Description 附加属性描述
	Description string `json:"description,omitempty"`
}

EventConfigProperty 事件的附加属性

type EventConfigsGetRequest 

type EventConfigsGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetID 资产ID
	AssetID uint64 `json:"asset_id,omitempty"`
	// SortType 创建时间排序方式，允许值：DESC 降序、ASC 升序。默认：ASC
	SortType enum.OrderType `json:"sort_type,omitempty"`
}

EventConfigsGetRequest 获取已创建事件列表 API Request

func (EventConfigsGetRequest) Encode 

func (r EventConfigsGetRequest) Encode() string

Encode implement GetRequest interface

type EventConfigsGetResponse 

type EventConfigsGetResponse struct {
	model.BaseResponse
	Data struct {
		// List 已创建事件列表
		List []EventConfig `json:"event_configs,omitempty"`
	} `json:"data,omitempty"`
}

EventConfigsGetResponse 获取已创建事件列表 API Response

type EventConvertOptimizedGoal 

type EventConvertOptimizedGoal struct {
	// ExternalAction 预定义转化目标，具体枚举可查看【附录-预定义转化类型】
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// OptimizationName 事件名称
	OptimizationName string `json:"optimization_name,omitempty"`
	// HistoryBack 历史有无回传, true 表示有，false 表示无
	HistoryBack bool `json:"history_back,omitempty"`
	// TwentyFourHourBack 24 小时历史有无回传, true 表示有，false 表示无
	TwentyFourHourBack bool `json:"twenty_four_hour_back,omitempty"`
	// ValueType 价值类型，Disabled 不展示、DiscriminateByGroup 人群差异价值、DynamicValue 动态回传价值、Fixed 固定价值
	ValueType string `json:"value_type,omitempty"`
	// AssetTypes 资产类型，:THIRD_EXTERNAL:三方落地页、TETRIS_EXTERNAL:建站、APP 应用、QUICK_APP 快应用、MINI_PROGRAME字节小程序
	AssetTypes []enum.AssetType `json:"asset_types,omitempty"`
	// DeepGoals 深度优化目标列表
	DeepGoals []EventConvertOptimizedGoal `json:"deep_goals,omitempty"`
	// DeepExternalAction 深度转化目标，具体枚举可查看【附录-预定义转化类型】
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
}

EventConvertOptimizedGoal 优化目标数据

type EventConvertOptimizedGoalGetRequest 

type EventConvertOptimizedGoalGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// LandingType 广告组推广目的，允许值:LINK 销售线索收集
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// MarketingPurpose 营销目的，允许值:CONVERSION 行动转化、INTENTION 用户意向、ACKNOWLEDGE 品牌认知
	MarketingPurpose enum.MarketingPurpose `json:"marketing_purpose,omitempty"`
	// AssetType 资产类型，允许值:THIRD_EXTERNAL 三方落地页、TETRIS_EXTERNAL 建站、APP 应用、QUICK_APP 快应用、MINI_PROGRAME字节小程序
	AssetType enum.AssetType `json:"asset_type,omitempty"`
	// SiteID 建站site_id，当asset_type为TETRIS_EXTERNAL时必填，site_id可以通过【获取橙子建站站点列表】接口获得
	SiteID uint64 `json:"site_id,omitempty"`
	// AssetID 三方的资产id，当asset_type为THIRD_EXTERNAL时必填
	AssetID uint64 `json:"asset_id,omitempty"`
	// QuickAppID 快应用id
	QuickAppID uint64 `json:"quick_app_id,omitempty"`
	// MiniProgramID 字节小程序资产id
	MiniProgramID string `json:"mini_program_id,omitempty"`
	// PackageName 应用包名称
	PackageName string `json:"package_name,omitempty"`
	// AppType 应用类型，当asset_type为应用APP时必填
	// 可选值：ANDROID 、IOS
	AppType string `json:"app_type,omitempty"`
	// CampaignType 广告类型，默认值信息流。允许值：FEED 信息流、SEARCH 搜索
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
	// WechatAppID 微信小游戏原始id。获取方式：资产->青鸟线索通->转化组件->微信小游戏->小游戏列表，可获取小游戏原始id。
	WechatAppID string `json:"wechat_app_id,omitempty"`
}

EventConvertOptimizedGoalGetRequest 获取优化目标 API Request

func (EventConvertOptimizedGoalGetRequest) Encode 

func (r EventConvertOptimizedGoalGetRequest) Encode() string

Encode implement GetRequest interface

type EventConvertOptimizedGoalGetResponse 

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

EventConvertOptimizedGoalGetResponse 获取优化目标 API Response

type EventConvertOptimizedGoalGetResponseData 

type EventConvertOptimizedGoalGetResponseData struct {
	// AssetIDs 资产 id
	AssetIDs []uint64 `json:"asset_ids,omitempty"`
	// Goals 优化目标数据列表
	Goals []EventConvertOptimizedGoal `json:"goals,omitempty"`
}

EventConvertOptimizedGoalGetResponseData json返回值

type EventsCreateRequest 

type EventsCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetID 资产ID
	AssetID uint64 `json:"asset_id,omitempty"`
	// EventID 事件ID
	EventID uint64 `json:"event_id,omitempty"`
	// TrackTypes 事件回传方式列表，允许值：JSSDK JS埋码 、EXTERNAL_API API回传 、XPATH XPath圈选
	TrackTypes []enum.EventTrackType `json:"track_types,omitempty"`
}

EventsCreateRequest 资产下创建事件 API Request

func (EventsCreateRequest) Encode 

func (r EventsCreateRequest) Encode() []byte

Encode implement PostRequest interface

type LandingPage 

type LandingPage struct {
	AssetBaseInfo
	// Name  落地页名称，长度限制为25，一个字符长度为1
	Name string `json:"name,omitempty"`
	// Description 落地页名称，长度限制为150，一个字符长度为1
	Description string `json:"description,omitempty"`
}

LandingPage 三方落地页数据

type MiniProgram 

type MiniProgram struct {
	AssetBaseInfo
	// MiniProgramID 字节小程序id
	MiniProgramID string `json:"mini_program_id,omitempty"`
	// MicroProgramName 字节小程序的名称，需要与资产id后面信息一致
	MicroProgramName string `json:"micro_program_name,omitempty"`
	// InstanceID 字节小程序资产ID，通过【工具】-【获取字节小程序/小游戏】获取
	InstanceID string `json:"instance_id,omitempty"`
	// MiniProgramType 字节小程序类型：
	// BYTE_APP：字节小程序
	// BYTE_GAME：字节小游戏
	MiniProgramType enum.MiniProgramType `json:"mini_program_type,omitempty"`
}

MiniProgram 字节小程序快应用资产

type QuickApp 

type QuickApp struct {
	AssetBaseInfo
	// Name 快应用名称，长度限制为20，一个字符长度为1
	Name string `json:"name,omitempty"`
	// PackageName 快应用包名
	PackageName string `json:"package_name,omitempty"`
	// QuickAppID 快应用ID
	QuickAppID uint64 `json:"quick_app_id,omitempty"`
}

QuickApp 快应用数据

type ShareAccount 

type ShareAccount struct {
	// AccountID 账号id
	AccountID uint64 `json:"account_id,omitempty"`
	// AccountType 业务线
	AccountType enum.AccountType `json:"account_type,omitempty"`
}

ShareAccount 共享账号信息

type ShareError 

type ShareError struct {
	ShareInfo
	// ErrorMessage 错误信息
	ErrorMessage string `json:"error_message,omitempty"`
}

ShareError .

func (ShareError) Error 

func (e ShareError) Error() string

type ShareGetData 

type ShareGetData struct {
	// List 共享账户ID（adv+bpid+枚举值）集合
	List []ShareInfo `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

ShareGetData .

type ShareGetRequest 

type ShareGetRequest struct {
	// OrganizationID 纵横组织id
	OrganizationID uint64 `json:"organization_id,omitempty"`
	// AssetID 事件管理资产id
	AssetID uint64 `json:"asset_id,omitempty"`
	// Page 页码，默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值为10，最大不超过200
	PageSize int `json:"page_size,omitempty"`
}

ShareGetRequest 事件管理资产查看共享范围 API Request

func (ShareGetRequest) Encode 

func (r ShareGetRequest) Encode() string

Encode implement GetRequest interface

type ShareGetResponse 

type ShareGetResponse struct {
	model.BaseResponse
	// Data 返回数据
	Data *ShareGetData `json:"data,omitempty"`
}

ShareGetResponse 事件管理资产查看共享范围 API Response

type ShareInfo 

type ShareInfo struct {
	// ShareMode 共享类型
	ShareMode ShareMode `json:"share_mode,omitempty"`
	// AccountInfo 共享账号信息
	AccountInfo *ShareAccount `json:"account_info,omitempty"`
	// AllAccountType 业务线
	AllAccountType enum.AccountType `json:"all_account_type,omitempty"`
}

ShareInfo 共享账户ID（adv+bpid+枚举值）集合

type ShareMode 

type ShareMode string
const (
	// ShareMode_ALL 组织下某业务线账
	ShareMode_ALL ShareMode = "ALL"
	// ShareMode_PART 指定账户共享
	ShareMode_PART ShareMode = "PART"
)

type ShareRequest 

type ShareRequest struct {
	// OrganizationID 纵横组织id
	OrganizationID uint64 `json:"organization_id,omitempty"`
	// AssetID 事件管理资产id
	AssetID uint64 `json:"asset_id,omitempty"`
	// ShareMode 共享模式，可选值:
	// ALL: 组织下某业务线账户PART: 指定账户共享
	ShareMode ShareMode `json:"share_mode,omitempty"`
	// AccountInfos 共享账户信息，一次最多操作10个
	// 当share_mode="PART"时必填
	AccountInfos []ShareAccount `json:"account_infos,omitempty"`
	// AllAccountType 共享账户业务线
	// 当share_mode="ALL"时必填，可选值：:
	// AD
	AllAccountType enum.AccountType `json:"all_account_type,omitempty"`
}

ShareRequest 事件管理资产共享 API Request

func (ShareRequest) Encode 

func (r ShareRequest) Encode() []byte

Encode implement PostRequest interface

type ShareResponse 

type ShareResponse struct {
	model.BaseResponse
	Data struct {
		// ErrorList 共享失败的账户ID及原因列表
		ErrorList []ShareError `json:"error_list,omitempty"`
	} `json:"data,omitempty"`
}

ShareResponse 事件管理资产共享 API Response

type Site added in v1.20.0 

type Site struct {
	AssetBaseInfo
	// SiteID 橙子建站站点ID，橙子落地页必填
	SiteID uint64 `json:"site_id,omitempty"`
	// SiteName 橙子建站站点名称，橙子落地页必填
	SiteName string `json:"site_name,omitempty"`
}

Site 橙子落地页信息

type TrackURLCreateRequest 

type TrackURLCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetsID 资产ID
	AssetsID uint64 `json:"assets_id,omitempty"`
	// DownloadURL 应用下载链接，应用下载链接，IOS和安卓应用资产：必填
	DownloadURL string `json:"download_url,omitempty"`
	// TrackURLGroups 监测链接组信息，IOS和安卓应用可绑定多组监测链接
	TrackURLGroups []TrackURLGroup `json:"track_url_groups,omitempty"`
}

TrackURLCreateRequest 事件资产下创建监测链接组 API Request

func (TrackURLCreateRequest) Encode 

func (r TrackURLCreateRequest) Encode() []byte

Encode implement PostRequest interface

type TrackURLGetData 

type TrackURLGetData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// TrackURLGroups 监测链接组信息
	TrackURLGroups []TrackURLGroup `json:"track_url_groups,omitempty"`
}

TrackURLGetData 返回数据

type TrackURLGetRequest 

type TrackURLGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetID 资产ID
	AssetID uint64 `json:"asset_id,omitempty"`
	// DownloadURL 应用下载链接，应用下载链接，IOS和安卓应用资产：必填
	DownloadURL string `json:"download_url,omitempty"`
	// TrackURLGroupName 监测链接组名称
	TrackURLGroupName string `json:"track_url_group_name,omitempty"`
	// TrackURLGroupID 监测链接组ID
	TrackURLGroupID uint64 `json:"track_url_group_id,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 分页个数
	PageSize int `json:"page_size,omitempty"`
}

TrackURLGetRequest 获取事件资产下的监测链接组 API Request

func (TrackURLGetRequest) Encode 

func (r TrackURLGetRequest) Encode() string

Encode implement GetRequest interface

type TrackURLGetResponse 

type TrackURLGetResponse struct {
	model.BaseResponse
	// Data 返回数据
	Data *TrackURLGetData `json:"data,omitempty"`
}

TrackURLGetResponse 获取事件资产下的监测链接组 API Response

type TrackURLGroup 

type TrackURLGroup struct {
	// ActionTrackURL 点击（监测链接），只允许传入1个
	ActionTrackURL string `json:"action_track_url,omitempty"`
	// TrackURL 展示（监测链接），只允许传入1个
	TrackURL string `json:"track_url,omitempty"`
	// VideoPlayTrackURL 视频播放（监测链接），只允许传入1个
	VideoPlayTrackURL string `json:"video_play_track_url,omitempty"`
	// VideoPlayDoneTrackURL 视频播完（监测链接），只允许传入1个
	VideoPlayDoneTrackURL string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayEffectiveTrackURL 视频有效播放（监测链接），只允许传入1个
	VideoPlayEffectiveTrackURL string `json:"video_play_effective_track_url,omitempty"`
	// TrackURLGroupName 监测链接组名称，应用型资产必填
	TrackURLGroupName string `json:"track_url_group_name,omitempty"`
	// TrackURLGroupID 监测链接组ID
	TrackURLGroupID uint64 `json:"track_url_group_id,omitempty"`
}

TrackURLGroup 监测链接组信息

type TrackURLUpdateRequest 

type TrackURLUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetsID 资产ID
	AssetsID uint64 `json:"assets_id,omitempty"`
	// DownloadURL 应用下载链接，应用下载链接，IOS和安卓应用资产：必填
	DownloadURL string `json:"download_url,omitempty"`
	// TrackURLGroup 监测链接组信息，IOS和安卓应用可绑定多组监测链接
	TrackURLGroup *TrackURLGroup `json:"track_url_group,omitempty"`
}

TrackURLUpdateRequest 事件资产下更新监测链接组 API Request

func (TrackURLUpdateRequest) Encode 

func (r TrackURLUpdateRequest) Encode() []byte

Encode implement PostRequest interface

Source Files

View all Source files

Directories

Path Synopsis
Package auth 鉴权管理接口
 Package auth 鉴权管理接口
Package v3 体验版事件管理
 Package v3 体验版事件管理

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.