event

package
v1.6.8 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AssetsCreateRequest added in v1.6.8 

type AssetsCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetType 资产类型，目前仅支持THIRD_EXTERNAL 三方落地页
	AssetType enum.AssetType `json:"asset_type,omitempty"`
	// ThirdPartAsset 三方落地页资产信息
	ThirdPartAsset *ThirdPartAsset `json:"third_part_asset,omitempty"`
}

AssetsCreateRequest 创建资产 API Request

func (AssetsCreateRequest) Encode added in v1.6.8 

func (r AssetsCreateRequest) Encode() []byte

Encode implement PostRequest interface

type AssetsCreateResponse added in v1.6.8 

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 *LandingPage `json:"landing_page,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"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值10，最大30
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤条件
	Filtering *AssetsGetFiltering `json:"filtering,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"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

AssetsGetResponseData json返回值

type AttributionConfiguration added in v1.6.8 

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

AttributionConfiguration 属性配置

type AvailableEventsGetRequest added in v1.6.8 

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 added in v1.6.8 

func (r AvailableEventsGetRequest) Encode() string

Encode implement GetRequest interface

type AvailableEventsGetResponse added in v1.6.8 

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

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

type ConvertOptimizedGoal 

type ConvertOptimizedGoal 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:建站
	AssetTypes []enum.AssetType `json:"asset_types,omitempty"`
	// DeepGoals 深度优化目标列表
	DeepGoals []ConvertOptimizedGoal `json:"deep_goals,omitempty"`
	// DeepExternalAction 深度转化目标，具体枚举可查看【附录-预定义转化类型】
	DeepExternalAction enum.AdConvertType `json:"deep_external_action,omitempty"`
}

ConvertOptimizedGoal 优化目标数据

type ConvertOptimizedGoalGetRequest 

type ConvertOptimizedGoalGetRequest 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 建站
	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"`
	// CampaignType 广告类型，默认值信息流。允许值：FEED 信息流、SEARCH 搜索
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
}

ConvertOptimizedGoalGetRequest 获取优化目标 API Request

func (ConvertOptimizedGoalGetRequest) Encode 

func (r ConvertOptimizedGoalGetRequest) Encode() string

Encode implement GetRequest interface

type ConvertOptimizedGoalGetResponse 

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

ConvertOptimizedGoalGetResponse 获取优化目标 API Response

type ConvertOptimizedGoalGetResponseData 

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

ConvertOptimizedGoalGetResponseData json返回值

type EventConfig added in v1.6.8 

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 added in v1.6.8 

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 added in v1.6.8 

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 added in v1.6.8 

func (r EventConfigsGetRequest) Encode() string

Encode implement GetRequest interface

type EventConfigsGetResponse added in v1.6.8 

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

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

type EventsCreateRequest added in v1.6.8 

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"`
	// StatisticalType 统计方式， 允许值：ONLY_ONE 仅一次
	StatisticalType string `json:"statistical_type,omitempty"`
	// TrackTypes 事件回传方式列表，允许值：JSSDK JS埋码 、EXTERNAL_API API回传 、XPATH XPath圈选
	TrackTypes []enum.EventTrackType `json:"track_types,omitempty"`
}

EventsCreateRequest 创建事件 API Request

func (EventsCreateRequest) Encode added in v1.6.8 

func (r EventsCreateRequest) Encode() []byte

Encode implement PostRequest interface

type LandingPage 

type LandingPage struct {
	// AssetID 三方的资产id
	AssetID uint64 `json:"asset_id,omitempty"`
	// AssetName 三方落地页名称
	AssetName string `json:"asset_name,omitempty"`
}

LandingPage 三方落地页数据

type ThirdPartAsset added in v1.6.8 

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

ThirdPartAsset 三方落地页资产信息

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.