audience

Documentation

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
• type ResponseList

Types

type Filtering

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

type ListRequest

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

func (ListRequest) Encode

func (r ListRequest) Encode() string

type ListResponse

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

type ListResponseData

type ListResponseData struct {
	List     []ListResponseList `json:"list,omitempty"`
	PageInfo *model.PageInfo    `json:"page_info,omitempty"`
}

type ListResponseList

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

type Metrics

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

type MetricsDict

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

type Request

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

func (Request) Encode

func (r Request) Encode() string

type Response

type Response struct {
	model.BaseResponse
	Data *ResponseData `json:"data,omitempty"`
}

type ResponseData

type ResponseData struct {
	List     []ResponseList  `json:"list,omitempty"`
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type ResponseList

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