report

Documentation

Index

• type AdStats
• type AdgroupReport
• type Filter
• type GetAdgroupReportData
• type GetAdgroupReportDataResponse
• type GetReportDataRequest
  • func (r GetReportDataRequest) Url() string
• type Sort
• type Summary

Types

type AdStats

type AdStats struct {
	Impression        int64   `json:"impression,omitempty"`        // Impression 表示展现次数。
	Click             int64   `json:"click,omitempty"`             // Click 表示点击次数。
	Cost              float64 `json:"cost,omitempty"`              // Cost 表示消费金额。
	CTR               float64 `json:"ctr,omitempty"`               // CTR 表示点击率。 计算公式：Click/Impression。
	CPC               float64 `json:"cpc,omitempty"`               // CPC 表示平均点击价格。 计算公式：Cost/Click。
	CPM               float64 `json:"cpm,omitempty"`               // CPM 表示千次展现消费金额。 计算公式：Cost/(Impression/1000)。
	PhoneButtonClicks int64   `json:"phoneButtonClicks,omitempty"` // PhoneButtonClicks 表示组件点击次数。 用于点击创意组件 button 次数。
	Interaction       int64   `json:"interaction,omitempty"`       // Interaction 表示广告的互动次数。 对于视频广告，互动行为包含点击互动和有效播放互动，对其他格式的广告，互动依然仅包含点击。
}

type AdgroupReport

type AdgroupReport struct {
	*AdStats
	Date               string `json:"date"`                         // 日期
	UserName           string `json:"userName,omitempty"`           // 账户
	CampaignNameStatus string `json:"campaignNameStatus,omitempty"` // 推广计划
	AdGroupNameStatus  string `json:"adGroupNameStatus,omitempty"`  // 推广单元
	FeedFlowTypeEnum   int    `json:"feedFlowTypeEnum,omitempty"`   // 流量类型
	AdGroupStatus      string `json:"adGroupStatus,omitempty"`      // 推广单元状态
	AdGroupName        string `json:"adGroupName,omitempty"`        // 推广单元
	CampaignID         int64  `json:"campaignId,omitempty"`         // 推广计划ID
	AdGroupID          int64  `json:"adGroupId,omitempty"`          // 推广单元ID
	CampaignStatus     string `json:"campaignStatus,omitempty"`     // 推广计划状态
	CampaignName       string `json:"campaignName,omitempty"`       // 推广计划
	Device             int    `json:"device,omitempty"`             // 推广设备
	FeedSubjectEnum    int    `json:"feedSubjectEnum,omitempty"`    // FeedSubject
	BsType             int    `json:"bsType,omitempty"`             // 报告类型

	OCPCTransType                  string  `json:"ocpcTransType,omitempty"`                  // OCPCTransType 表示 OCPC 广告的目标转化类型。 枚举值参考接口文档说明。
	OCPCTargetTrans                int64   `json:"ocpcTargetTrans,omitempty"`                // OCPCTargetTrans 表示目标转化量。
	OCPCTargetTransCPC             float64 `json:"ocpcTargetTransCPC,omitempty"`             // OCPCTargetTransCPC 表示目标转化成本。
	OCPCTargetTransRatio           float64 `json:"ocpcTargetTransRatio,omitempty"`           // OCPCTargetTransRatio 表示转化率。
	OCPCDeepTargetTrans            int64   `json:"ocpcDeepTargetTrans,omitempty"`            // OCPCDeepTargetTrans 表示深度转化量。
	OCPCDeepTargetTransCPC         float64 `json:"ocpcDeepTargetTransCPC,omitempty"`         // OCPCDeepTargetTransCPC 表示深度转化成本。
	OCPCDeepTargetTransRatio       float64 `json:"ocpcDeepTargetTransRatio,omitempty"`       // OCPCDeepTargetTransRatio 表示深度转化率。
	ConvertTimeOCPCTargetTrans     int64   `json:"convertTimeOCPCTargetTrans,omitempty"`     // ConvertTimeOCPCTargetTrans 表示目标转化量的转化时间。
	ConvertTimeOCPCDeepTargetTrans int64   `json:"convertTimeOCPCDeepTargetTrans,omitempty"` // ConvertTimeOCPCDeepTargetTrans 表示深度转化量的转化时间。
	DeepConvertType                string  `json:"deepConvertType,omitempty"`                // DeepConvertType 表示 OCPC 广告的深度转化类型。 枚举值参考接口文档说明。
}

type Filter

type Filter struct {
	// Column 过滤的列名。
	Column string `json:"column,omitempty"`
	// Operator 过滤的操作符。
	Operator enum.Operator `json:"operator,omitempty"`
	// Values 过滤值。 对于Enum类型的列，使用key作为value过滤。
	Values []string `json:"values,omitempty"`
}

type GetAdgroupReportData

type GetAdgroupReportData struct {
	// Rows 数据行
	Rows []AdgroupReport `json:"rows,omitempty"`
	// Summary 汇总行
	Summary Summary `json:"summary,omitempty"`
	// RowCount 当前返回的数据行数。
	RowCount int64 `json:"rowCount,omitempty"`
	// TotalRowCount 	所有符合条件的数据总行数。
	TotalRowCount int64 `json:"totalRowCount,omitempty"`
}

type GetAdgroupReportDataResponse

type GetAdgroupReportDataResponse struct {
	Data []GetAdgroupReportData `json:"data,omitempty"`
}

type GetReportDataRequest

type GetReportDataRequest struct {
	// ReportType 报告类型，唯一标识一个报告
	ReportType enum.ReportType `json:"reportType"`
	// UserIds 查询的用户ID，用于查询超管账户所管辖的多个账户数据。可为空，默认只查询当前账户数据。
	UserIds []int64 `json:"userIds,omitempty"`
	// TimeUnit 支持的时间单位： HOUR：小时 DAY：天 WEEK：周 MONTH：月 SUMMARY：时间段汇总
	TimeUnit enum.TimeUnit `json:"timeUnit"`
	// StartDate 数据的起始日期，格式 2020-05-28
	StartDate string `json:"startDate"`
	// EndDate 数据的结束日期，格式 2020-05-29
	EndDate string `json:"endDate"`
	// Columns 查询的列，包含属性和转化指标，必填项，至少要带一个转化指标。 每个报告的说明文档里都有支持的columns列表及说明。
	Columns []string `json:"columns"`
	// Sorts 排序信息，详见下方排序说明
	Sorts []Sort `json:"sorts,omitempty"`
	// Filters 筛选条件集合，非必填，详见下方过滤条件说明。
	Filters []Filter `json:"filters,omitempty"`
	// StartRow 从第几行开始获取结果
	StartRow int64 `json:"startRow,omitempty"`
	// RowCount 要获取多少行，和startRow配合使用，用于分页获取数据。
	RowCount int64 `json:"rowCount,omitempty"`
	// NeedSum 	是否需总计，非必填，默认不需要总计。
	NeedSum bool `json:"needSum,omitempty"`
}

func (GetReportDataRequest) Url

func (r GetReportDataRequest) Url() string

type Sort

type Sort struct {
	// Column 排序的列名。最多支持添加2个排序规则；排序的列必须在请求的列里
	Column string `json:"column,omitempty"`
	// SortRule 排序规则。ASC:正序，DESC：倒序
	SortRule enum.SortRule `json:"sortRule,omitempty"`
}

type Summary

type Summary struct {
	Date       string  `json:"date"`
	Click      int     `json:"click"`
	Cost       float64 `json:"cost"`
	CPC        float64 `json:"cpc"`
	Impression int     `json:"impression"`
	Conversion int     `json:"conversion"`
}

Summary 汇总行