report

Documentation

Index

• type AccountLiveData
• type Attribute
• type GetAccountLiveDataRequest
  • func (r GetAccountLiveDataRequest) Url() string
• type GetAccountLiveDataResponse
• type GetKeywordLiveDataRequest
  • func (r GetKeywordLiveDataRequest) Url() string
• type GetKeywordLiveDataResponse
• type GetProfessionalReportIdRequest
  • func (r GetProfessionalReportIdRequest) Url() string
• type GetProfessionalReportIdResponse
• type GetRealTimeDataRequest
  • func (r GetRealTimeDataRequest) Url() string
• type GetRealTimeDataResponse
• type GetReportFileUrlRequest
  • func (r GetReportFileUrlRequest) Url() string
• type GetReportFileUrlResponse
• type GetReportStateRequest
  • func (r GetReportStateRequest) Url() string
• type GetReportStateResponse
• type KeywordLiveData
• type RealTimePairRequest
• type RealTimePairResult
• type RealTimeQueryRequest
• type RealTimeQueryResult
• type RealTimeRequest
• type RealTimeResult
• type ReportRequest

Types

type AccountLiveData

type AccountLiveData struct {
	// UpdateTime 数据更新时间; 默认返回： 日期类型，格式示例 "2017-08-23 15:00:00"
	UpdateTime string `json:"updateTime,omitempty"`
	// UserId 用户ID
	UserId int64 `json:"userId,omitempty"`
	// CampaignId 计划ID
	CampaignId int64 `json:"campaignId,omitempty"`
	// TodayTotalClick 今日累计点击;根据请求数据类型不同，分别返回账户累计点击或计划累计点击
	TodayTotalClick int64 `json:"todayTotalClick,omitempty"`
	// TodayTotalCost 今日累计消费;根据请求数据类型不同，分别返回账户累计消费或计划累计消费
	TodayTotalCost float64 `json:"todayTotalCost,omitempty"`
	// TodayTotalCpc 今日累计平均点击价格;根据请求数据类型不同，分别返回账户累计消费或计划累计平均点击价格
	TodayTotalCpc float64 `json:"todayTotalCpc,omitempty"`
}

AccountLiveData 账户实时数据

type Attribute

type Attribute struct {
	// Key 针对特定的报告类型设置特定的统计范围; 目前仅对地域报告和搜索词报告使用，合法值：provid
	Key string `json:"key,omitempty"`
	// Value 针对特定的报告类型设置特定的统计范围; 目前仅对地域报告和搜索词报告使用，key取provid时，value值为地域代码数组，为空则表示全部地域
	Value []int `json:"value,omitempty"`
}

type GetAccountLiveDataRequest

type GetAccountLiveDataRequest struct {
	// DataType 账户/计划实时数据查询;选填，默认值：1;1：账户数据;2：计划数据
	DataType int `json:"dataType,omitempty"`
	// Device 投放设备; 选填，默认值：0 ; 0：全部设备; 1：仅计算机; 2：仅移动; 说明：仅在dataType = 2时有效
	Device int `json:"device,omitempty"`
}

GetAccountLiveDataRequest 账户实时数据 API Request

func (GetAccountLiveDataRequest) Url

func (r GetAccountLiveDataRequest) Url() string

type GetAccountLiveDataResponse

type GetAccountLiveDataResponse struct {
	Data []AccountLiveData `json:"data,omitempty"`
}

GetAccountLiveDataResponse 账户实时数据 API Response

type GetKeywordLiveDataRequest

type GetKeywordLiveDataRequest struct {
	// DateType 账户/计划实时数据查询
	DataType int `json:"dataType,omitempty"`
	// KeywordIds 关键词id，该集合为请求关键词实时数据的集合; 数组内关键词个数上限为200
	KeywordIds []int64 `json:"keywordIds,omitempty"`
	// Device 投放设备
	Device int `json:"device,omitempty"`
	// StartTime 起始时间; 选填， 默认值：当前请求时间之前30分钟时间点; 说明1：请求时间即为当前起始时间; 说明2：起始时间仅支持当前时间之前的30分钟内数据; 说明3：时间格式：2021-04-22 14:30:00; 举例：当前时间为2020-08-01 14:00:00，则startTime不能早于2020-08-01 13:31:00， 不能晚于2020-08-01 14:00:00；默认值为当前时间30分钟之前的时间
	StartTime string `json:"startTime,omitempty"`
	// EndTime 结束时间; 同起始时间，且不能早于startTime
	EndTime string `json:"endTime,omitempty"`
	// RegionTarget 地域; 选填，默认全部区域，取值范围参考地域代码，地域代码个数上限为10
	RegionTarget []int `json:"regionTarget,omitempty"`
}

GetKeywordLiveDataRequest 关键词实时数据 API Request

func (GetKeywordLiveDataRequest) Url

func (r GetKeywordLiveDataRequest) Url() string

type GetKeywordLiveDataResponse

type GetKeywordLiveDataResponse struct {
	Data []KeywordLiveData `json:"data,omitempty"`
}

GetKeywordLiveDataResponse 关键词实时数据 API Response

type GetProfessionalReportIdRequest

type GetProfessionalReportIdRequest struct {
	ReportRequestType *ReportRequest `json:"reportRequestType,omitempty"`
}

GetProfessionalReportIdRequest 创建异步报告（获取异步报告id） API Request

func (GetProfessionalReportIdRequest) Url

func (r GetProfessionalReportIdRequest) Url() string

type GetProfessionalReportIdResponse

type GetProfessionalReportIdResponse struct {
	Data struct {
		ReportId string `json:"reportId,omitempty"`
	} `json:"data,omitempty"`
}

GetProfessionalReportIdResponse 创建异步报告（获取异步报告id） API Response

type GetRealTimeDataRequest

type GetRealTimeDataRequest struct {
	RealTimeRequestType *RealTimeRequest `json:"realTimeRequestType"`
}

GetRealTimeDataRequest 推广报告 API Request

func (GetRealTimeDataRequest) Url

func (r GetRealTimeDataRequest) Url() string

type GetRealTimeDataResponse

type GetRealTimeDataResponse struct {
	Data []RealTimeResult `json:"data,omitempty"`
}

GetRealTimeDataResponse 推广报告 API Response

type GetReportFileUrlRequest

type GetReportFileUrlRequest struct {
	ReportId string `json:"reportId,omitempty"`
}

GetReportFileUrlRequest 获取异步报告文件URL API Request

func (GetReportFileUrlRequest) Url

func (r GetReportFileUrlRequest) Url() string

type GetReportFileUrlResponse

type GetReportFileUrlResponse struct {
	Data []struct {
		ReportFilePath string `json:"reportFilePath,omitempty"` // 报告问价下载地址，生成的url有效期为1小时，如果超时则需重新获取新的url。
	} `json:"data,omitempty"`
}

GetReportFileUrlResponse 获取异步报告文件URL API Response

type GetReportStateRequest

type GetReportStateRequest struct {
	ReportId string `json:"reportId,omitempty"`
}

GetReportStateRequest 获取异步报告状态 API Request

func (GetReportStateRequest) Url

func (r GetReportStateRequest) Url() string

type GetReportStateResponse

type GetReportStateResponse struct {
	Data []struct {
		IsGenerated int `json:"isGenerated,omitempty"` // 报告生成状态; 1 - 等待中; 2 - 处理中; 3 - 处理成功
	} `json:"data,omitempty"`
}

GetReportStateResponse 获取异步报告状态 API Response

type KeywordLiveData

type KeywordLiveData struct {
	// KeywordId 关键词Id
	KeywordId int64 `json:"keywordId,omitempty"`
	// RegionId 地域代码
	RegionId int `json:"regionId,omitempty"`
	// Device 投放设备类型
	Device int `json:"device,omitempty"`
	// Minute 数据时间
	Minute string `json:"minute,omitempty"`
	// LeftRank 关键词在minute指定的分钟内左侧平均排名（计算机）
	LeftRank float64 `json:"leftRank,omitempty"`
	// RightRank 关键词在minute指定的分钟内右侧平均排名（计算机）
	RightRank float64 `json:"rightRank,omitempty"`
	// TopRank 关键词在minute指定的分钟内上方平均排名（移动设备）
	TopRank float64 `json:"topRank,omitempty"`
	// BottomRank 关键词在minute指定的分钟内下方平均排名（移动设备）
	BottomRank float64 `json:"bottomRank,omitempty"`
	// LeftShows 关键词在minute指定的分钟内左侧展现次数（计算机）
	LeftShows int64 `json:"leftShows,omitempty"`
	// RightShows 关键词在minute指定的分钟内右侧展现次数（计算机）
	RightShows int64 `json:"rightShows,omitempty"`
	// TopShows 关键词在minute指定的分钟内上方展现次数（移动设备)
	TopShows int64 `json:"topShows,omitempty"`
	// BottomShows 关键词在minute指定的分钟内下方展现次数（移动设备）
	BottomShows int64 `json:"bottomShows,omitempty"`
	// Click 关键词在minute指定的分钟内的点击次数
	Click int64 `json:"click,omitempty"`
	// Cost 关键词在minute指定的分钟内的消费
	Cost float64 `json:"cost,omitempty"`
}

KeywordLiveData 关键词实时数据

type RealTimePairRequest

type RealTimePairRequest struct {
	// PerformanceData 必填 取值范围：click（点击）、 impression（展现）、cost 花费）、ctr（点击率）、trans（网页转化）、bridgetrans（商桥转化）、querystatus（账户添加状态）、mixWmatchEnum（匹配模式）（impression,click必填） 针对不同的物料层级，其合法的取值范围不同，（按照第一个请求的字段排序）请参见规则描述。
	PerformanceData []string `json:"performanceData,omitempty"`
	// Order 是否为降序排列; 选填，默认null，按照时间排序： true：降序 false：升序 app下载报告/推广电话报告，不支持排序
	Order *bool `json:"order,omitempty"`
	// StartDate 统计开始时间，格式参考： 2010-08-01
	StartDate string `json:"startDate,omitempty"`
	// EndDate 统计结束时间，格式参考： 2010-08-17
	EndDate string `json:"endDate,omitempty"`
	// LevelOfDetails 指定返回的数据层级; 必填 12：关键词+创意粒度
	LevelOfDetails int `json:"levelOfDetails,omitempty"`
	// Attributes 针对特定的数据层级设置特定的统计范围; 选填； 为NULL表示统计全部地域。 key:provid； value:地域代码数组 说明：app下载报告/推广电话不支持attributes
	Attributes []Attribute `json:"attributes,omitempty"`
	// ReportType 实时数据类型; 必填； 15：配对
	ReportType int `json:"reportType,omitempty"`
	// StatIds 统计范围下的id集合。根据StatRange的不同类型填写不同id; 选填，默认NULL，表示统计范围为全账户 staRange为3时填写计划id; staRange为5时填写单元id; staRange为7时填写创意id; staRange为11时填写关键词keywordid
	StatIds []int64 `json:"statIds,omitempty"`
	// StatRange 统计范围; 选填，默认值为2； 2：账户范围 3：计划范围 注意：统计范围不能细于当前的统计粒度，例如统计粒度为计划，则统计范围不能细到单元
	StatRange int `json:"statRange,omitempty"`
	// UnitOfTime 统计时间单位; 选填，默认值为5 取值范围： 5：分日 8：请求时间段汇总(endDate-StartDate)
	UnitOfTime int `json:"unitOfTime,omitempty"`
	// Number 返回数据条数;选填 目前实时报告中账户、计划、单元、关键词、创意报告最大支持10000，其他类型实时报告只支持5000。 默认值1000 注意：超过限制或者小于等于0则报错 说明：app下载报告/推广电话报告、当物料量较大时，建议按计划或单元分批获取，一条对应三条返回值
	Number int `json:"number,omitempty"`
	// Device 搜索推广设备; 选填，默认值为0 取值范围： 0：全部搜索推广设备 1：仅计算机 2：仅移动
	Device int `json:"device,omitempty"`
}

RealTimePairRequest 配对报告请求

type RealTimePairResult

type RealTimePairResult struct {
	// KeywordId 关键词ID
	KeywordId int64 `json:"keywordId,omitempty"`
	// CreativeId 创意ID
	CreativeId int64 `json:"creativeId,omitempty"`
	// PairInfo 账户名，计划名，单元名，关键词字面，创意标题,创意描述一，创意描述二，创意显示url ，搜索引擎，精确匹配扩展(地域词扩展)触发
	PairInfo []string `json:"pairInfo,omitempty"`
	// Date 统计开始时间
	Date string `json:"date,omitempty"`
	// KPIs 按照请求顺序，返回KPI数据数组
	KPIs []json.Number `json:"KPIs,omitempty"`
}

RealTimePairResult 配对报告返回

type RealTimeQueryRequest

type RealTimeQueryRequest struct {
	// PerformanceData 必填 取值范围：click（点击）、 impression（展现）、cost 花费）、ctr（点击率）、trans（网页转化）、bridgetrans（商桥转化）、querystatus（账户添加状态）、mixWmatchEnum（匹配模式）（impression,click必填） 针对不同的物料层级，其合法的取值范围不同，（按照第一个请求的字段排序）请参见规则描述。
	PerformanceData []string `json:"performanceData,omitempty"`
	// StartDate 统计开始时间，格式参考： 2010-08-01
	StartDate string `json:"startDate,omitempty"`
	// EndDate 统计结束时间，格式参考： 2010-08-17
	EndDate string `json:"endDate,omitempty"`
	// LevelOfDetails 指定返回的数据层级; 选填，默认为账户 2：账户粒度 3：计划粒度 5：单元粒度 7：创意粒度 11：关键词粒度 12：关键词+创意粒度 200: 高级创意报告粒度
	LevelOfDetails int `json:"levelOfDetails,omitempty"`
	// Attributes 针对特定的数据层级设置特定的统计范围; 选填； 为NULL表示统计全部地域。 key:provid； value:地域代码数组 说明：app下载报告/推广电话不支持attributes
	Attributes []Attribute `json:"attributes,omitempty"`
	// ReportType 实时数据类型; 必填； 6：搜索词
	ReportType int `json:"reportType,omitempty"`
	// StatIds 统计范围下的id集合。根据StatRange的不同类型填写不同id	;选填，默认NULL，表示统计范围为全账户 staRange为3时填写计划id;
	StatIds []int64 `json:"statIds,omitempty"`
	// StatRange 统计范围; 选填，默认值为2； 2：账户范围 3：计划范围 注意：统计范围不能细于当前的统计粒度，例如统计粒度为计划，则统计范围不能细到单元
	StatRange int `json:"statRange,omitempty"`
	// UnitOfTime 统计时间单位; 选填，默认值为5 取值范围： 5：分日 8：请求时间段汇总(endDate-StartDate)
	UnitOfTime int `json:"unitOfTime,omitempty"`
	// Number 返回数据条数;选填 目前实时报告中账户、计划、单元、关键词、创意报告最大支持10000，其他类型实时报告只支持5000。 默认值1000 注意：超过限制或者小于等于0则报错 说明：app下载报告/推广电话报告、当物料量较大时，建议按计划或单元分批获取，一条对应三条返回值
	Number int `json:"number,omitempty"`
	// Device 搜索推广设备; 选填，默认值为0 取值范围： 0：全部搜索推广设备 1：仅计算机 2：仅移动
	Device int `json:"device,omitempty"`
}

RealTimeQueryRequest 搜索词报告请求 querystatus（用户添加状态）返回值与字面映射关系 "0": "已添加", "1": "未添加", "2": "不可添加" mixWmatchEnum（匹配模式）返回值与字面映射关系 "0": "智能匹配" "15": "智能匹配" "127": "分匹配出价" "16": "智能匹配核心词" "313": "智能匹配核心词" "17": "短语匹配" "18": "短语匹配" "31": "短语匹配" "48": "精确匹配" "63": "精确匹配" "9998":"-" "9999":"-"

type RealTimeQueryResult

type RealTimeQueryResult struct {
	// Query 搜索词字面
	Query string `json:"query,omitempty"`
	// KeywordId 关键词ID
	KeywordId int64 `json:"keywordId,omitempty"`
	// CreativeId 创意ID
	CreativeId int64 `json:"creativeId,omitempty"`
	// QueryInfo 账户名，计划名，单元名，关键词字面，创意标题,创意描述一，创意描述二，创意显示url ，搜索引擎，精确匹配扩展(地域词扩展)触发
	QueryInfo []string `json:"queryInfo,omitempty"`
	// Date 统计开始时间
	Date string `json:"Dat,omitempty"`
	// KPIs 按照请求顺序，返回KPI数据数组
	KPIs []json.Number `json:"KPIs,omitempty"`
}

RealTimeQueryResult 搜索词报告返回

type RealTimeRequest

type RealTimeRequest struct {
	// PerformanceData 必填 取值范围：cost（花费）、cpc（平均点击价格）、impression（展现）、click（点击）、ctr（点击率）、cpm（千次展现成本）、position（上方位平均排名）、conversion（网页转化）、商桥转化（bridgeConversion） 其中（impression,click必填） .另由于转化字段较多，取值可参考转化字段表。针对不同的物料层级，其合法的取值范围不同，（按照第一个请求的字段排序）请参见报告规则
	PerformanceData []string `json:"performanceData,omitempty"`
	// Order 是否为降序排列; 选填，默认null，按照时间排序： true：降序 false：升序 app下载报告/推广电话报告，不支持排序
	Order *bool `json:"order,omitempty"`
	// StartDate 统计开始时间，格式参考： 2010-08-01
	StartDate string `json:"startDate,omitempty"`
	// EndDate 统计结束时间，格式参考： 2010-08-17
	EndDate string `json:"endDate,omitempty"`
	// LevelOfDetails 指定返回的数据层级; 选填，默认为账户 2：账户粒度 3：计划粒度 5：单元粒度 7：创意粒度 11：关键词粒度 12：关键词+创意粒度 200: 高级创意报告粒度
	LevelOfDetails int `json:"levelOfDetails,omitempty"`
	// Attributes 针对特定的数据层级设置特定的统计范围; 选填； 为NULL表示统计全部地域。 key:provid； value:地域代码数组 说明：app下载报告/推广电话不支持attributes
	Attributes []Attribute `json:"attributes,omitempty"`
	// ReportType 实时数据类型; 必填； 2：账户 10：计划 11：单元 14：关键词 12：创意 3：地域 5：二级地域报告 40：app下载报告 928: 高级创意报告（目前仅支持未删除图片的数据）
	ReportType int `json:"reportType,omitempty"`
	// StatIds 统计范围下的id集合。根据StatRange的不同类型填写不同id	;选填，默认NULL，表示统计范围为全账户 最多500个 staRange为3时填写计划id; staRange为5时填写单元id; staRange为7时填写创意id; staRange为11时填写关键词keywordid
	StatIds []int64 `json:"statIds,omitempty"`
	// StatRange 统计范围; 选填，默认值为2； 2：账户范围 3：计划范围 5：单元范围 7：创意范围 11：关键词范围 注意：统计范围不能细于当前的统计粒度，例如统计粒度为计划，则统计范围不能细到单元
	StatRange int `json:"statRange,omitempty"`
	// UnitOfTime 统计时间单位;选填，默认值为5 取值范围： 5：分日 4：分周 3：分月 1：分年 7：分小时 8：请求时间段汇总(endDate-StartDate)
	UnitOfTime int `json:"unitOfTime,omitempty"`
	// Number 返回数据条数;选填 目前实时报告中账户、计划、单元、关键词、创意报告最大支持10000，其他类型实时报告只支持5000。 默认值1000 注意：超过限制或者小于等于0则报错 说明：app下载报告/推广电话报告、当物料量较大时，建议按计划或单元分批获取，一条对应三条返回值
	Number int `json:"number,omitempty"`
	// PageIndex 分页; 选填）请求页码 说明：默认不分页 当不填写页码或页码参数为<=0时，代表未分页； 请求页码设置大于0时，代表分页请求（同时需要配合number字段）
	PageIndex int `json:"pageIndex,omitempty"`
	// Device 搜索推广设备; 选填，默认值为0 取值范围： 0：全部搜索推广设备 1：仅计算机 2：仅移动
	Device int `json:"device,omitempty"`
}

RealTimeRequest 实时报告请求-包含多类报告

type RealTimeResult

type RealTimeResult struct {
	// ID 请求对象的ID app下载报告/推广电话报告，请求对象的ID，为null
	ID json.Number `json:"ID,omitempty"`
	// Name 请求对象的name，数组形式，不同报告形式的不同定义规则定义如下文
	Name []string `json:"name,omitempty"`
	// RelatedId 依赖ID仅在 reportType=9，relatedId为adgroupId reportType=3，relatedId为userId reportType=5，relatedId为省市一级地域代码 其余情况为Null。
	RelatedId int `json:"relatedId,omitempty"`
	// Date 统计开始时间
	Date string `json:"date,omitempty"`
	// KPIs 按照请求顺序，返回KPI数据数组
	KPIs []json.Number `json:"KPIs,omitempty"`
	// TotalNumber 记录总条数
	TotalNumber int64 `json:"totalNumber,omitempty"`
	// TotalRowNumber 记录总条数
	TotalRowNumber json.Number `json:"totalRowNumber,omitempty"`
	// PageIndex 当前页码
	PageIndex int `json:"pageIndex,omitempty"`
}

RealTimeResult

type ReportRequest

type ReportRequest struct {
	// PerformanceData 必填 取值范围：cost（花费）、cpc（平均点击价格）、impression（展现）、click（点击）、ctr（点击率）、cpm（千次展现成本）、position（上方位平均排名）、conversion（网页转化）、商桥转化（bridgeConversion） 其中（impression,click必填） .另由于转化字段较多，取值可参考转化字段表。针对不同的物料层级，其合法的取值范围不同，（按照第一个请求的字段排序）请参见报告规则
	PerformanceData []string `json:"performanceData,omitempty"`
	// IdOnly 是否只需要id; 选填；默认为false 取值范围： true：只获取id false：既获取id也获取字面
	IdOnly bool `json:"idOnly,omitempty"`
	// StartDate 统计开始时间，格式参考： 2010-08-01
	StartDate string `json:"startDate,omitempty"`
	// EndDate 统计结束时间，格式参考： 2010-08-17
	EndDate string `json:"endDate,omitempty"`
	// LevelOfDetails 指定返回的数据层级; 选填，默认为账户 2：账户粒度 3：计划粒度 5：单元粒度 7：创意粒度 11：关键词粒度 12：关键词+创意粒度 200: 高级创意报告粒度
	LevelOfDetails int `json:"levelOfDetails,omitempty"`
	// Attributes 针对特定的数据层级设置特定的统计范围; 选填； 为NULL表示统计全部地域。 key:provid； value:地域代码数组 说明：app下载报告/推广电话不支持attributes
	Attributes []Attribute `json:"attributes,omitempty"`
	// Format 报告文件格式; 选填，默认值为2； 2：csv格式
	Format int `json:"format,omitempty"`
	// ReportType 实时数据类型; 必填； 2：账户 10：计划 11：单元 14：关键词 12：创意 3：地域 5：二级地域报告 40：app下载报告 928: 高级创意报告（目前仅支持未删除图片的数据）
	ReportType int `json:"reportType,omitempty"`
	// StatIds 统计范围下的id集合。根据StatRange的不同类型填写不同id	;选填，默认NULL，表示统计范围为全账户 最多500个 staRange为3时填写计划id; staRange为5时填写单元id; staRange为7时填写创意id; staRange为11时填写关键词keywordid
	StatIds []int64 `json:"statIds,omitempty"`
	// StatRange 统计范围; 选填，默认值为2； 2：账户范围 3：计划范围 5：单元范围 7：创意范围 11：关键词范围 注意：统计范围不能细于当前的统计粒度，例如统计粒度为计划，则统计范围不能细到单元
	StatRange int `json:"statRange,omitempty"`
	// UnitOfTime 统计时间单位;选填，默认值为5 取值范围： 5：分日 4：分周 3：分月 1：分年 7：分小时 8：请求时间段汇总(endDate-StartDate)
	UnitOfTime int `json:"unitOfTime,omitempty"`
	// Device 搜索推广设备; 选填，默认值为0 取值范围： 0：全部搜索推广设备 1：仅计算机 2：仅移动
	Device int `json:"device,omitempty"`
}

ReportRequest 异步报告请求