report

package
v1.0.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 23, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountLiveData 

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

type Attribute 

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

type GetAccountLiveDataRequest 

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

func (GetAccountLiveDataRequest) Url 

func (r GetAccountLiveDataRequest) Url() string

type GetAccountLiveDataResponse 

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

type GetKeywordLiveDataRequest 

type GetKeywordLiveDataRequest struct {
	DataType     int     `json:"dataType,omitempty"`     // 账户/计划实时数据查询
	KeywordIds   []int64 `json:"keywordIds,omitempty"`   // 关键词id，该集合为请求关键词实时数据的集合; 数组内关键词个数上限为200
	Device       int     `json:"device,omitempty"`       // 投放设备
	StartTime    string  `json:"startTime,omitempty"`    // 起始时间; 选填， 默认值：当前请求时间之前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分钟之前的时间
	EndTime      string  `json:"endTime,omitempty"`      // 结束时间; 同起始时间，且不能早于startTime
	RegionTarget []int   `json:"regionTarget,omitempty"` // 地域; 选填，默认全部区域，取值范围参考地域代码，地域代码个数上限为10
}

func (GetKeywordLiveDataRequest) Url 

func (r GetKeywordLiveDataRequest) Url() string

type GetKeywordLiveDataResponse 

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

type GetProfessionalReportIdRequest 

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

func (GetProfessionalReportIdRequest) Url 

func (r GetProfessionalReportIdRequest) Url() string

type GetProfessionalReportIdResponse 

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

type GetRealTimeDataRequest 

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

func (GetRealTimeDataRequest) Url 

func (r GetRealTimeDataRequest) Url() string

type GetRealTimeDataResponse 

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

type GetReportFileUrlRequest 

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

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"`
}

type GetReportStateRequest 

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

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"`
}

type KeywordLiveData 

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

type RealTimePairRequest 

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

配对报告请求

type RealTimePairResult 

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

配对报告返回

type RealTimeQueryRequest 

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

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

type RealTimeQueryResult 

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

搜索词报告返回

type RealTimeRequest 

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

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

type RealTimeResult 

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

type ReportRequest 

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

异步报告请求

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.