audience

Documentation

Overview

Package audience 受众分析数据报表 API models

Index

• type Filtering
• type ListRequest
  • func (r ListRequest) Encode() string
• type ListResponse
• type ListResponseData
• type ListResponseList
• type Metrics
• type MetricsDict
• type Request
  • func (r Request) Encode() string
• type Response
• type ResponseData

Types

type Filtering

type Filtering struct {
	// InterestActionType 行为兴趣类型; 默认值: INTEREST
	InterestActionType enum.InterestActionType `json:"interest_action_type,omitempty"`
	// AudienceLevel 类目词级别; 默认值: FIRST_LEVEL
	AudienceLevel enum.AudienceLevel `json:"audience_level,omitempty"`
	// CampaignIDs 广告组查询列表，长度1-100
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
	// AdIDs 广告计划查询列表，长度1-100
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// ActionScene 行为场景，仅在行为兴趣类型为ACTION时传入; 默认值: ["E-COMMERCE", "NEWS", "APP"]
	ActionScene []enum.ActionScene `json:"action_scene,omitempty"`
	// ActionDays 行为天数，仅在行为兴趣类型为ACTION时传入; 默认值: 30
	ActionDays int `json:"action_days,omitempty"`
	// Behaviors 互动类型; 默认值: ["FOLLOWED_USER", "COMMENTED_USER", "LIKED_USER", "SHARED_USER"]
	Behaviors []enum.Behavior `json:"behaviors,omitempty"`
}

Filtering 过滤条件

type ListRequest

type ListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期，从0时起，格式2020-08-15; 默认15天前，即不指定起止时间获取最近15天数据
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束日期，至24时止，格式2020-08-29; 默认昨天，即不指定起止时间获取最近15天数据; 起始时间与结束时间之差小于15天，否则报错并提示"max time span is 15 days"
	EndDate time.Time `json:"end_date,omitempty"`
	// Filtering 过滤条件
	Filtering *Filtering `json:"filtering,omitempty"`
	// Metrics 查询指标列表
	Metrics []string `json:"metrics,omitempty"`
	// Page 页码;默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量，限制为1-100; 默认值: 20
	PageSize int `json:"page_size,omitempty"`
}

ListRequest 抖音达人数据/行为兴趣数据 API Request

func (ListRequest) Encode

func (r ListRequest) Encode() string

Encode implement GetRequest interface

type ListResponse

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

ListResponse 行为兴趣数据/抖音达人数据 API Response

type ListResponseData

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

ListResponseData json返回值

type ListResponseList

type ListResponseList struct {
	// LabelName 标签名称
	LabelName string `json:"label_name,omitempty"`
	// SuperiorLabelName 上级标签名称，一级类目与关键词时返回null
	SuperiorLabelName string `json:"superior_label_name,omitempty"`
	// AudienceLevel 类目词级别
	AudienceLevel enum.AudienceLevel `json:"audience_level,omitempty"`
	// Metrics 查询指标列表
	Metrics *Metrics `json:"metrics,omitempty"`
}

ListResponseList 数据

type Metrics

type Metrics struct {
	// StatCost 消耗
	StatCost float64 `json:"stat_cost,omitempty"`
	// ShowCnt 展示数
	ShowCnt int64 `json:"show_cnt,omitempty"`
	// CpmPlatform 平均千次展示成本
	CpmPlatform float64 `json:"cpm_platform,omitempty"`
	// ClickCnt 点击数
	ClickCnt int64 `json:"click_cnt,omitempty"`
	// Ctr 点击率
	Ctr float64 `json:"ctr,omitempty"`
	// CpcPlatform 平均点击单价
	CpcPlatform float64 `json:"cpc_platform,omitempty"`
	// ConvertCnt 转化数
	ConvertCnt int64 `json:"convert_cnt,omitempty"`
	// ConversionCost 转化成本
	ConversionCost float64 `json:"conversion_cost,omitempty"`
	// ConversionRate 转化率
	ConversionRate float64 `json:"conversion_rate,omitempty"`
	// DeepConvertCnt 深度转化数
	DeepConvertCnt int64 `json:"deep_convert_cnt,omitempty"`
	// DeepConvertCost 深度转化成本
	DeepConvertCost float64 `json:"deep_convert_cost,omitempty"`
	// DeepConvertRate 深度转化率
	DeepConvertRate float64 `json:"deep_convert_rate,omitempty"`
	// TotalPlay 播放数
	TotalPlay int64 `json:"total_play,omitempty"`
	// ValidPlay 有效播放数
	ValidPlay int64 `json:"valid_play,omitempty"`
	// ValidPlayRate 有效播放率
	ValidPlayRate float64 `json:"valid_play_rate,omitempty"`
	// ValidPlayCost 有效播放成本
	ValidPlayCost float64 `json:"valid_play_cost,omitempty"`
	// DyFollow 新增关注数
	DyFollow int64 `json:"dy_follow,omitempty"`
	// DyLike 点赞数
	DyLike int64 `json:"dy_like,omitempty"`
	// DyComment 评论提交数
	DyComment int64 `json:"dy_comment,omitempty"`
	// DyShare 分享数
	DyShare int64 `json:"dy_share,omitempty"`
}

Metrics 指标

type MetricsDict

type MetricsDict struct {
	// Cost 总消耗(单位元,精确到分)
	Cost float64 `json:"cost,omitempty"`
	// Show 展示数
	Show int64 `json:"show,omitempty"`
	// Click 点击数
	Click int64 `json:"click,omitempty"`
	// DownloadFinish 下载完成数
	DownloadFinish int64 `json:"download_finish,omitempty"`
	// Convert 转化数
	Convert int64 `json:"convert,omitempty"`
}

MetricsDict 查询指标详细数据

type Request

type Request struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartDate 起始日期，从0时起，格式2020-08-15; 默认15天前，即不指定起止时间获取最近15天数据
	StartDate time.Time `json:"start_date,omitempty"`
	// EndDate 结束日期，至24时止，格式2020-08-29; 默认昨天，即不指定起止时间获取最近15天数据; 起始时间与结束时间之差小于15天，否则报错并提示"max time span is 15 days"
	EndDate time.Time `json:"end_date,omitempty"`
	// Page 页码;默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，即每页展示的数据量，限制为1-100; 默认值: 20
	PageSize int `json:"page_size,omitempty"`
	// IDType 查询ID类型
	IDType enum.AudienceStatIDType `json:"id_type,omitempty"`
	// IDs 查询ID列表，长度1-100; id_type为AUDIENCE_STAT_ID_TYPE_ADVERTISER时，选填；其他类型，必填
	IDs     []uint64 `json:"ids,omitempty"`
	Metrics []string `json:"metrics,omitempty"` // Metrics 查询指标列表
}

Request 受众分析数据报表 API Request

func (Request) Encode

func (r Request) Encode() string

Encode implement GetRequest interface

type Response

type Response struct {
	model.BaseResponse
	// Data json返回值
	Data []ResponseData `json:"data,omitempty"`
}

Response 受众分析数据报表 API Response

type ResponseData

type ResponseData struct {
	// MetricsDict 查询指标列表
	MetricsDict *MetricsDict `json:"metrics_dict,omitempty"`
	// ProvinceName 省份
	ProvinceName string `json:"province_name,omitempty"`
	// CityName 城市
	CityName string `json:"city_name,omitempty"`
	// GenderName 性别，允许值：男，女，其他
	GenderName string `json:"gender_name,omitempty"`
	// AdTagName 兴趣标签
	AdTagName string `json:"ad_tag_name,omitempty"`
	// AgeName 年龄段
	AgeName string `json:"age_name,omitempty"`
}

ResponseData 指标数据