v3

Documentation

Overview

Package asynctask 升级版异步数据报表相关API Models

Index

• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type DownloadRequest
  • func (r DownloadRequest) Encode() string
• type GetFilter
• type GetRequest
  • func (r GetRequest) Encode() string

Types

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// TaskName 任务名称。最大长度 25 个字符，不能为空字符
	TaskName string `json:"task_name,omitempty"`
	// Force true/false。是否强制生成新的任务（不复用之前任务的结果），不传默认false
	Force bool `json:"force,omitempty"`
	// DateTopic 数据主题
	DataTopic string `json:"data_topic"`
	// Dimensions 维度列表。获取方式：巨量引擎体验版—>报表—>新建/编辑自定义报表—>API参数生成。该字段从前端自定义报表中获取，建议不要修改。
	Dimensions []string `json:"dimensions,omitempty"`
	// Metrics 指标列表 。获取方式：巨量引擎体验版—>报表—>新建/编辑自定义报表—>API参数生成。该字段从前端自定义报表中获取，建议不要修改。
	Metrics []string `json:"metrics,omitempty"`
	// Filters 过滤字段，json格式，支持字段如下
	Filters []v3.CustomGetFilter `json:"filters,omitempty"`
	// StartTime 起始日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期
	StartTime time.Time `json:"start_time,omitempty"`
	// EndTime 结束日期,格式YYYY-MM-DD,只支持查询2016-10-26及以后的日期，时间跨度不能超过30天
	EndTime time.Time `json:"end_time,omitempty"`
	// OrderBy 排序
	OrderBy []v3.OrderBy `json:"order_by,omitempty"`
}

CreateRequest 自定义报表—创建异步任务 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type DownloadRequest

type DownloadRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// TaskID 任务 id
	TaskID uint64 `json:"task_id,omitempty"`
}

DownloadRequest 下载任务结果

func (DownloadRequest) Encode

func (r DownloadRequest) Encode() string

Encode implement GetRequest interface

type GetFilter

type GetFilter struct {
	// TaskIDs 任务 id。最多 10 个
	TaskIDs []uint64 `json:"task_ids,omitempty"`
	// TaskName 任务名称。
	TaskName string `json:"task_name,omitempty"`
	// DataTopics 数据主题
	// 返回值：BASIC_DATA广告基础数据、QUERY_DATA搜索词数据、BIDWORD_DATA关键词数据、MATERIAL_DATA素材数据、PRODUCT_DATA产品数据、
	DataTopics []string `json:"data_topics,omitempty"`
}

GetFilter 筛选条件

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 筛选条件
	Filtering *GetFilter `json:"filtering,omitempty"`
	// Page 分搜索页码
	// 默认值: 1
	// 取值范围: ≥ 0
	Page int `json:"page,omitempty"`
	// PageSize 一页展示的数据数量
	// 默认值: 1
	// 取值范围: 1-10
	PageSize int `json:"page_size,omtiempty"`
}

GetRequest 获取任务列表 API Request

func (GetRequest) Encode

func (r GetRequest) Encode() string

Encode implement GetRequest interface