v3

package
v1.27.3 Latest Latest
Warning

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

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

Documentation

Overview

Package v3 体验版数据报表

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CustomConfig added in v1.9.28 

type CustomConfig struct {
	// DataTopic 数据主题
	DataTopic string `json:"data_topic,omitempty"`
	// Dimensions 维度列表
	Dimensions []Dimension `json:"dimensions,omitempty"`
	// Metrics 指标列表
	Metrics []Dimension `json:"metrics,omitempty"`
}

CustomConfig 数据主题配置

type CustomConfigGetRequest added in v1.9.28 

type CustomConfigGetRequest struct {
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DataTopics 数据主题列表
	// 枚举值：BASIC_DATA广告基础数据、QUERY_DATA搜索词数据、BIDWORD_DATA关键词数据、MATERIAL_DATA素材数据, PRODUCT_DATA用于表达产品数据主题
	DataTopics []string `json:"data_topics,omitempty"`
}

CustomConfigGetRequest 获取自定义报表可用指标和维度 API Request

func (CustomConfigGetRequest) Encode added in v1.9.28 

func (r CustomConfigGetRequest) Encode() string

Encode implement GetRequest interface

type CustomConfigGetResponse added in v1.9.28 

type CustomConfigGetResponse struct {
	model.BaseResponse
	Data struct {
		// List 数据主题配置列表
		List []CustomConfig `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

CustomConfigGetResponse 获取自定义报表可用指标和维度 API Response

type CustomDimensions added in v1.9.3 

type CustomDimensions struct {
	// StatTimeHour 细分到每个小时的数据
	StatTimeHour string `json:"stat_time_hour,omitempty"`
	// StatTimeDay 细分到自然天的数据
	StatTimeDay string `json:"stat_time_day,omitempty"`
	// StatTimeWeek 细分到自然周的数据，周一到周日为一整周
	StatTimeWeek string `json:"stat_time_week,omitempty"`
	// StatTimeMonth 细分到自然月的数据，例如2022-3，表示是3月1日到3月31日
	StatTimeMonth string `json:"stat_time_month,omitempty"`
	// CdpProjectID 项目ID
	CdpProjectID model.Uint64 `json:"cdp_project_id,omitempty"`
	// CdpProjectName 项目的名称
	CdpProjectName string `json:"cdp_project_name,omitempty"`
	// LandingType 对应项目的推广目的
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// ExternalAction 对应项目的转化目标
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// Pricing 对应项目的计费类型
	Pricing int `json:"pricing,omitempty"`
	// DeepExternalAction 对应项目的深度转化目标
	DeepExternalAction string `json:"deep_external_action,omitempty"`
	// AdPlatformCdpProjectDownloadType 在项目中设置的下载方式
	AdPlatformCdpProjectDownloadType string `json:"ad_platform_cdp_project_download_type,omitempty"`
	// AdPlatformCdpProjectDownloadURL 在项目中设置的下载链接
	AdPlatformCdpProjectDownloadURL string `json:"ad_platform_cdp_project_download_url,omitempty"`
	// AdPlatformCdpProjectDownloadActionTrackURL 在项目中设置的监测链接
	AdPlatformCdpProjectDownloadActionTrackURL string `json:"ad_platform_cdp_project_action_track_url,omitempty"`
	// DeliveryMode 投放模式
	DeliveryMode enum.AdDeliveryRange `json:"delivery_mode,omitempty"`
	// CdpPromotionID 广告ID
	CdpPromotionID model.Uint64 `json:"cdp_promotion_id,omitempty"`
	// CdpPromotionName 对应广告的名称
	CdpPromotionName string `json:"cdp_promotion_name,omitempty"`
	// AdPlatformCdpPromotionBid 在广告中设置的出价
	AdPlatformCdpPromotionBid model.Float64 `json:"ad_platform_cdp_promotion_bid,omitempty"`
	// AdPlatformCdpPromotionDeepCpaBid 在广告中设置的深度转化出价
	AdPlatformCdpPromotionDeepCpaBid model.Float64 `json:"ad_platform_cdp_promotion_roi_goal,omitempty"`
	// AppCode 您所投放的广告数据中，对应的首选广告位
	AppCode string `json:"app_code,omitempty"`
	// PackageName 您在项目中设置的应用包包名
	PackageName string `json:"package_name,omitempty"`
	// Gender 您所投放的广告数据中，对应的用户性别。无法识别的性别数据会显示为“其他”
	Gender int `json:"gender,omitempty"`
	// Age 您所投放的广告数据中，对应的用户年龄。无法识别的年龄数据会显示为“其他”
	Age enum.AudienceAge `json:"age,omitempty"`
	// Ac 您所投放的广告数据中，对应的用户网络环境。无法识别的网络数据会显示为“其他”
	Ac int `json:"ac,omitempty"`
	// Platform 您所投放的广告数据，对应的操作系统平台，无法识别的操作系统会显示为“其他”
	Platform enum.AudiencePlatform `json:"platform,omitempty"`
	// ProvinceName 您所投放的广告数据，对应的用户省份信息
	ProvinceName string `json:"province_name,omitempty"`
	// CityName 您所投放的广告数据，对应的用户城市信息
	CityName string `json:"city_name,omitempty"`
	// MaterialID 素材的ID
	MaterialID model.Uint64 `json:"material_id,omitempty"`
	// AdPlatformMaterialContent 对应的素材标题、视频及图片内容
	AdPlatformMaterialContent string `json:"ad_platform_material_content,omitempty"`
	// ImageMode 对应的素材类型，包括标题、大图横图、竖版视频等
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// AdPlatformMaterialName 素材为视频素材时，对应的视频名称
	AdPlatformMaterialName string `json:"ad_platform_material_name,omitempty"`
	// CampaignType
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
	// Query 搜索词
	Query string `json:"query,omitempty"`
	// AdPlatformBidword 关键词
	AdPlatformBidword string `json:"ad_platform_bidword"`
	// BidwordId 关键词ID。特殊说明：0表示未知关键词，-2表示智选流量。
	BidwordId model.Uint64 `json:"bidword_id"`
	// Bidword 关键词名称。如果分组条件中包括STAT_GROUP_BY_BIDWORD_ID
	Bidword string `json:"bidword"`
	// RealRecallMatchType 搜索触发方式
	RealRecallMatchType string `json:"real_recall_match_type"`
	//BidwordSource  关键词来源
	BidwordSource string `json:"bidword_source"`
	//AdBidwordId 搜索广告计划粒度下关键词唯一ID
	AdBidwordId model.Uint64 `json:"ad_bidword_id"`
}

type CustomGetFilter 

type CustomGetFilter struct {
	// Field 过滤的消耗指标字段
	Field string `json:"field,omitempty"`
	// Type 字段类型。允许值：
	// 1 -固定枚举值
	// 2 - 固定输入值
	// 3 -数值类型
	Type int `json:"type,omitempty"`
	// Operator 处理方式。 允许值：
	// 1 -等于
	// 2 -小于
	// 3 -小于等于
	// 4 -大于
	// 5 -大于等于
	// 6 -不等于
	// 7-包含
	// 8 -不包含
	// 9 -范围查询
	// 10 -多个值匹配包含
	// 11 -多个值匹配都要包含
	Operator int `json:"operator,omitempty"`
	// Values 过滤字段具体值
	Values []string `json:"values,omitempty"`
}

CustomGetFilter 数据报表过滤条件

type CustomGetListItem 

type CustomGetListItem struct {
	// Metrics 指标数据
	Metrics *CustomMetrics `json:"metrics,omitempty"`
	// Dimensions 维度数据
	Dimensions *CustomDimensions `json:"dimensions,omitempty"`
}

CustomGetListItem 数据详情

type CustomGetRequest 

type CustomGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DateTopic 数据主题
	DataTopic string `json:"data_topic"`
	// Dimensions 维度列表。获取方式：巨量引擎体验版—>报表—>新建/编辑自定义报表—>API参数生成。该字段从前端自定义报表中获取，建议不要修改。
	Dimensions []string `json:"dimensions,omitempty"`
	// Metrics 指标列表 。获取方式：巨量引擎体验版—>报表—>新建/编辑自定义报表—>API参数生成。该字段从前端自定义报表中获取，建议不要修改。
	Metrics []string `json:"metrics,omitempty"`
	// StartTime 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartTime time.Time `json:"start_time,omitempty"`
	// EndTime 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndTime time.Time `json:"end_time,omitempty"`
	// OrderBy 排序
	OrderBy []OrderBy `json:"order_by,omitempty"`
	// Page 页码；默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量；默认值: 20；取值范围: 1-1000
	PageSize int `json:"page_size,omitempty"`
	// Filters 过滤字段，json格式，支持字段如下
	Filters []CustomGetFilter `json:"filters,omitempty"`
}

CustomGetRequest 自定义报表 API Request

func (CustomGetRequest) Encode 

func (r CustomGetRequest) Encode() string

Encode implement GetRequest interface

type CustomGetResponse 

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

CustomGetResponse 自定义数据报表 API Response

type CustomGetResult 

type CustomGetResult struct {
	// Rows 数据列表
	Rows []CustomGetListItem `json:"rows,omitempty"`
	// TotalMetrics 指标汇总数据
	TotalMetrics *CustomMetrics `json:"total_metrics,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

CustomGetResult 返回值

type CustomMetrics added in v1.9.3 

type CustomMetrics struct {
	// StatCost 表示广告在投放期内的预估花费金额。当天数据可能会有波动，次日稳定
	StatCost model.Float64 `json:"stat_cost,omitempty"`
	// ShowCnt 广告展示给用户的次数。计算方式：经平台判定有效且被计费的展示次数。
	ShowCnt model.Int64 `json:"show_cnt,omitempty"`
	// CpmPlatform 广告平均每一千次展现所付出的费用，计算公式是：总花费/展示数*1000。
	CpmPlatform model.Float64 `json:"cpm_platform,omitempty"`
	// ClickCnt 当头条用户点击广告素材时，触发点击事件，该事件被认为是一次有效的广告点击。
	ClickCnt model.Int64 `json:"click_cnt,omitempty"`
	// Ctr 广告被点击的次数占展示次数的百分比。计算方法：点击数/展示数*100%
	Ctr model.Float64 `json:"ctr,omitempty"`
	// CpcPlatform 广告主为每次点击付出的费用成本，计算公式是：总花费/点击数。
	CpcPlatform model.Float64 `json:"cpc_platform,omitempty"`
	// ClickStartCnt 用户在落地页中开始安装包下载进程的次数，仅安卓下载可以监测到该行为
	ClickStartCnt model.Int64 `json:"click_start_cnt,omitempty"`
	// ClickStartCost 计算方法：总花费/安卓下载开始数。
	ClickStartCost model.Float64 `json:"click_start_cost,omitempty"`
	// ClickStartRate 计算方法：安卓下载开始数/点击数
	ClickStartRate model.Float64 `json:"click_start_rate,omitempty"`
	// DownloadFinishCnt 用户在落地页中下载安装包进程完成的次数，仅安卓下载可以监测到该行为
	DownloadFinishCnt model.Int64 `json:"download_finish_cnt,omitempty"`
	// DownloadFinishCost 计算方式：总花费/安卓下载完成数。
	DownloadFinishCost model.Float64 `json:"download_finish_cost,omitempty"`
	// DownloadFinishRate 计算方式：安卓下载完成数/安卓下载开始数
	DownloadFinishRate model.Float64 `json:"download_finish_rate,omitempty"`
	// InstallFinishCnt 用户在落地页中将安装包安装完成的次数，仅安卓下载可以监测到该行为。如果您的计划开启了商店直投，则下载相关行为数据有部分无法被监测到，而安装数据不受影响，因此安装数可能会大于下载数。
	InstallFinishCnt model.Int64 `json:"install_finish_cnt,omitempty"`
	// InstallFinishCost 计算方式：总花费/安卓安装完成数
	InstallFinishCost model.Float64 `json:"install_finish_cost,omitempty"`
	// InstallFinishRate 计算方式：安卓安装完成数/安卓下载完成数
	InstallFinishRate model.Float64 `json:"install_finish_rate,omitempty"`
	// Active 如果您对接了API，激活数是您认可且回传成功的的激活数。如果您对接了SDK，则激活数是指用户下载您的APP后打开的次数。
	Active model.Int64 `json:"active,omitempty"`
	// ActiveCost 计算方式：总花费/激活数。
	ActiveCost model.Float64 `json:"active_cost,omitempty"`
	// ActiveRate 计算方式：激活数/点击数*100%
	ActiveRate model.Float64 `json:"active_rate,omitempty"`
	// ActiveRegister 如果您对接了API，注册数是您认可且回传成功的的注册数。如果您对接了SDK，则注册数是用户实现注册行为的次数，详情见「SDK对接文档」
	ActiveRegister model.Int64 `json:"active_register,omitempty"`
	// ActiveRegisterCost 广告主为每个注册所付出的成本，计算公式是：总花费/注册数，当天数据可能会有波动，次日早8点后稳定。
	ActiveRegisterCost model.Float64 `json:"active_register_cost,omitempty"`
	// ActiveRegisterRate 注册用户占激活用户的比例
	ActiveRegisterRate model.Float64 `json:"active_register_rate,omitempty"`
	// GameAddiction 有APP内关键行为的用户数量
	GameAddiction model.Int64 `json:"game_addiction,omitempty"`
	// GameAddictionCost 广告主为每个有APP内关键行为的用户所付出的成本，计算公式是总花费/关键行为数。当天数据可能会有波动，次日早8点后稳定。
	GameAddictionCost model.Float64 `json:"game_addiction_cost,omitempty"`
	// GameAddictionRate 关键行为用户占激活用户的比例
	GameAddictionRate model.Float64 `json:"game_addiction_rate,omitempty"`
	// AttributionNextDayOpenCnt 当日激活用户在第二天继续登录，则计为一个次留行为。该指标会将收到的次留回传数据，匹配到对应的激活时间上。 例如：8月1日有10个激活，其中5个在8月2日继续登录，则8月1日的次留数为5。
	AttributionNextDayOpenCnt model.Int64 `json:"attribution_next_day_open_cnt,omitempty"`
	// AttributionNextDayOpenCost 次留成本=消耗/次留数
	AttributionNextDayOpenCost model.Float64 `json:"attribution_next_day_open_cost,omitempty"`
	// AttributionNextDayOpenRate 次留率=次留数/激活数
	AttributionNextDayOpenRate model.Float64 `json:"attribution_next_day_open_rate,omitempty"`
	// NextDayOpen 根据您通过api或sdk回传给我们的时间为准，将次留数披露在回传时间。
	NextDayOpen model.Int64 `json:"next_day_open,omitempty"`
	// ActivePay 用户在应用内首次完成付费的次数
	ActivePay model.Int64 `json:"active_pay,omitempty"`
	// ActivePayCost 用户在应用内首次完成付费的成本，计算方式：消耗/首次付费数。
	ActivePayCost model.Float64 `json:"active_pay_cost,omitempty"`
	// ActivePayRate 计算方式：首次付费数/激活数。
	ActivePayRate model.Float64 `json:"active_pay_rate,omitempty"`
	// GamePayCount 当天用户在应用内完成付费的总次数，多次付费会重复计数。
	GamePayCount model.Int64 `json:"game_pay_count,omitempty"`
	// GamePayCost 当天用户在应用内完成付费的平均成本，计算方式：消耗/付费次数。
	GamePayCost model.Float64 `json:"game_pay_cost,omitempty"`
	// AttributionGamePay7dCount 用户激活应用后的7天内，在应用内完成付费的总次数，并将付费次数披露在每个用户的激活时间上。
	AttributionGamePay7dCount model.Int64 `json:"attribution_game_pay_7d_count,omitempty"`
	// AttributionGamePay7dCost 用户激活应用后的7天内，在应用内完成付费的平均成本，计算方式：消耗/7日付费次数(激活时间)。
	AttributionGamePay7dCost model.Float64 `json:"attribution_game_pay_7d_cost,omitempty"`
	// AttributionGamePay7dPerCount 7天内用户的平均付费次数，计算方式：7日付费次数（激活时间）/7日首次付费数(激活时间)，对首次付费数的统计仅在计划内去重且披露在每个用户的激活时间上。
	AttributionGamePay7dPerCount model.Float64 `json:"attribution_active_pay_7d_per_count,omitempty"`
	// InAppUv 用户调起APP后到达的次数，一般在DPA广告中使用
	InAppUv model.Int64 `json:"in_app_uv,omitempty"`
	// InAppDetailUv 用户调起APP后到达指定详情页的次数，一般在DPA广告中使用
	InAppDetailUv model.Int64 `json:"in_app_detail_uv,omitempty"`
	// InAppCart 用户调起APP后加入购物车的次数，一般在DPA广告中使用
	InAppCart model.Int64 `json:"in_app_cart,omitempty"`
	// InAppPay 用户调起APP后完成付费的次数，一般在DPA广告中使用
	InAppPay model.Int64 `json:"in_app_pay,omitempty"`
	// InAppOrder 用户调起APP后提交订单的次数，一般在DPA广告中使用
	InAppOrder model.Int64 `json:"in_app_order,omitempty"`
	// InAppPayOrderGmv 引流电商订单GMV, 当您使用“in_app_order”事件回传订单金额时，对应的GMV金额
	InAppPayOrderGmv model.Float64 `json:"in_app_pay_order_gmv,omitempty"`
	// InAppPayOrderRoi 引流电商订单ROI, 引流电商订单GMV/消耗"
	InAppPayOrderRoi model.Float64 `json:"in_app_pay_order_roi,omitempty"`
	// InAppPayGmv 引流电商支付GMV, 当您使用“in_app_pay”事件回传支付金额时，对应的GMV金额"
	InAppPayGmv model.Float64 `json:"in_app_pay_gmv,omitempty"`
	// InAppPayRoi 引流电商支付ROI, 引流电商支付GMV/消耗
	InAppPayRoi model.Float64 `json:"in_app_pay_roi,omitempty"`
	// AttributionGameInAppLtv1Day 所选时间范围内的激活用户，激活当日在APP内的付费金额。
	AttributionGameInAppLtv1Day model.Float64 `json:"attribution_game_in_app_ltv_1day,omitempty"`
	// AttributionGameInAppLtv2Days 所选时间范围内的激活用户，激活后一天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv2Days model.Float64 `json:"attribution_game_in_app_ltv_2days,omitempty"`
	// AttributionGameInAppLtv3Days 所选时间范围内的激活用户，激活后二天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv3Days model.Float64 `json:"attribution_game_in_app_ltv_3days,omitempty"`
	// AttributionGameInAppLtv4Days 所选时间范围内的激活用户，激活后三天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv4Days model.Float64 `json:"attribution_game_in_app_ltv_4days,omitempty"`
	// AttributionGameInAppLtv5Days 所选时间范围内的激活用户，激活后四天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv5Days model.Float64 `json:"attribution_game_in_app_ltv_5days,omitempty"`
	// AttributionGameInAppLtv6Days 所选时间范围内的激活用户，激活后五天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv6Days model.Float64 `json:"attribution_game_in_app_ltv_6days,omitempty"`
	// AttributionGameInAppLtv7Days 所选时间范围内的激活用户，激活后六天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv7Days model.Float64 `json:"attribution_game_in_app_ltv_7days,omitempty"`
	// AttributionGameInAppLtv8Days 所选时间范围内的激活用户，激活后七天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv8Days model.Float64 `json:"attribution_game_in_app_ltv_8days,omitempty"`
	// AttributionGameInAppRoi1Day 所选时间范围内的激活用户在激活当日的付费ROI，计算公式是：当日付费金额/所选时间的消耗。
	AttributionGameInAppRoi1Day model.Float64 `json:"attribution_game_in_app_roi_1day,omitempty"`
	// AttributionGameInAppRoi2Days 所选时间范围内的激活用户在激活后一日内的所有付费ROI，计算公式是：激活后一日付费金额/所选时间的消耗。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppRoi2Days model.Float64 `json:"attribution_game_in_app_roi_2days,omitempty"`
	// AttributionGameInAppRoi3Days 所选时间范围内的激活用户在激活后二日内的所有付费ROI，计算公式是：激活后二日付费金额/所选时间的消耗。
	AttributionGameInAppRoi3Days model.Float64 `json:"attribution_game_in_app_roi_3days,omitempty"`
	// AttributionGameInAppRoi4Days 所选时间范围内的激活用户在激活后三日内的所有付费ROI，计算公式是：激活后三日付费金额/所选时间的消耗。
	AttributionGameInAppRoi4Days model.Float64 `json:"attribution_game_in_app_roi_4days,omitempty"`
	// AttributionGameInAppRoi5Days 所选时间范围内的激活用户在激活后四日内的所有付费ROI，计算公式是：激活后四日付费金额/所选时间的消耗。
	AttributionGameInAppRoi5Days model.Float64 `json:"attribution_game_in_app_roi_5days,omitempty"`
	// AttributionGameInAppRoi6Days 所选时间范围内的激活用户在激活后五日内的所有付费ROI，计算公式是：激活后五日付费金额/所选时间的消耗。
	AttributionGameInAppRoi6Days model.Float64 `json:"attribution_game_in_app_roi_6days,omitempty"`
	// AttributionGameInAppRoi7Days 所选时间范围内的激活用户在激活后六日内的所有付费ROI，计算公式是：激活后六日付费金额/所选时间的消耗。
	AttributionGameInAppRoi7Days model.Float64 `json:"attribution_game_in_app_roi_7days,omitempty"`
	// AttributionGameInAppRoi8Days 所选时间范围内的激活用户在激活后七日内的整体付费ROI，计算公式是：激活后七日付费金额/所选时间的消耗。
	AttributionGameInAppRoi8Days model.Float64 `json:"attribution_game_in_app_roi_8days,omitempty"`
	// AttributionDayActivePayCost 消耗/计费当日激活且首次付费数
	AttributionDayActivePayCost model.Float64 `json:"attribution_day_active_pay_cost,omitempty"`
	// AttributionDayActivePayRate 计费当日激活且首次付费数/激活数
	AttributionDayActivePayRate model.Float64 `json:"attribution_day_active_pay_rate,omitempty"`
	// ActivePayIntraDayCount 当日发生激活且首次付费的次数
	ActivePayIntroDayCount model.Int64 `json:"active_pay_intra_day_count,omitempty"`
	// ActivePayIntraDayCost 消耗/激活当日首次付费数
	ActivePayIntroDayCost model.Float64 `json:"active_pay_intra_day_cost,omitempty"`
	// ActivePayIntraDayRate 激活当日首次付费数/激活数
	ActivePayIntroDayRate model.Float64 `json:"active_pay_intra_day_rate,omitempty"`
	// ConvertCnt 将转化数记录在转化事件发生的时间上。建议广告主考核成本时参考“转化数据（计费时间）”例如您的广告在早上8点进行了展示和点击，用户晚上19点发生了激活行为，我们会把激活数披露在晚上19点。
	ConvertCnt model.Int64 `json:"convert_cnt,omitempty"`
	// ConversionCost 广告主为每个转化所付出的平均成本，计算方式：总花费/转化数。当天数据可能会有波动。
	ConversionCost model.Float64 `json:"conversion_cost,omitempty"`
	// ConversionRate 广告被用户转化的次数占点击次数的百分比。计算方式：转化数/点击数*100%
	ConversionRate model.Float64 `json:"conversion_rate,omitempty"`
	// DeepConvertCnt 将深度转化数记录在转化事件发生的时间上。建议广告主考核深度转化成本时参考“深度转化数（计费时间）”例如您的广告在早上8点进行了展示和点击，用户晚上19点发生了激活行为，我们会把激活数披露在晚上19点。
	DeepConvertCnt model.Int64 `json:"deep_convert_cnt,omitempty"`
	// DeepConvertCost 广告主为每个深度转化所付出的平均成本，计算方法：总花费/深度转化数。当天数据可能会有波动，次日早8点后稳定。
	DeepConvertCost model.Float64 `json:"deep_convert_cost,omitempty"`
	// DeepConvertRate 广告被用户进行深度转化的次数占转化次数的百分比。计算方式：深度转化数/转化数*100%
	DeepConvertRate model.Float64 `json:"deep_convert_rate,omitempty"`
	// AttributionConvertCnt 在转化行为发生（或回传）之后，将转化行为回记到过去30天内的扣费（消耗产生）时间上。 例如：广告在8月20日展示给用户，此时广告花费10元，用户点击广告后于8月23日产生1笔购买，则8月23日这笔购买将会展示在8月20日，8月23日没有转化数。
	AttributionConvertCnt model.Int64 `json:"attribution_convert_cnt,omitempty"`
	// AttributionConvertCost 转化成本(计费时间) = 消耗 / 转化数(计费时间)。例如：广告在8月20日展示给用户，此时广告花费10元，用户点击广告后，于8月23日产生2笔购买，则8月20日的转化成本（计费时间） = 5元（即10元除以2笔）。成本考核和系统赔付以该指标为准。
	AttributionConvertCost model.Float64 `json:"attribution_convert_cost,omitempty"`
	// AttributionDeepConvertCnt 在转化行为发生（或回传）之后，将转化行为回记到过去30天内的扣费（消耗产生）时间上。 例如：广告在8月20日展示给用户，此时广告花费10元，用户点击广告后于8月23日产生1笔购买，则8月23日这笔购买将会展示在8月20日。
	AttributionDeepConvertCnt model.Int64 `json:"attribution_deep_convert_cnt,omitempty"`
	// AttributionDeepConvertCost 是一个准确的深度转化成本评估指标。计算方式：消耗 / 深度转化数(计费时间)。例如：广告在8月20日展示给用户，此时广告花费10元，用户点击广告后，于 8 月 23 日产生2笔购买，则8月20日的深度转化成本（计费时间） = 5元（即10元除以2笔）。成本考核和系统赔付以该指标为准。
	AttributionDeepConvertCost model.Float64 `json:"attribution_deep_convert_cost,omitempty"`
	// AttributionDeepConvertRate 深度转化数（计费时间）/转化数（计费时间）*100%
	AttributionDeepConvertRate model.Float64 `json:"attribution_deep_convert_rate,omitempty"`
	// TotalPlay 播放量, 播放时间大于0S的数量，在某些蜂窝网络环境下，需要您手动点击开始才会开始播放，因此有时播放数小于展示数。
	TotalPlay model.Int64 `json:"total_play,omitempty"`
	// ValidPlay 有效播放数, 竞价广告播放时间大于等于10秒的数量，如果视频总时长不足10秒，则记录播放完成的次数。品牌广告在部分APP（头条、头条lite、抖音、西瓜、抖音火山版、皮皮虾）播放时间大于等于5秒的数量，在其他APP大于等于3秒的数量，如果视频总时长不足5秒/3秒时，则记录播放完成的次数。
	ValidPlay model.Int64 `json:"valid_play,omitempty"`
	// ValidPlayCost 有效播放成本, 计算公式：总花费/有效播放数，当天数据可能会有波动，次日早8点后稳定。
	ValidPlayCost model.Float64 `json:"valid_play_cost,omitempty"`
	// ValidPlayRate 有效播放率, 计算公式：有效播放数/展示数。
	ValidPlayRate model.Float64 `json:"valid_play_rate,omitempty"`
	// AttributionMicroGame0dLtv 小游戏当日LTV-所选时间范围内的激活用户在激活当日的变现金额
	AttributionMicroGame0dLtv model.Float64 `json:"attribution_micro_game_0d_ltv,omitempty"`
	// AttributionMicroGame3dLtv 小游戏激活后三日LTV-所选时间范围内的激活用户在激活后三日内的变现金额
	AttributionMicroGame3dLtv model.Float64 `json:"attribution_micro_game_3d_ltv,omitempty"`
	// AttributionMicroGame7dLtv 小游戏激活后七日LTV-所选时间范围内的激活用户在激活后七日内的变现金额
	AttributionMicroGame7dLtv model.Float64 `json:"attribution_micro_game_7d_ltv,omitempty"`
	// AttributionMicroGame0dRoi 小游戏当日广告变现ROI-所选时间范围内的激活用户在激活当日的广告变现ROI，计算公式是：当日LTV / 所选时间的消耗
	AttributionMicroGame0dRoi model.Float64 `json:"attribution_micro_game_0d_roi,omitempty"`
	// AttributionMicroGame3dRoi 小游戏激活后三日广告变现ROI-所选时间范围内的激活用户在激活后三日内的广告变现ROI，计算公式是：三日LTV / 所选时间的消耗
	AttributionMicroGame3dRoi model.Float64 `json:"attribution_micro_game_3d_roi,omitempty"`
	// AttributionMicroGame7dRoi 小游戏激活后七日广告变现ROI-所选时间范围内的激活用户在激活后七日内的广告变现ROI，计算公式是：七日LTV / 所选时间的消耗
	AttributionMicroGame7dRoi model.Float64 `json:"attribution_micro_game_7d_roi,omitempty"`
	// 播放3s; 广告播放时间大于等于3秒的数量，如果视频总时长不足3秒，则记录播放完成的次数
	PlayDuration3s model.Float64 `json:"play_duration_3s,omitempty"`
	// 视频数据-播完率; 计算公式：播放完成数/播放数
	PlayOverRate model.Float64 `json:"play_over_rate,omitempty"`
	// AvgRank 关键词排名
	AvgRank model.Int64 `json:"avg_rank,omitempty"`
}

type Dimension added in v1.9.28 

type Dimension struct {
	// Field 维度字段
	Field string `json:"field,omitempty"`
	// Name 维度名称
	Name string `json:"name,omitempty"`
	// Description 维度描述
	Description string `json:"description,omitempty"`
	// Sortable 是否支持排序
	Sortable bool `json:"sort_able,omtiempty"`
	// Filterable 是否支持可筛选
	Filterable bool `json:"filter_able,omitempty"`
	// FilterConfig 过滤条件
	FilterConfig *FilterConfig `json:"filter_config,omitempty"`
}

Dimension 维度

type Dimensions 

type Dimensions struct {
	// ProjectID 项目ID，分组条件包含 STAT_GROUP_BY_APP_PROJECT_ID 时返回
	ProjectID uint64 `json:"project_id,omitempty"`
	// PromotionID 广告ID，分组条件包含 STAT_GROUP_BY_APP_PROMOTION_ID 时返回
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// LandingType 对应项目的推广目的
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// ExternalAction 对应项目的转化目标
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// PricingType 对应项目的计费类型
	PricingType enum.PricingType `json:"pricing_type,omitempty"`
	// AppCode 您所投放的广告数据中，对应的首选广告位
	AppCode int `json:"app_code,omitempty"`
	// ExternalUrl 落地页链接
	ExternalUrl string `json:"external_url,omitempty"`
	// PackageName 您在项目中设置的应用包包名
	PackageName string `json:"package_name,omitempty"`
	// Gender 您所投放的广告数据中，对应的用户性别。无法识别的性别数据会显示为“其他”
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 您所投放的广告数据中，对应的用户年龄。无法识别的年龄数据会显示为“其他”
	Age enum.AudienceAge `json:"age,omitempty"`
	// Ac 您所投放的广告数据中，对应的用户网络环境。无法识别的网络数据会显示为“其他”
	Ac int `json:"ac,omitempty"`
	// Platform 您所投放的广告数据，对应的操作系统平台，无法识别的操作系统会显示为“其他”
	Platform enum.AudiencePlatform `json:"platform,omitempty"`
	// Province 您所投放的广告数据，对应的用户省份信息
	Province string `json:"province,omitempty"`
	// City 您所投放的广告数据，对应的用户城市信息
	City string `json:"city,omitempty"`
}

Dimensions 维度数据

type FilterConfig added in v1.9.28 

type FilterConfig struct {
	// Type 字段类型。
	// 1 -固定枚举值
	// 2 - 固定输入值
	// 3 -数值类型
	Type int `json:"type,omitempty"`
	// Operator 处理方式。
	// 1-等于
	// 2 -小于
	// 3 -小于等于
	// 4 -大于
	// 5 -大于等于
	// 6 -不等于
	// 7-包含
	// 8 -不包含
	// 9 -范围查询
	// 10 -多个值匹配包含
	// 11 -多个值匹配都要包含
	Operator int `json:"operator,omitempty"`
	// ValueLimit 过滤字段传入数量上限
	ValueLimit int64 `json:"value_limit,omitempty"`
	// RangeValue 维度指标过滤枚举值列表
	RangeValue []RangeValue `json:"range_value,omitempty"`
	// ExclusionDims 互斥的维度列表
	ExclusionDims []string `json:"exclusion_dims,omitempty"`
	// ExclusionMetrics 互斥的指标列表
	ExclusionMetrics []string `json:"exclusion_metrics,omitempty"`
}

FilterConfig 过滤条件

type Material 

type Material struct {
	// Mid 素材id
	Mid uint64 `json:"mid,omitempty"`
	// ImageMode 视频素材类型，允许值：CREATIVE_IMAGE_MODE_VIDEO 横版视频、CREATIVE_IMAGE_MODE_VIDEO_VERTICAL 竖版视频
	ImageMode []enum.ImageMode `json:"image_mode,omitempty"`
	// AppCode 首选位置，允许值：
	// 西瓜视频[1]
	// 抖音火山版:[3]
	// 抖音短视频[4]
	// 今日头条:[8]
	// 番茄小说:[26]
	// 穿山甲:[9]
	// Ohayoo精品游戏:[27]
	AppCode []int `json:"app_code"`
}

Material 素材信息

type MaterialGetFilter 

type MaterialGetFilter struct {
	// ProjectID 项目ID，最多入参100个
	ProjectID []uint64 `json:"project_id,omitempty"`
	// PromotionID 广告ID，按照promotion_id过滤，最多支持100个
	PromotionID []uint64 `json:"promotion_id,omitempty"`
	// VideoMaterial 视频素材信息
	VideoMaterial *Material `json:"video_material,omitempty"`
	// ImageMaterial 图片素材信息
	ImageMaterial *Material `json:"image_material,omitempty"`
	// TitleMaterial 标题素材信息
	TitleMaterial *Material `json:"title_material,omitempty"`
	// DeliveryMode 投放模式筛选。允许值: MANUAL 手动、PROCEDURAL 自动
	DeliveryMode []string `json:"delivery_mode,omitempty"`
}

MaterialGetFilter 数据报表过滤条件

type MaterialGetListItem 

type MaterialGetListItem struct {
	// MaterialID 素材ID
	MaterialID uint64 `json:"material_id,omitempty"`
	// ImageMode 素材类型
	ImageMode string `json:"image_mode,omitempty"`
	// StatDatetime 数据时间
	StatDatetime string `json:"stat_datetime,omitempty"`
	// Data
	Data []Stat `json:"data,omitempty"`
}

MaterialGetListItem 数据详情

type MaterialGetRequest 

type MaterialGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndDate time.Time `json:"end_date,omitempty"`
	// Fields 指定需要的指标名称
	Fields []string `json:"fields,omitempty"`
	// GroupBy 分组条件默认为 STAT_GROUP_BY_FIELD_STAT_TIME
	GroupBy enum.StatGroupBy `json:"group_by,omitempty"`
	// TimeGranularity 时间粒度, 默认值: STAT_TIME_GRANULARITY_DAILY
	TimeGranularity enum.StatTimeGranularity `json:"time_granularity,omitempty"`
	// OrderField 排序字段，所有的统计指标均可参与排序
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序方式；默认值: DESC；允许值: ASC, DESC
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Page 页码；默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量；默认值: 20；取值范围: 1-1000
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤字段，json格式，支持字段如下
	Filtering *MaterialGetFilter `json:"filtering,omitempty"`
}

MaterialGetRequest 素材数据报表 API Request

func (MaterialGetRequest) Encode 

func (r MaterialGetRequest) Encode() string

Encode implement GetRequest interface

type MaterialGetResponse 

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

MaterialGetResponse 素材数据报表 API Response

type MaterialGetResult 

type MaterialGetResult struct {
	// List 数据列表
	List []MaterialGetListItem `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

MaterialGetResult 返回值

type Metrics 

type Metrics struct {
	// StatCost 表示广告在投放期内的预估花费金额。当天数据可能会有波动，次日稳定
	StatCost model.Float64 `json:"stat_cost,omitempty"`
	// ShowCnt 广告展示给用户的次数。计算方式：经平台判定有效且被计费的展示次数。
	ShowCnt model.Int64 `json:"show_cnt,omitempty"`
	// CpmPlatform 广告平均每一千次展现所付出的费用，计算公式是：总花费/展示数*1000。
	CpmPlatform model.Float64 `json:"cpm_platform,omitempty"`
	// ClickCnt 当头条用户点击广告素材时，触发点击事件，该事件被认为是一次有效的广告点击。
	ClickCnt model.Int64 `json:"click_cnt,omitempty"`
	// Ctr 广告被点击的次数占展示次数的百分比。计算方法：点击数/展示数*100%
	Ctr model.Float64 `json:"ctr,omitempty"`
	// CpcPlatform 广告主为每次点击付出的费用成本，计算公式是：总花费/点击数。
	CpcPlatform model.Float64 `json:"cpc_platform,omitempty"`
	// ClickStartCnt 用户在落地页中开始安装包下载进程的次数，仅安卓下载可以监测到该行为
	ClickStartCnt model.Int64 `json:"click_start_cnt,omitempty"`
	// ClickStartCost 计算方法：总花费/安卓下载开始数。
	ClickStartCost model.Float64 `json:"click_start_cost,omitempty"`
	// ClickStartRate 计算方法：安卓下载开始数/点击数
	ClickStartRate model.Float64 `json:"click_start_rate,omitempty"`
	// DownloadFinishCnt 用户在落地页中下载安装包进程完成的次数，仅安卓下载可以监测到该行为
	DownloadFinishCnt model.Int64 `json:"download_finish_cnt,omitempty"`
	// DownloadFinishCost 计算方式：总花费/安卓下载完成数。
	DownloadFinishCost model.Float64 `json:"download_finish_cost,omitempty"`
	// DownloadFinishRate 计算方式：安卓下载完成数/安卓下载开始数
	DownloadFinishRate model.Float64 `json:"download_finish_rate,omitempty"`
	// InstallFinishCnt 用户在落地页中将安装包安装完成的次数，仅安卓下载可以监测到该行为。如果您的计划开启了商店直投，则下载相关行为数据有部分无法被监测到，而安装数据不受影响，因此安装数可能会大于下载数。
	InstallFinishCnt model.Int64 `json:"install_finish_cnt,omitempty"`
	// InstallFinishCost 计算方式：总花费/安卓安装完成数
	InstallFinishCost model.Float64 `json:"install_finish_cost,omitempty"`
	// InstallFinishRate 计算方式：安卓安装完成数/安卓下载完成数
	InstallFinishRate model.Float64 `json:"install_finish_rate,omitempty"`
	// Active 如果您对接了API，激活数是您认可且回传成功的的激活数。如果您对接了SDK，则激活数是指用户下载您的APP后打开的次数。
	Active model.Int64 `json:"active,omitempty"`
	// ActiveCost 计算方式：总花费/激活数。
	ActiveCost model.Float64 `json:"active_cost,omitempty"`
	// ActiveRate 计算方式：激活数/点击数*100%
	ActiveRate model.Float64 `json:"active_rate,omitempty"`
	// ActiveRegister 如果您对接了API，注册数是您认可且回传成功的的注册数。如果您对接了SDK，则注册数是用户实现注册行为的次数，详情见「SDK对接文档」
	ActiveRegister model.Int64 `json:"active_register,omitempty"`
	// ActiveRegisterCost 广告主为每个注册所付出的成本，计算公式是：总花费/注册数，当天数据可能会有波动，次日早8点后稳定。
	ActiveRegisterCost model.Float64 `json:"active_register_cost,omitempty"`
	// ActiveRegisterRate 注册用户占激活用户的比例
	ActiveRegisterRate model.Float64 `json:"active_register_rate,omitempty"`
	// GameAddiction 有APP内关键行为的用户数量
	GameAddiction model.Int64 `json:"game_addiction,omitempty"`
	// GameAddictionCost 广告主为每个有APP内关键行为的用户所付出的成本，计算公式是总花费/关键行为数。当天数据可能会有波动，次日早8点后稳定。
	GameAddictionCost model.Float64 `json:"game_addiction_cost,omitempty"`
	// GameAddictionRate 关键行为用户占激活用户的比例
	GameAddictionRate model.Float64 `json:"game_addiction_rate,omitempty"`
	// AttributionNextDayOpenCnt 当日激活用户在第二天继续登录，则计为一个次留行为。该指标会将收到的次留回传数据，匹配到对应的激活时间上。 例如：8月1日有10个激活，其中5个在8月2日继续登录，则8月1日的次留数为5。
	AttributionNextDayOpenCnt model.Int64 `json:"attribution_next_day_open_cnt,omitempty"`
	// AttributionNextDayOpenCost 次留成本=消耗/次留数
	AttributionNextDayOpenCost model.Float64 `json:"attribution_next_day_open_cost,omitempty"`
	// AttributionNextDayOpenRate 次留率=次留数/激活数
	AttributionNextDayOpenRate model.Float64 `json:"attribution_next_day_open_rate,omitempty"`
	// NextDayOpen 根据您通过api或sdk回传给我们的时间为准，将次留数披露在回传时间。
	NextDayOpen model.Int64 `json:"next_day_open,omitempty"`
	// ActivePay 用户在应用内首次完成付费的次数
	ActivePay model.Int64 `json:"active_pay,omitempty"`
	// ActivePayCost 用户在应用内首次完成付费的成本，计算方式：消耗/首次付费数。
	ActivePayCost model.Float64 `json:"active_pay_cost,omitempty"`
	// ActivePayRate 计算方式：首次付费数/激活数。
	ActivePayRate model.Float64 `json:"active_pay_rate,omitempty"`
	// GamePayCount 当天用户在应用内完成付费的总次数，多次付费会重复计数。
	GamePayCount model.Int64 `json:"game_pay_count,omitempty"`
	// GamePayCost 当天用户在应用内完成付费的平均成本，计算方式：消耗/付费次数。
	GamePayCost model.Float64 `json:"game_pay_cost,omitempty"`
	// AttributionGamePay7dCount 用户激活应用后的7天内，在应用内完成付费的总次数，并将付费次数披露在每个用户的激活时间上。
	AttributionGamePay7dCount model.Int64 `json:"attribution_game_pay_7d_count,omitempty"`
	// AttributionGamePay7dCost 用户激活应用后的7天内，在应用内完成付费的平均成本，计算方式：消耗/7日付费次数(激活时间)。
	AttributionGamePay7dCost model.Float64 `json:"attribution_game_pay_7d_cost,omitempty"`
	// InAppUv 用户调起APP后到达的次数，一般在DPA广告中使用
	InAppUv model.Int64 `json:"in_app_uv,omitempty"`
	// InAppDetailUv 用户调起APP后到达指定详情页的次数，一般在DPA广告中使用
	InAppDetailUv model.Int64 `json:"in_app_detail_uv,omitempty"`
	// InAppCart 用户调起APP后加入购物车的次数，一般在DPA广告中使用
	InAppCart model.Int64 `json:"in_app_cart,omitempty"`
	// InAppPay 用户调起APP后完成付费的次数，一般在DPA广告中使用
	InAppPay model.Int64 `json:"in_app_pay,omitempty"`
	// InAppOrder 用户调起APP后提交订单的次数，一般在DPA广告中使用
	InAppOrder model.Int64 `json:"in_app_order,omitempty"`
	// AttributionGameInAppLtv1Day 所选时间范围内的激活用户，激活当日在APP内的付费金额。
	AttributionGameInAppLtv1Day model.Float64 `json:"attribution_game_in_app_ltv_1day,omitempty"`
	// AttributionGameInAppLtv2Days 所选时间范围内的激活用户，激活后一天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv2Days model.Float64 `json:"attribution_game_in_app_ltv_2days,omitempty"`
	// AttributionGameInAppLtv3Days 所选时间范围内的激活用户，激活后二天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv3Days model.Float64 `json:"attribution_game_in_app_ltv_3days,omitempty"`
	// AttributionGameInAppLtv4Days 所选时间范围内的激活用户，激活后三天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv4Days model.Float64 `json:"attribution_game_in_app_ltv_4days,omitempty"`
	// AttributionGameInAppLtv5Days 所选时间范围内的激活用户，激活后四天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv5Days model.Float64 `json:"attribution_game_in_app_ltv_5days,omitempty"`
	// AttributionGameInAppLtv6Days 所选时间范围内的激活用户，激活后五天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv6Days model.Float64 `json:"attribution_game_in_app_ltv_6days,omitempty"`
	// AttributionGameInAppLtv7Days 所选时间范围内的激活用户，激活后六天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv7Days model.Float64 `json:"attribution_game_in_app_ltv_7days,omitempty"`
	// AttributionGameInAppLtv8Days 所选时间范围内的激活用户，激活后七天内在APP内的付费金额总和。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppLtv8Days model.Float64 `json:"attribution_game_in_app_ltv_8days,omitempty"`
	// AttributionGameInAppRoi1Day 所选时间范围内的激活用户在激活当日的付费ROI，计算公式是：当日付费金额/所选时间的消耗。
	AttributionGameInAppRoi1Day model.Float64 `json:"attribution_game_in_app_roi_1day,omitempty"`
	// AttributionGameInAppRoi2Days 所选时间范围内的激活用户在激活后一日内的所有付费ROI，计算公式是：激活后一日付费金额/所选时间的消耗。该指标隔日产出，并做了模糊化处理。
	AttributionGameInAppRoi2Days model.Float64 `json:"attribution_game_in_app_roi_2days,omitempty"`
	// AttributionGameInAppRoi3Days 所选时间范围内的激活用户在激活后二日内的所有付费ROI，计算公式是：激活后二日付费金额/所选时间的消耗。
	AttributionGameInAppRoi3Days model.Float64 `json:"attribution_game_in_app_roi_3days,omitempty"`
	// AttributionGameInAppRoi4Days 所选时间范围内的激活用户在激活后三日内的所有付费ROI，计算公式是：激活后三日付费金额/所选时间的消耗。
	AttributionGameInAppRoi4Days model.Float64 `json:"attribution_game_in_app_roi_4days,omitempty"`
	// AttributionGameInAppRoi5Days 所选时间范围内的激活用户在激活后四日内的所有付费ROI，计算公式是：激活后四日付费金额/所选时间的消耗。
	AttributionGameInAppRoi5Days model.Float64 `json:"attribution_game_in_app_roi_5days,omitempty"`
	// AttributionGameInAppRoi6Days 所选时间范围内的激活用户在激活后五日内的所有付费ROI，计算公式是：激活后五日付费金额/所选时间的消耗。
	AttributionGameInAppRoi6Days model.Float64 `json:"attribution_game_in_app_roi_6days,omitempty"`
	// AttributionGameInAppRoi7Days 所选时间范围内的激活用户在激活后六日内的所有付费ROI，计算公式是：激活后六日付费金额/所选时间的消耗。
	AttributionGameInAppRoi7Days model.Float64 `json:"attribution_game_in_app_roi_7days,omitempty"`
	// AttributionGameInAppRoi8Days 所选时间范围内的激活用户在激活后七日内的整体付费ROI，计算公式是：激活后七日付费金额/所选时间的消耗。
	AttributionGameInAppRoi8Days model.Float64 `json:"attribution_game_in_app_roi_8days,omitempty"`
	// AttributionDayActivePayCount 广告计费当日激活且首次付费的次数
	AttributionDayActivePayCount model.Int64 `json:"attribution_day_acitve_pay_count,omitempty"`
	// AttributionDayActivePayCost 消耗/计费当日激活且首次付费数
	AttributionDayActivePayCost model.Float64 `json:"attribution_day_active_pay_cost,omitempty"`
	// AttributionDayActivePayRate 计费当日激活且首次付费数/激活数
	AttributionDayActivePayRate model.Float64 `json:"attribution_day_active_pay_rate,omitempty"`
	// ActivePayIntraDayCount 当日发生激活且首次付费的次数
	ActivePayIntroDayCount model.Int64 `json:"active_pay_intra_day_count,omitempty"`
	// ActivePayIntraDayCost 消耗/激活当日首次付费数
	ActivePayIntroDayCost model.Float64 `json:"active_pay_intra_day_cost,omitempty"`
	// ActivePayIntraDayRate 激活当日首次付费数/激活数
	ActivePayIntroDayRate model.Float64 `json:"active_pay_intra_day_rate,omitempty"`
	// ConvertCnt 将转化数记录在转化事件发生的时间上。建议广告主考核成本时参考“转化数据（计费时间）”例如您的广告在早上8点进行了展示和点击，用户晚上19点发生了激活行为，我们会把激活数披露在晚上19点。
	ConvertCnt model.Int64 `json:"convert_cnt,omitempty"`
	// ConversionCost 广告主为每个转化所付出的平均成本，计算方式：总花费/转化数。当天数据可能会有波动。
	ConversionCost model.Float64 `json:"conversion_cost,omitempty"`
	// ConversionRate 广告被用户转化的次数占点击次数的百分比。计算方式：转化数/点击数*100%
	ConversionRate model.Float64 `json:"conversion_rate,omitempty"`
	// DeepConvertCnt 将深度转化数记录在转化事件发生的时间上。建议广告主考核深度转化成本时参考“深度转化数（计费时间）”例如您的广告在早上8点进行了展示和点击，用户晚上19点发生了激活行为，我们会把激活数披露在晚上19点。
	DeepConvertCnt model.Int64 `json:"deep_convert_cnt,omitempty"`
	// DeepConvertCost 广告主为每个深度转化所付出的平均成本，计算方法：总花费/深度转化数。当天数据可能会有波动，次日早8点后稳定。
	DeepConvertCost model.Float64 `json:"deep_convert_cost,omitempty"`
	// DeepConvertRate 广告被用户进行深度转化的次数占转化次数的百分比。计算方式：深度转化数/转化数*100%
	DeepConvertRate model.Float64 `json:"deep_convert_rate,omitempty"`
	// AvgRank 关键词排名
	AvgRank model.Int64 `json:"avg_rank,omitempty"`
}

Metrics 指标数据

type OrderBy 

type OrderBy struct {
	// Field 排序字段。字段必须在选中的metrics或dimensions中。其中metrics所有字段支持排序。dimensions是否排序请参考维度、指标说明。
	Field string `json:"field,omitempty"`
	// Type 排序方式；默认值: DESC；允许值: ASC, DESC
	Type enum.OrderType `json:"type,omitempty"`
}

OrderBy 排序

type ProjectGetFilter 

type ProjectGetFilter struct {
	// ProjectID 项目ID，按照project_id过滤，最多支持100个
	ProjectID []uint64 `json:"project_id,omitempty"`
	// LandingType 推广目的，允许值：APP
	LandingType []enum.LandingType `json:"landing_type,omitempty"`
	// ExternalAction 转化目标，允许值：AD_CONVERT_TYPE_NOTIFY_DOWNLOAD
	// AD_CONVERT_TYPE_DOWNLOAD_FINISH
	// AD_CONVERT_TYPE_INSTALL_FINISH
	// AD_CONVERT_TYPE_ACTIVE
	// AD_CONVERT_TYPE_ACTIVE_REGISTER
	// AD_CONVERT_TYPE_GAME_ADDICTION
	// AD_CONVERT_TYPE_PAY
	ExternalAction []enum.AdConvertType `json:"external_action,omitempty"`
	// AppCode 首选位置，西瓜视频[1]
	// 抖音火山版:[3]
	// 抖音短视频[4]
	// 今日头条:[8]
	// 番茄小说:[26]
	// 穿山甲:[9]
	// Ohayoo精品游戏:[27]
	AppCode []int `json:"app_code,omitempty"`
	// Platform 平台，允许值：ANDROID 安卓、IOS 苹果、OTHER 其他
	Platform []enum.AudiencePlatform
	// PackageName 应用包名
	PackageName []string `json:"package_name,omitempty"`
	// DeliveryMode 投放模式筛选。允许值: MANUAL 手动、PROCEDURAL 自动
	DeliveryMode []string `json:"delivery_mode,omitempty"`
}

ProjectGetFilter 数据报表过滤条件

type ProjectGetListItem 

type ProjectGetListItem struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// ProjectName 项目名称
	ProjectName string `json:"project_name,omitempty"`
	// StatDatetime 数据时间
	StatDatetime string `json:"stat_datetime,omitempty"`
	// Data
	Data []Stat `json:"data,omitempty"`
}

ProjectGetListItem 数据详情

type ProjectGetRequest 

type ProjectGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndDate time.Time `json:"end_date,omitempty"`
	// Fields 指定需要的指标名称
	Fields []string `json:"fields,omitempty"`
	// GroupBy 分组条件默认为 STAT_GROUP_BY_FIELD_STAT_TIME
	GroupBy enum.StatGroupBy `json:"group_by,omitempty"`
	// TimeGranularity 时间粒度, 默认值: STAT_TIME_GRANULARITY_DAILY
	TimeGranularity enum.StatTimeGranularity `json:"time_granularity,omitempty"`
	// OrderField 排序字段，所有的统计指标均可参与排序
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序方式；默认值: DESC；允许值: ASC, DESC
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Page 页码；默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量；默认值: 20；取值范围: 1-1000
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤字段，json格式，支持字段如下
	Filtering *ProjectGetFilter `json:"filtering,omitempty"`
}

ProjectGetRequest 项目数据报表 API Request

func (ProjectGetRequest) Encode 

func (r ProjectGetRequest) Encode() string

Encode implement GetRequest interface

type ProjectGetResponse 

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

ProjectGetResponse 项目数据报表 API Response

type ProjectGetResult 

type ProjectGetResult struct {
	// List 数据列表
	List []ProjectGetListItem `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

ProjectGetResult 返回值

type PromotionGetFilter 

type PromotionGetFilter struct {
	// PromotionID 广告ID，按照promotion_id过滤，最多支持100个
	PromotionID []uint64 `json:"promotion_id,omitempty"`
	// LandingType 推广目的，允许值：APP
	LandingType []enum.LandingType `json:"landing_type,omitempty"`
	// ExternalAction 转化目标，允许值：AD_CONVERT_TYPE_NOTIFY_DOWNLOAD
	// AD_CONVERT_TYPE_DOWNLOAD_FINISH
	// AD_CONVERT_TYPE_INSTALL_FINISH
	// AD_CONVERT_TYPE_ACTIVE
	// AD_CONVERT_TYPE_ACTIVE_REGISTER
	// AD_CONVERT_TYPE_GAME_ADDICTION
	// AD_CONVERT_TYPE_PAY
	ExternalAction []enum.AdConvertType `json:"external_action,omitempty"`
	// AppCode 首选位置，西瓜视频[1]
	// 抖音火山版:[3]
	// 抖音短视频[4]
	// 今日头条:[8]
	// 番茄小说:[26]
	// 穿山甲:[9]
	// Ohayoo精品游戏:[27]
	AppCode []int `json:"app_code,omitempty"`
	// Platform 平台，允许值：ANDROID 安卓、IOS 苹果、OTHER 其他
	Platform []enum.AudiencePlatform
	// PackageName 应用包名
	PackageName []string `json:"package_name,omitempty"`
	// DeliveryMode 投放模式筛选。允许值: MANUAL 手动、PROCEDURAL 自动
	DeliveryMode []string `json:"delivery_mode,omitempty"`
}

PromotionGetFilter 数据报表过滤条件

type PromotionGetListItem 

type PromotionGetListItem struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// ProjectName 项目名称
	ProjectName string `json:"project_name,omitempty"`
	// PromotionID 广告ID
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// PromotionName 广告名称
	PromotionName string `json:"promotion_name,omitempty"`
	// StatDatetime 数据时间
	StatDatetime string `json:"stat_datetime,omitempty"`
	// Data
	Data []Stat `json:"data,omitempty"`
}

PromotionGetListItem 数据详情

type PromotionGetRequest 

type PromotionGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndDate time.Time `json:"end_date,omitempty"`
	// Fields 指定需要的指标名称
	Fields []string `json:"fields,omitempty"`
	// GroupBy 分组条件默认为 STAT_GROUP_BY_FIELD_STAT_TIME
	GroupBy []enum.StatGroupBy `json:"group_by,omitempty"`
	// TimeGranularity 时间粒度, 默认值: STAT_TIME_GRANULARITY_DAILY
	TimeGranularity enum.StatTimeGranularity `json:"time_granularity,omitempty"`
	// OrderField 排序字段，所有的统计指标均可参与排序
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序方式；默认值: DESC；允许值: ASC, DESC
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Page 页码；默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量；默认值: 20；取值范围: 1-1000
	PageSize int `json:"page_size,omitempty"`
	// Filtering 过滤字段，json格式，支持字段如下
	Filtering *PromotionGetFilter `json:"filtering,omitempty"`
}

PromotionGetRequest 广告数据报表 API Request

func (PromotionGetRequest) Encode 

func (r PromotionGetRequest) Encode() string

Encode implement GetRequest interface

type PromotionGetResponse 

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

PromotionGetResponse 广告数据报表 API Response

type PromotionGetResult 

type PromotionGetResult struct {
	// List 数据列表
	List []PromotionGetListItem `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

PromotionGetResult 返回值

type RangeValue added in v1.9.28 

type RangeValue struct {
	// Label 维度过滤字段名称
	Label string `json:"label,omitempty"`
	// Value 维度过滤字段具体值
	Value string `json:"value,omitempty"`
}

RangeValue 维度指标过滤枚举值列表

type Stat 

type Stat struct {
	Dimensions
	Metrics
}

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.