realtime

Documentation

Overview

Package realtime 实时报表

Index

• type AdvertiserRequest
  • func (r AdvertiserRequest) Encode() []byte
• type AdvertiserResponse
• type BaseCampaignDTO
• type BaseCreativityDTO
• type BaseKeywordDTO
• type BaseUnitDTO
• type CampaignDTO
• type CampaignRequest
  • func (r CampaignRequest) Encode() []byte
• type CampaignResponse
• type CreativityDTO
• type CreativityRequest
  • func (r CreativityRequest) Encode() []byte
• type CreativityResponse
• type KeywordDTO
• type KeywordRequest
  • func (r KeywordRequest) Encode() []byte
• type KeywordResponse
• type UnitDTO
• type UnitRequest
  • func (r UnitRequest) Encode() []byte
• type UnitResponse

Types

type AdvertiserRequest

type AdvertiserRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id"`
	// StartDate 开始时间，格式 yyyy-MM-dd
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 yyyy-MM-dd
	EndDate string `json:"end_date,omitempty"`
}

AdvertiserRequest 账户层级实时数据 API Request

func (AdvertiserRequest) Encode

func (r AdvertiserRequest) Encode() []byte

Encode implement PostRequest interface

type AdvertiserResponse

type AdvertiserResponse struct {
	model.BaseResponse
	Data *report.DataReportDTO `json:"data,omitempty"`
}

AdvertiserResponse 账户层级实时数据 API Response

type BaseCampaignDTO

type BaseCampaignDTO struct {
	// CampaignID 计划id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// CampaignName 计划名称
	CampaignName string `json:"campaign_name,omitempty"`
	// CampaignFilterState 计划状态;
	CampaignFilterState int `json:"campaign_filter_state,omitempty"`
	// CampaignCreateTime 计划创建时间: 格式yyyy-MM-dd HH:mm:ss
	CampaignCreateTime string `json:"campaign_create_time,omitempty"`
	// CampaignEnabled 计划启停状态：0：暂停，1：开启
	CampaignEnabled int `json:"campaign_enabled,omitempty"`
	// MarketingTarget 营销诉求:3：商品销量_日常推广，4：产品种草，8：直播推广_日常推广，9：客资收集，10：抢占赛道，14：直播推广_直播预热，15：商品销量_店铺拉新
	MarketingTarget int `json:"marketing_target,omitempty"`
	// Placement 广告类型:1：信息流，2：搜索，4：全站智投，7：视频内流
	Placement int `json:"placement,omitempty"`
	// OptimizeTarget 推广目标：0：点击量1：互动量3：表单提交量4：商品成单量5：私信咨询量6：直播间观看量11：商品访客量12：落地页访问量13：私信开口量14：有效观看量18：站外转化量20：TI人群规模21：行业商品成单23：直播预热量24：直播间成交25：直播间支付ROI
	OptimizeTarget int `json:"optimize_target,omitempty"`
	// PromotionTarget 投放标的:1：笔记，2：商品，7：外链落地页，9：落地页，18：直播间
	PromotionTarget int `json:"promotion_target,omitempty"`
	// BiddingStrategy 出价方式：2：手动出价3：自动出价
	BiddingStrategy int `json:"bidding_strategy,omitempty"`
	// ConstraitType 成本控制方式: -1: 无，101: 自动控制，0: 点击成本控制，1: 互动成本控制，3: 表单提交成本控制，5: 私信咨询成本控制，11: 访客成本控制，13: 私信开口成本控制，14: 有效观播成本控制，17: ROI控制，23: 预热成本控制，50: 私信留资成本控制
	ConstraitType int `json:"constrait_type,omitempty"`
	// LimitDayBudget 预算类型: 预算类型：0：不限预算，1：指定预算
	LimitDayBudget int `json:"limit_day_budget,omitempty"`
	// OriginCampaignDayBudget 计划日预算
	OriginCampaignDayBudget int `json:"origin_campaign_day_budget,omitempty"`
	// BudgetState 预算状态，0: 计划预算不足，1 计划预算充足
	BudgetState int `json:"budget_state,omitempty"`
	// SmartSwitch 是否节假日预算上调，0: 关闭，1: 开启
	SmartSwitch int `json:"smart_switch,omitempty"`
	// PacingMode 投放速率，1: 匀速投放，2: 加速投放
	PacingMode int `json:"pacing_mode,omitempty"`
	// StartTime 计划开始时间：格式yyyy-MM-dd
	StartTime string `json:"start_time,omitempty"`
	// ExpireTime 计划结束时间：格式yyyy-MM-dd
	ExpireTime string `json:"expire_time,omitempty"`
	// TimePeriod 时段: 默认168个1：表示一周每个小时用0和1表示，0表示不投，1表示投放，示例中表示1点不投，其他时间投
	TimePeriod string `json:"time_period,omitempty"`
	// TimePeroidType 推广时段类型, 0: 全时段，1:自定义时间段
	TimePeroidType int `json:"time_peroid_type,omitempty"`
	// BuildType 搭建方式，0：标准搭建，1：省心智投
	BuildType int `json:"build_type,omitempty"`
	// FeedFlag 是否搜索追投信息流：0: 否，1：是
	FeedFlag int `json:"feed_flag,omitempty"`
	// SearchFlag 是否信息流快投搜索：0: 否，1：是
	SearchFlag int `json:"search_flag,omitempty"`
	// MigrationStatus 专业号平台计划迁移状态: 0：非迁移计划，2：迁移计划
	MigrationStatus int `json:"migration_status,omitempty"`
}

BaseCampaignDTO 计划属性信息

type BaseCreativityDTO

type BaseCreativityDTO struct {
	// CreativityID 创意ID
	CreativityID uint64 `json:"creativity_id,omitempty"`
	// CreativityName 创意名称
	CreativityName string `json:"creativity_name,omitempty"`
	// CreativityFilterState 创意状态8：有效，3：暂停，9: 商品状态异常，4：已被单元暂停，10：单元未开始，11：单元已结束，12：单元处于暂停时段，5：已被计划暂停，13：计划预算不足，16：账户日预算不足，14：现金余额不足，1：已删除
	CreativityFilterState int `json:"creativity_filter_state,omitempty"`
	// CreativityCreateTime 创意创建时间：格式 yyyy-MM-dd HH:mm:ss
	CreativityCreateTime string `json:"creativity_create_time,omitempty"`
	// CreativityEnable 创意启停状态：0：暂停，1：开启
	CreativeEnable int `json:"creative_enable,omitempty"`
	// AuditStatus 审核状态1：审核拒绝，2：审核中，3：审核通过，4：审核通过（私密)
	AuditStatus int `json:"audit_status,omitempty"`
	// UnitID 单元id
	UnitID uint64 `json:"unit_id,omitempty"`
	// Programmatic 创意组合类型：0：自定义创意，1：程序化创意
	Programmatic int `json:"programmatic,omitempty"`
	// NoteID 笔记id
	NoteID string `json:"note_id,omitempty"`
	// CreativityType 创意类型：
	// 0：笔记-无组件
	// 1：笔记-商品组件-购买同款商品
	// 2：笔记-商品组件-进店看看
	// 3：笔记-商品组件-小程序购买同款商品
	// 4：笔记-商品组件-小程序购买同款商品
	// 5：笔记-落地页组件-表单
	// 6：笔记-落地页组件-外跳链接
	// 7：笔记-私信组件
	// 8：笔记-直播间组件
	// 9：笔记-poi门店组件
	// 10：笔记-外链商品
	// 11：直播间
	// 12：搜索组件
	// 13：小程序组件
	// 14：留资组件
	CreativityType int `json:"creativity_type,omitempty"`
}

BaseCreativityDTO 创意属性信息

type BaseKeywordDTO

type BaseKeywordDTO struct {
	// KeywordID 关键词ID
	KeywordID uint64 `json:"keyword_id,omitempty"`
	// Keyword 关键词名称
	Keyword string `json:"keyword,omitempty"`
	// UserBidStrategy 出价策略：0：未使用出价策略1：已使用出价策略
	UserBidStrategy int `json:"user_bid_strategy,omitempty"`
	// KeywordEnable 关键词状态：0：未上线1：已上线
	KeywordEnable int `json:"keyword_enable,omitempty"`
	// KeywordFilterState 关键词状态过滤2：删除3：暂停4：已被单元暂停5：已被计划暂停6：现金余额不足7：计划预算不足8：有效9：计划未开始10：计划已结束11：计划处于暂停阶段12：账户日预算不足
	KeywordFilterState int `json:"keyword_filter_state,omitempty"`
	// UnitID 单元id
	UnitID uint64 `json:"unit_id,omitempty"`
	// CampaignID 计划id
	CampaignID uint64 `json:"campaign_id,omitempty"`
}

BaseKeywordDTO 创意属性信息

type BaseUnitDTO

type BaseUnitDTO struct {
	// UnitID 单元id
	UnitID uint64 `json:"unit_id,omitempty"`
	// UnitName 单元名称
	UnitName string `json:"unit_name,omitempty"`
	// UnitCreateTime 单元创建时间：格式 yyyy-MM-dd HH:mm:ss
	UnitCreateTime string `json:"unit_create_time,omitempty"`
	// UnitEnable 单元启停状态：0：暂停，1：开启
	UnitEnable int `json:"unit_enable,omitempty"`
	// CampaignID 计划id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// EventBid 出价
	EventBid int64 `json:"event_bid,omitempty"`
}

BaseUnitDTO 单元属性信息

type CampaignDTO

type CampaignDTO struct {
	// Data 数据指标
	Data *report.DataReportDTO `json:"data,omitempty"`
	// BaseCampaignDTO 计划属性信息
	BaseCampaignDTO *BaseCampaignDTO `json:"base_campaign_dto,omitempty"`
}

CampaignDTO 计划数据

type CampaignRequest

type CampaignRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id"`
	// StartDate 开始时间，格式 yyyy-MM-dd
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 yyyy-MM-dd
	EndDate string `json:"end_date,omitempty"`
	// SortColumn 排序字段见附录column字段
	SortColumn string `json:"sort_column,omitempty"`
	// Sort 升降序asc：升序desc：降序
	Sort enum.SortType `json:"sort,omitempty"`
	// PageNum 页数，默认1
	PageNum int64 `json:"page_num,omitempty"`
	// PageSize 页大小，默认20,最大1000
	PageSize int64 `json:"page_size,omitempty"`
	// MarketTargetingList 营销诉求筛选，3：商品销量_日常推广告，4：产品种草，8：直播推广_日常推广，9：客资收集，10：抢占赛道，14：直播推广_直播预热，15：商品销量_店铺拉新
	MarketTargetingList []int `json:"market_targeting_list,omitempty"`
	// CampaignFilterState 计划状态过滤，1：有效，2：暂停，4：计划预算不足，7：账户日预算不足，5：现金余额不足，8：处于暂停时段，3：已删除，6：所有未删除状态
	CampaignFilterState int `json:"campaign_filter_state,omitempty"`
	// CampaignCreateBeginTime 计划创建时间范围的开始
	CampaignCreateBeginTime string `json:"campaign_create_begin_time,omitempty"`
	// CampaignCreateEndTime 计划创建时间范围的结束
	CampaignCreateEndTime string `json:"campaign_create_end_time,omitempty"`
	// PlacementLit 广告类型：1：信息流广告，2：搜索广告，4：全站智投，7：视频流广告
	PlacementList []int `json:"placement_list,omitempty"`
	// LimitDayBudgetList 预算类型：0：不限预算，1：指定预算
	LimitDayBudgetList []int `json:"limit_day_budget_list,omitempty"`
	// OptimizeTargetList 推广目标：0：点击量，1：互动量，16：种草值，11：商品访客量，12：落地页访问量，3：表单提交量，4：商品成单量，5：私信咨询量，6：观看量，13：私信开口量，14：有效观看量，17：ROI，站外转化量，20：TI人群规模
	OptimizeTargetList []int `json:"optimize_target_list,omitempty"`
	// BuildTypeList 搭建方式：0：标准投放，1：省心智投
	BuildTypeList []int `json:"build_type_list,omitempty"`
	// BiddingStrategyList 出价方式：2：手动出价，101: 自动出价
	BiddingStrategyList []int `json:"bidding_strategy_list,omitempty"`
	// ConstraintTypeList 成本控制方式：-1: 无，101: 自动控制，0: 点击成本控制，1: 互动成本控制，3: 表单提交成本控制，5: 私信咨询成本控制，11: 访客成本控制，13: 私信开口成本控制，14: 有效观播成本控制，17: ROI控制，23: 预热成本控制，50: 私信留资成本控制
	ConstraintTypeList []int `json:"constraint_type_list,omitempty"`
	// PromotionTargetList 投放标的类型：1: 笔记，2: 商品，7: 外链落地页，9: 落地页，18: 直播间
	PromotionTargetList []int `json:"promotion_target_list,omitempty"`
	// CombineAuditStatus 创意审核状态，1：审核拒绝，2：审核中，3：审核通过，4：审核通过（私密）
	CombineAuditStatus int `json:"combine_audit_status,omitempty"`
	// MigrateStatusList 计划迁移状态，0：非迁移计划，2：迁移计划
	MigrateStatusList []int `json:"migrate_status_list,omitempty"`
	// Name 搜索计划名称
	Name string `json:"name,omitempty"`
	// ID 搜索计划id
	ID uint64 `json:"id,omitempty"`
}

CampaignRequest 计划层级实时数据 API Request

func (CampaignRequest) Encode

func (r CampaignRequest) Encode() []byte

Encode implement PostRequest interface

type CampaignResponse

type CampaignResponse struct {
	model.BaseResponse
	// Page 分页信息
	Page *model.PageRespDTO `json:"page,omitempty"`
	// CampaignDTOs 计划数据list
	CampaignDTOs []CampaignDTO `json:"campaign_dtos,omitempty"`
	// TotalData 汇总数据
	TotalData *report.DataReportDTO `json:"total_data,omitempty"`
}

CampaignResponse 计划层级实时数据 API Response

type CreativityDTO

type CreativityDTO struct {
	// BaseCreativtyDTO 创意属性信息
	BaseCreativtyDTO *BaseCreativityDTO `json:"base_creativty_dto,omitempty"`
	// BaseUnitDTO 单元属性信息
	BaseUnitDTO *BaseUnitDTO `json:"base_unit_dto,omitempty"`
	// BaseCampaignDTO 计划属性信息
	BaseCampaignDTO *BaseCampaignDTO `json:"base_campaign_dto,omitempty"`
	// Data 数据指标
	Data *report.DataReportDTO `json:"data,omitempty"`
}

CreativityDTO 创意数据

type CreativityRequest

type CreativityRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id"`
	// StartDate 开始时间，格式 yyyy-MM-dd
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 yyyy-MM-dd
	EndDate string `json:"end_date,omitempty"`
	// SortColumn 排序字段见附录column字段
	SortColumn string `json:"sort_column,omitempty"`
	// Sort 升降序asc：升序desc：降序
	Sort enum.SortType `json:"sort,omitempty"`
	// PageNum 页数，默认1
	PageNum int64 `json:"page_num,omitempty"`
	// PageSize 页大小，默认20,最大1000
	PageSize int64 `json:"page_size,omitempty"`
	// PlacementLit 广告类型：1：信息流广告，2：搜索广告，4：全站智投，7：视频流广告
	PlacementList []int `json:"placement_list,omitempty"`
	// CreativeityFilterState 创意状态过滤，8：有效，3：暂停，9：商品状态异常，4：已被单元暂停，10：单元未开始，11：单元已结束，12：单元处于暂停时段，5：已被计划暂停，13：计划预算不足，16：账户日预算不足，14：现金余额不足，1：已删除，2：所有未删除状态，
	CreativityFilterState int `json:"creativity_filter_state,omitempty"`
	// CreativityCreateBeginTime 创意创建开始时间
	CreativityCreateBeginTime string `json:"creativity_create_begin_time,omitempty"`
	// CreativityCreateEndTime 创意创建结束时间
	CreativityCreateEndTime string `json:"creativity_create_end_time,omitempty"`
	// ConversionType 创意类型：30：商品，20：落地页，4：直播间笔记，7：直播间，0：笔记（无组件），1：笔记（商品组件），2：笔记（落地页组件）
	ConversionType int `json:"conversion_type,omitempty"`
	// ProgrammmaticList 创意组合方式，0：自定义创意，1：程序化创意
	ProgrammaticList []int `json:"programmatic_list,omitempty"`
	// CreativityAuditStatus 创意审核状态，1：审核拒绝，2：审核中，3：审核通过，4：审核通过（私密）
	CreativityAuditStatus []int `json:"creativity_audit_status,omitempty"`
	// Name 搜索创意名称
	Name string `json:"name,omitempty"`
	// ID 创意ID
	ID uint64 `json:"id,omitempty"`
}

CreativityRequest 创意层级实时数据 API Request

func (CreativityRequest) Encode

func (r CreativityRequest) Encode() []byte

Encode implement PostRequest interface

type CreativityResponse

type CreativityResponse struct {
	model.BaseResponse
	// Page 分页信息
	Page *model.PageRespDTO `json:"page,omitempty"`
	// CreativityDTOs 创意数据list
	CreativityDTOs []CreativityDTO `json:"creativity_dtos,omitempty"`
	// TotalData 汇总数据
	TotalData *report.DataReportDTO `json:"total_data,omitempty"`
}

CreativityResponse 创意层级实时数据 API Response

type KeywordDTO

type KeywordDTO struct {
	// BaseKeywordDTO 创意属性信息
	BaseKeywordDTO *BaseKeywordDTO `json:"base_keyword_dto,omitempty"`
	// SubKeywordDTOs  子关键词信息
	SubKeywordDTOs []KeywordDTO `json:"sub_keyword_dtos,omitempty"`
	// BaseUnitDTO 单元属性信息
	BaseUnitDTO *BaseUnitDTO `json:"base_unit_dto,omitempty"`
	// BaseCampaignDTO 计划属性信息
	BaseCampaignDTO *BaseCampaignDTO `json:"base_campaign_dto,omitempty"`
	// Data 数据指标
	Data *report.DataReportDTO `json:"data,omitempty"`
}

KeywordDTO 关键词数据

type KeywordRequest

type KeywordRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id"`
	// StartDate 开始时间，格式 yyyy-MM-dd
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 yyyy-MM-dd
	EndDate string `json:"end_date,omitempty"`
	// SortColumn 排序字段见附录column字段
	SortColumn string `json:"sort_column,omitempty"`
	// Sort 升降序asc：升序desc：降序
	Sort enum.SortType `json:"sort,omitempty"`
	// PageNum 页数，默认1
	PageNum int64 `json:"page_num,omitempty"`
	// PageSize 页大小，默认20,最大1000
	PageSize int64 `json:"page_size,omitempty"`
	// KeywordFilterState 关键词状态过滤2：删除3：暂停4：已被单元暂停5：已被计划暂停6：现金余额不足7：计划预算不足8：有效9：计划未开始10：计划已结束11：计划处于暂停阶段12：账户日预算不足
	KeywordFilterState int `json:"keyword_filter_state,omitempty"`
	// UserBidStrategy 出价策略：0：未使用出价策略1：已使用出价策略
	UserBidStrategy int `json:"user_bid_strategy,omitempty"`
	// KeywordName 搜索关键词名词
	KeywordName string `json:"keyword_name,omitempty"`
	// CampaignName 搜索计划名称
	CampaignName string `json:"campaign_name,omitempty"`
	// UnitName 搜索单元名称
	UnitName string `json:"unit_name,omitempty"`
}

KeywordRequest 关键词层级实时数据 API Request

func (KeywordRequest) Encode

func (r KeywordRequest) Encode() []byte

Encode implement PostRequest interface

type KeywordResponse

type KeywordResponse struct {
	model.BaseResponse
	// Page 分页信息
	Page *model.PageRespDTO `json:"page,omitempty"`
	// KeywordDTOs 关键词数据list
	KeywordDTOs []KeywordDTO `json:"keyword_dtos,omitempty"`
	// TotalData 汇总数据
	TotalData *report.DataReportDTO `json:"total_data,omitempty"`
}

KeywordRequest 关键词层级实时数据 API Response

type UnitDTO

type UnitDTO struct {
	// BaseUnitDTO 单元属性信息
	BaseUnitDTO *BaseUnitDTO `json:"base_unit_dto,omitempty"`
	// BaseCampaignDTO 计划属性信息
	BaseCampaignDTO *BaseCampaignDTO `json:"base_campaign_dto,omitempty"`
	// Data 数据指标
	Data *report.DataReportDTO `json:"data,omitempty"`
}

UnitDTO 单元数据

type UnitRequest

type UnitRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id"`
	// StartDate 开始时间，格式 yyyy-MM-dd
	StartDate string `json:"start_date,omitempty"`
	// EndDate 结束时间，格式 yyyy-MM-dd
	EndDate string `json:"end_date,omitempty"`
	// SortColumn 排序字段见附录column字段
	SortColumn string `json:"sort_column,omitempty"`
	// Sort 升降序asc：升序desc：降序
	Sort enum.SortType `json:"sort,omitempty"`
	// PageNum 页数，默认1
	PageNum int64 `json:"page_num,omitempty"`
	// PageSize 页大小，默认20,最大1000
	PageSize int64 `json:"page_size,omitempty"`
	// MarketTargetingList 营销诉求筛选，3：商品销量_日常推广告，4：产品种草，8：直播推广_日常推广，9：客资收集，10：抢占赛道，14：直播推广_直播预热，15：商品销量_店铺拉新
	MarketTargetingList []int `json:"market_targeting_list,omitempty"`
	// UnitFilterState 单元状态过滤，10：有效，4：暂停，2：未开始，3： 已结束，5：处于暂停时段，6：已被计划暂停，8：计划预算不足，11：账户日预算不足，7：现金余额不足，1：已删除，9：所有未删除状态
	UnitFilterState int `json:"unit_filter_state,omitempty"`
	// UnitCreateBeginTime 单元创建时间范围的开始
	UnitCreateBeginTime string `json:"unit_create_begin_time,omitempty"`
	// UnitCreateEndTime 单元创建时间范围的结束
	UnitCreateEndTime string `json:"unit_create_end_time,omitempty"`
	// PlacementLit 广告类型：1：信息流广告，2：搜索广告，4：全站智投，7：视频流广告
	PlacementList []int `json:"placement_list,omitempty"`
	// BiddingStrategyList 出价方式：2：手动出价，101: 自动出价
	BiddingStrategyList []int `json:"bidding_strategy_list,omitempty"`
	// PromotionTargetList 投放标的类型：1: 笔记，2: 商品，7: 外链落地页，9: 落地页，18: 直播间
	PromotionTargetList []int `json:"promotion_target_list,omitempty"`
	// CombineAuditStatus 创意审核状态，1：审核拒绝，2：审核中，3：审核通过，4：审核通过（私密）
	CombineAuditStatus int `json:"combine_audit_status,omitempty"`
	// Name 搜索单元名称
	Name string `json:"name,omitempty"`
	// ID 单元ID
	ID uint64 `json:"id,omitempty"`
}

UnitRequest 单元层级实时数据 API Request

func (UnitRequest) Encode

func (r UnitRequest) Encode() []byte

Encode implement PostRequest interface

type UnitResponse

type UnitResponse struct {
	model.BaseResponse
	// Page 分页信息
	Page *model.PageRespDTO `json:"page,omitempty"`
	// UnitDTOs 单元数据list
	UnitDTOs []UnitDTO `json:"unit_dtos,omitempty"`
	// TotalData 汇总数据
	TotalData *report.DataReportDTO `json:"total_data,omitempty"`
}

UnitRequest 单元层级实时数据 API Response