dpa

package
v1.16.7 Latest Latest
Warning

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

 Go to latest Published: Jul 13, 2023 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Overview

Package dpa 商品广告相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Asset added in v1.8.0 

type Asset struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetID 物件id
	AssetID uint64 `json:"asset_id,omitempty"`
	// PlatformID 商品库id
	PlatformID uint64 `json:"platform_id,omitempty"`
	// AssetType 物件类型，AUTO为汽车
	AssetType string `json:"asset_type,omitempty"`
	// ProductID 商品id
	ProductID uint64 `json:"product_id,omitempty"`
	// Status 物件状态，DISABLE代表暂停， ENABLE代表启用
	Status string `json:"status,omitempty"`
	// Source 来源，MANUAL为用户操作，AUTO为系统生成
	Source string `json:"source,omitempty"`
	// AssetCreateTime 物件创建时间，格式: yyyy-MM-DD
	AssetCreateTime string `json:"asset_create_time,omitempty"`
	// AssetModifyTime 物件最近一次修改时间，格式: yyyy-MM-DD
	AssetModifyTime string `json:"asset_modify_time,omitempty"`
}

Asset 物件

type AssetsDetailReadRequest added in v1.8.0 

type AssetsDetailReadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AssetIDs 物件ID, 最多允许传入100个，可通过【获取投放条件列表】获取
	AssetIDs []uint64 `json:"asset_ids,omitempty"`
}

AssetsDetailReadRequest 获取投放条件详情 API Request

func (AssetsDetailReadRequest) Encode added in v1.8.0 

func (r AssetsDetailReadRequest) Encode() string

Encode implement GetRequest interface

type AssetsDetailReadResponse added in v1.8.0 

type AssetsDetailReadResponse struct {
	model.BaseResponse
	Data struct {
		// List 商品库商品列表
		List []Asset `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

AssetsDetailReadResponse 获取投放条件详情 API Response

type AssetsListFilter added in v1.8.0 

type AssetsListFilter struct {
	// Status 物件状态， 0代表暂停， 1代表启用
	Status int `json:"status"`
}

AssetsListFilter 过滤条件

type AssetsListRequest added in v1.8.0 

type AssetsListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// ProductIDs 商品ID列表
	ProductIDs []uint64 `json:"product_ids,omitempty"`
	// Filtering 过滤条件
	Filtering *AssetsListFilter `json:"filtering,omitempty"`
	// Page 页码， 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量， 默认值: 10，最大 100
	PageSize int `json:"page_size,omitempty"`
}

AssetsListRequest 获取投放条件列表 API Request

func (AssetsListRequest) Encode added in v1.8.0 

func (r AssetsListRequest) Encode() string

Encode implement GetRequest interface

type AssetsListResponse added in v1.8.0 

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

AssetsListResponse 获取投放条件列表 API Response

type AssetsListResponseData added in v1.8.0 

type AssetsListResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 商品库商品列表
	List []Asset `json:"list,omitempty"`
}

AssetsListResponseData

type Behaviour added in v1.8.0 

type Behaviour struct {
	// CodeID 行为id
	CodeID uint64 `json:"code_id,omitempty"`
	// Name 行为名称
	Name string `json:"name,omitempty"`
}

Behaviour 行为

type BehaviourAvailablesRequest added in v1.8.0 

type BehaviourAvailablesRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库id
	PlatformID uint64 `json:"platform_id,omitempty"`
}

BehaviourAvailablesRequest 获取DPA可用行为 API Request

func (BehaviourAvailablesRequest) Encode added in v1.8.0 

func (r BehaviourAvailablesRequest) Encode() string

Encode implement GetRequest interface

type BehaviourAvailablesResponse added in v1.8.0 

type BehaviourAvailablesResponse struct {
	model.BaseResponse
	Data struct {
		// List DPA行为列表
		List []Behaviour `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

BehaviourAvailablesResponse 获取DPA可用行为 API Response

type BrandInfo 

type BrandInfo struct {
	// BrandID 品牌ID
	BrandID string `json:"brand_id,omitempty"`
	// BrandName 品牌名称
	BrandName string `json:"brand_name,omitempty"`
	// EnBrand 英文品牌名
	EnBrand string `json:"en_brand,omitempty"`
	BrandLogo string `json:"brand_logo,omitempty"`
	// BrandURL PC端品牌落地页URL
	BrandURL string `json:"brand_url,omitempty"`
	// BrandURLMobile H5页面品牌落地页URL
	BrandURLMobile string `json:"brand_url_mobile,omitempty"`
	// BrandURLAndroidApp Android应用品牌直达调起链接
	BrandURLAndroidApp string `json:"brand_url_android_app,omitempty"`
	// BrandURLIosApp IOS应用品牌直达调起链接
	BrandURLIosApp string `json:"brand_url_ios_app,omitempty"`
	// BrandURLUniversalLink IOS应用品牌调起ulink链接
	BrandURLUniversalLink string `json:"brand_url_universal_link,omitempty"`
}

BrandInfo 品牌信息

type Category added in v1.8.0 

type Category struct {
	// ID 分类id
	ID model.Uint64 `json:"id,omitempty"`
	// Name 分类名称
	Name string `json:"name,omitempty"`
	// Parent 父级分类id，没有父级则为-1
	Parent model.Uint64 `json:"parent,omitempty"`
	// Subs 子级分类，嵌套递归
	Subs []Category `json:"subs,omitempty"`
}

Category DPA分类

type CategoryGetRequest added in v1.8.0 

type CategoryGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库id
	PlatformID uint64 `json:"platform_id,omitempty"`
}

CategoryGetRequest 获取DPA分类 API Request

func (CategoryGetRequest) Encode added in v1.8.0 

func (r CategoryGetRequest) Encode() string

Encode implement GetRequest interface

type CategoryGetResponse added in v1.8.0 

type CategoryGetResponse struct {
	model.BaseResponse
	Data struct {
		// List DPA分类列表
		List []Category `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

CategoryGetResponse 获取DPA分类 API Response

type DetailGetFilter added in v1.8.0 

type DetailGetFilter struct {
	// DpaCategories 商品行业分类，长度限制 50，使用的三级行业ID ，可从 【获取行业列表】 接口获取
	DpaCategories []uint64 `json:"dpa_categories,omitempty"`
	// IsRecommend 是否系统推荐，1表示只看系统推荐，0表示不限系统推荐，默认为0
	IsRecommend int `json:"is_recommend,omitempty"`
	// ProductID 商品ID，精准匹配，与product_name（商品名称）同时传入，以商品ID为准
	ProductID uint64 `json:"product_id,omitempty"`
	// ProductName 商品名称，模糊匹配，长度限制50字，与product_id（商品ID）同时传入，以商品ID为准
	ProductName string `json:"product_name,omitempty"`
	// Status 商品投放状态，枚举值：0代表不可投放，1代表可投放
	Status *int `json:"status,omitempty"`
}

DetailGetFilter 过滤条件

type DetailGetRequest added in v1.8.0 

type DetailGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ProductPlatformID 商品库ID ，可通过【获取商品库信息】获取
	ProductPlatformID uint64 `json:"product_platform_id,omitempty"`
	// Filtering 过滤条件
	Filtering *DetailGetFilter `json:"filtering,omitempty"`
	// Page 页码， 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量， 默认值: 20，最大 100
	PageSize int `json:"page_size,omitempty"`
}

DetailGetRequest 获取商品列表 API Request

func (DetailGetRequest) Encode added in v1.8.0 

func (r DetailGetRequest) Encode() string

Encode implement GetRequest interface

type DetailGetResponse added in v1.8.0 

type DetailGetResponse struct {
	model.BaseResponse
	// Data 返回数据
	Data *DetailGetResponseData `json:"data,omitempty"`
}

DetailGetResponse 获取商品列表 API Response

type DetailGetResponseData added in v1.8.0 

type DetailGetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 商品库商品列表
	List []Product `json:"list,omitempty"`
}

DetailGetResponseData 返回数据

type Dict added in v1.8.0 

type Dict struct {
	// ID 词包id
	ID uint64 `json:"id,omitempty"`
	// PdaID 商品库id
	PdaID uint64 `json:"pda_id,omitempty"`
	// DefaultWord 默认词
	DefaultWord string `json:"default_word,omitempty"`
	// Name 词包名称
	Name string `json:"name,omitempty"`
}

Dict 词包

type DictGetRequest added in v1.8.0 

type DictGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库id
	PlatformID uint64 `json:"platform_id,omitempty"`
}

DictGetRequest 获取DPA词包 API Request

func (DictGetRequest) Encode added in v1.8.0 

func (r DictGetRequest) Encode() string

Encode implement GetRequest interface

type DictGetResponse added in v1.8.0 

type DictGetResponse struct {
	model.BaseResponse
	Data struct {
		// List DPA词包列表
		List []Dict `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

DictGetResponse 获取DPA词包 API Response

type ImageInfo added in v1.8.0 

type ImageInfo struct {
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// ImageID 图片id
	ImageID string `json:"image_id,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
}

ImageInfo 视频模板封面图信息

type LandingInfo 

type LandingInfo struct {
	// TargetURL PC端商品落地页URL
	TargetURL string `json:"target_url,omitempty"`
	// TargetURLMobile H5页面商品落地页URL
	TargetURLMobile string `json:"target_url_mobile,omitempty"`
	// TargetURLAndroidApp Android应用直达落地页
	TargetURLAndroidApp string `json:"target_url_android_app,omitempty"`
	// TargetURLIosApp IOS应用商品直达调起链接
	TargetURLIosApp string `json:"target_url_ios_app,omitempty"`
	// TargetURLUniversalLink IOS应用商品调起ulink链接
	TargetURLUniversalLink string `json:"target_url_universal_link,omitempty"`
}

LandingInfo 落地页信息 

type Link struct {
	URL string `json:"string,omitempty"`
}

type Meta 

type Meta struct {
	// Status 元信息状态
	Status int `json:"status,omitempty"`
	// Name 元信息名称
	Name string `json:"name,omitempty"`
	// Title 元信息头
	Title string `json:"title,omitempty"`
	// MediaType 元信息媒体类型
	MediaType int `json:"media_type,omitempty"`
	// FieldGroup 分组
	FieldGroup string `json:"field_group,omitempty"`
	// Type 字段类型
	Type string `json:"type,omitempty"`
}

Meta 商品库元信息

type MetaGetRequest 

type MetaGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库id
	PlatformID uint64 `json:"platform_id,omitempty"`
}

MetaGetRequest 获取商品库元信息 API Request

func (MetaGetRequest) Encode 

func (r MetaGetRequest) Encode() string

Encode implement GetRequest interface

type MetaGetResponse 

type MetaGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// List
		List []Meta `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

MetaGetResponse 获取商品库元信息 API Response

type Platform 

type Platform struct {
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// Name 商品库名称
	Name string `json:"name,omitempty"`
	// ProductIndustry 商品库行业类别
	ProductIndustry enum.ProductIndustry `json:"product_industry,omitempty"`
}

Platform 商品库详情

type PriceInfo 

type PriceInfo struct {
	// Value 商品原价，可用于素材拼接，以及动态创意标题或者素材
	Value float64 `json:"value,omitempty"`
	// PriceUnit 价格单位
	PriceUnit string `json:"price_unit,omitempty"`
	// Saving 减价
	Saving float64 `json:"saving,omitempty"`
	// Discount 折扣
	Discount float64 `json:"discount,omitempty"`
	// Price 商品现价
	Price float64 `json:"price,omitempty"`
	// SalesPromotion 促销活动，关于商品促销活动的描述信息
	SalesPromotion string `json:"sales_promotion,omitempty"`
	// DownPayment 首付
	DownPayment string `json:"down_payment,omitempty"`
	// Montage 月付
	Montage string `json:"montage,omitempty"`
	// DailyMontage 日付
	DailyMontage string `json:"daily_montage,omitempty"`
}

PriceInfo 价格信息

type Product 

type Product struct {
	// Name 商品名称
	Name string `json:"name,omitempty"`
	// Title 商品标题
	Title string `json:"title,omitempty"`
	// Description 商品标题
	Description string `json:"description,omitempty"`
	// OfflineTime 下线时间，格式"YYYY-MM-DD"
	OfflineTime string `json:"offline_time,omitempty"`
	// OnlineTime 上线时间，格式"YYYY-MM-DD"
	OnlineTime string `json:"online_time,omitempty"`
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
	// SpuID 商品spu_id
	SpuID string `json:"spu_id,omitempty"`
	// OuterID 商品外部id
	OuterID string `json:"outer_id,omitempty"`
	// ImageURL 商品封面图片链接
	ImageURL string `json:"image_url,omitempty"`
	// ImageURLs 扩展商品图，商品图片的补充
	ImageURLs []Link `json:"image_urls,omitempty"`
	// Status 商品投放状态，0代表不可投放，1代表可投放
	Status int `json:"status,omitempty"`
	// Stock 商品库存状态，0代表无库存，1代表有库存
	Stock int `json:"stock,omitempty"`
	// LandingInfo 落地页信息
	LandingInfo *LandingInfo `json:"landing_info,omitempty"`
	// BrandInfo 品牌信息
	BrandInfo *BrandInfo `json:"brand_info,omitempty"`
	// ShopKeeperInfo 商户信息
	ShopKeeperInfo *ShopKeeperInfo `json:"shop_keeper_info,omitempty"`
	// PriceInfo 价格信息
	PriceInfo *PriceInfo `json:"price_info,omitempty"`
	// Feature 特色信息
	Feature string `json:"feature,omitempty"`
	// Mark 评分
	Mark float64 `json:"mark,omitempty"`
	// Bought 购买量
	Bought int64 `json:"bought,omitempty"`
	// Comments 评论数
	Comments int64 `json:"comments,omitempty"`
	// Province 省份，用于定向人群，默认不限，示例：["江苏","浙江"]
	Province []string `json:"province,omitempty"`
	// City 定向城市
	City []string `json:"city,omitempty"`
	// Age 年龄段，用于定向人群，默认不限，数组项允许值如下：
	// 1 2 3 4 5 6
	// 1代表年龄段<18
	// 2 代表年龄段在18~23之间
	// 3代表年龄段在24~30之间
	// 4代表年龄段在31~40之间
	// 5代表年龄段在41~49之间
	// 6代表年龄段>50
	// 如：[2,4]代表年龄段在18~23之间或31~40之间
	Age []int `json:"age,omitempty"`
	// Label 商品标签，小说库特有字段
	Label string `json:"label,omitempty"`
	// ExternalURL 落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// FirstCategory 商品所处一级行业
	FirstCategory string `json:"first_category,omitempty"`
	// SubCategory 商品所处二级行业
	SubCategory string `json:"sub_category,omitempty"`
	// ThirdCategory 商品所处三级行业
	ThirdCategory string `json:"third_category,omitempty"`
	// FirstCategoryID 商品所处一级行业 ID
	FirstCategoryID string `json:"first_category_id,omitempty"`
	// SubCategoryID 商品所处二级行业 ID
	SubCategoryID string `json:"sub_category_id,omitempty"`
	// ThirdCategoryID 商品所处三级行业 ID
	ThirdCategoryID string `json:"third_category_id,omitempty"`
	// BrandName 商品名称
	BrandName string `json:"brand_name,omitempty"`
	// Tags 商品标签
	Tags []string `json:"tags,omitempty"`
	// Video 视频链接url
	Video string `json:"video,omitempty"`
	// Videos 视频内容，小说库特有字段
	Videos []Link `json:"videos,omitempty"`
	// HasVideo 当前商品是否有商品视频 0：没有，1：有
	HasVideo model.Bool `json:"has_video,omitempty"`
	// Profession 额外信息
	Profession *Profession `json:"profession,omitempty"`
}

Product 商品详情

type ProductAvailablesRequest 

type ProductAvailablesRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
}

ProductAvailablesRequest 获取商品库信息 API Request

func (ProductAvailablesRequest) Encode 

func (r ProductAvailablesRequest) Encode() string

Encode implement GetRequest interface

type ProductAvailablesResponse 

type ProductAvailablesResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// List
		List []Platform `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

ProductAvailablesResponse 获取商品库信息 API Response

type ProductCreateRequest added in v1.8.0 

type ProductCreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// ProductInfo 商品详情，包括商品库基础字段、落地页、品牌、商户、价格以及其他字段信息，以下所有字段均包含在该结构体下，且不同类型商品库填入字段存在差异，具体格式见下方字段详情
	ProductInfo *Product `json:"product_info,omitempty"`
}

ProductCreateRequest 创建DPA商品（无商品id） API Request

func (ProductCreateRequest) Encode added in v1.8.0 

func (r ProductCreateRequest) Encode() []byte

Encode implement PostRequest interface

type ProductCreateResponse added in v1.8.0 

type ProductCreateResponse struct {
	model.BaseResponse
	Data struct {
		// ProductID 商品ID
		ProductID uint64 `json:"product_id,omitempty"`
	} `json:"data,omitempty"`
}

ProductCreateResponse 创建DPA商品（无商品id） API Response

type ProductDeleteRequest added in v1.8.0 

type ProductDeleteRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
}

ProductDeleteRequest

func (ProductDeleteRequest) Encode added in v1.8.0 

func (r ProductDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type ProductDetailGetFilter added in v1.8.0 

type ProductDetailGetFilter struct {
	// ProductIDs 商品ID
	ProductIDs []uint64 `json:"product_ids,omitempty"`
}

ProductDetailGetFilter 过滤条件

type ProductDetailGetRequest added in v1.8.0 

type ProductDetailGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库ID，可通过【获取商品库信息】获取
	// 若仅填写platform_id不填filtering.product_ids则表示查询该商品库下所有商品
	PlatformID uint64 `json:"platform_id,omitempty"`
	// Filtering 过滤条件
	Filtering *ProductDetailGetFilter `json:"filtering,omitempty"`
	// Page 页码， 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量， 默认值: 20，最大 100
	PageSize int `json:"page_size,omitempty"`
}

ProductDetailGetRequest 获取商品详情 API Request

func (ProductDetailGetRequest) Encode added in v1.8.0 

func (r ProductDetailGetRequest) Encode() string

Encode implement GetRequest interface

type ProductDetailGetResponse added in v1.8.0 

type ProductDetailGetResponse struct {
	model.BaseResponse
	// Data 返回数据
	Data *DetailGetResponseData `json:"data,omitempty"`
}

ProductDetailGetResponse 获取商品详情 API Response

type ProductForUpdate added in v1.8.0 

type ProductForUpdate struct {
	// Name 商品名称
	Name string `json:"name,omitempty"`
	// Title 商品标题
	Title string `json:"title,omitempty"`
	// Description 商品标题
	Description string `json:"description,omitempty"`
	// OfflineTime 下线时间, 格式为十位unix时间戳类型，默认为当前时间+3年
	OfflineTime int64 `json:"offline_time,omitempty"`
	// OnlineTime 上线时间, 格式为十位unix时间戳类型，默认为当前时间
	OnlineTime int64 `json:"online_time,omitempty"`
	// Status 商品投放状态，0代表不可投放，1代表可投放
	Status int `json:"status"`
	// Stock 商品库存状态，0代表无库存，1代表有库存
	Stock int `json:"stock"`
	// FirstCategory 商品所处一级行业
	FirstCategory string `json:"first_category,omitempty"`
	// SubCategory 商品所处二级行业
	SubCategory string `json:"sub_category,omitempty"`
	// ThirdCategory 商品所处三级行业
	ThirdCategory string `json:"third_category,omitempty"`
	// FirstCategoryID 商品所处一级行业 ID
	FirstCategoryID string `json:"first_category_id,omitempty"`
	// SubCategoryID 商品所处二级行业 ID
	SubCategoryID string `json:"sub_category_id,omitempty"`
	// ThirdCategoryID 商品所处三级行业 ID
	ThirdCategoryID string `json:"third_category_id,omitempty"`
	// SpuID 商品spu_id
	SpuID string `json:"spu_id,omitempty"`
	// OuterID 商品外部id
	OuterID string `json:"outer_id,omitempty"`
	// ImageURL 商品封面图片链接
	ImageURL string `json:"image_url,omitempty"`
	// ImageURLs 扩展商品图，商品图片的补充
	ImageURLs []Link `json:"image_urls,omitempty"`
	// LandingInfo 落地页信息
	LandingInfo *LandingInfo `json:"landing_info,omitempty"`
	// BrandInfo 品牌信息
	BrandInfo *BrandInfo `json:"brand_info,omitempty"`
	// ShopKeeperInfo 商户信息
	ShopKeeperInfo *ShopKeeperInfo `json:"shop_keeper_info,omitempty"`
	// PriceInfo 价格信息
	PriceInfo *PriceInfo `json:"price_info,omitempty"`
	// Feature 特色信息
	Feature string `json:"feature,omitempty"`
	// Mark 评分
	Mark float64 `json:"mark,omitempty"`
	// Bought 购买量
	Bought int64 `json:"bought,omitempty"`
	// Comments 评论数
	Comments int64 `json:"comments,omitempty"`
	// Province 省份，用于定向人群，默认不限，示例：["江苏","浙江"]
	Province []string `json:"province,omitempty"`
	// City 定向城市
	City []string `json:"city,omitempty"`
	// Age 年龄段，用于定向人群，默认不限，数组项允许值如下：
	// 1 2 3 4 5 6
	// 1代表年龄段<18
	// 2 代表年龄段在18~23之间
	// 3代表年龄段在24~30之间
	// 4代表年龄段在31~40之间
	// 5代表年龄段在41~49之间
	// 6代表年龄段>50
	// 如：[2,4]代表年龄段在18~23之间或31~40之间
	Age []int `json:"age,omitempty"`
	// Label 商品标签，小说库特有字段
	Label string `json:"label,omitempty"`
	// ExternalURL 落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// BrandName 商品名称
	BrandName string `json:"brand_name,omitempty"`
	// Tags 商品标签
	Tags []string `json:"tags,omitempty"`
	// Video 视频链接url
	Video string `json:"video,omitempty"`
	// Videos 视频内容，小说库特有字段
	Videos []Link `json:"videos,omitempty"`
	// HasVideo 当前商品是否有商品视频 0：没有，1：有
	HasVideo int `json:"has_video,omitempty"`
	// Profession 额外信息
	Profession *Profession `json:"profession,omitempty"`
}

ProductForUpdate 商品详情

type ProductStatusBatchUpdateRequest added in v1.8.0 

type ProductStatusBatchUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// ProductIDs 商品ID
	ProductIDs []uint64 `json:"product_ids,omitempty"`
	// OptStatus 操作
	// ENABLE开启投放
	// DISABLE停止投放
	OptStatus string `json:"opt_status,omitempty"`
}

ProductStatusBatchUpdateRequest 批量修改DPA商品状态 API Request

func (ProductStatusBatchUpdateRequest) Encode added in v1.8.0 

func (r ProductStatusBatchUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type ProductStatusBatchUpdateResponse added in v1.8.0 

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

ProductStatusBatchUpdateResponse 批量修改DPA商品状态 API Response

type ProductStatusBatchUpdateResponseData added in v1.8.0 

type ProductStatusBatchUpdateResponseData struct {
	// SuccessList 修改状态成功的商品列表
	SuccessList []uint64 `json:"success_list,omitempty"`
	// ErrorList 修改状态失败的商品列表
	ErrorList []UpdateError `json:"error_list,omitempty"`
}

type ProductUpdateRequest added in v1.8.0 

type ProductUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// PlatformID 商品库ID
	PlatformID uint64 `json:"platform_id,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
	// ProductInfo 商品详情，包括商品库基础字段、落地页、品牌、商户、价格以及其他字段信息，以下所有字段均包含在该结构体下，且不同类型商品库填入字段存在差异，具体格式见下方字段详情
	ProductInfo *Product `json:"product_info,omitempty"`
}

ProductUpdateRequest 创建DPA商品（已有商品id）/修改DPA商品 API Request

func (ProductUpdateRequest) Encode added in v1.8.0 

func (r ProductUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type ProductUpdateResponse added in v1.8.0 

type ProductUpdateResponse struct {
	model.BaseResponse
	Data struct {
		// ProductID 商品ID
		ProductID uint64 `json:"product_id,omitempty"`
	} `json:"data,omitempty"`
}

ProductUpdateResponse 创建DPA商品（已有商品id）/修改DPA商品 API Response

type Profession 

type Profession struct {
	// Platform 平台信息，枚举值：淘宝 天猫 京东 其他
	Platform string `json:"platform,omitempty"`
	// Chapter 章节信息，结构为一个json字符串，章节名称name长度小于100；章节详细内容content长度小于5000
	// 示例："[{"id":"0","name":"莫欺少年穷","content":"莫欺少年穷"},{"id":"1","name":"莫欺中年穷","content":"莫欺中年穷"}]"
	Chapter string `json:"chapter,omitempty"`
	// NovelLength 书籍长短篇，枚举值：长篇书 短篇书
	NovelLength string `json:"novel_length,omitempty"`
	// NovelGender 书籍男女频，枚举值：男频书 女频书 其他
	NovelGender string `json:"novel_gender,omitempty"`
	// NovelAuthor 书籍作者
	NovelAuthor string `json:"novel_author,omitempty"`
	// NovelStar 书籍收藏数
	NovelStar string `json:"novel_star,omitempty"`
	// NovelType 书籍付费/免费信息，枚举值：免费小说 付费小说
	NovelType string `json:"novel_type,omitempty"`
	// StartPayChapter 起始付费章节
	StartPayChapter string `json:"start_pay_chapter,omitempty"`
	// MinPayMoney 最低付费金额
	MinPayMoney string `json:"min_pay_money,omitempty"`
	// AccPayPeople 累计付费人数
	AccPayPeople string `json:"acc_pay_people,omitempty"`
	// AccPayMoney 累计付费金额
	AccPayMoney string `json:"acc_pay_money,omitempty"`
}

Profession 额外信息

type ShopKeeperInfo 

type ShopKeeperInfo struct {
	// ShopKeeperID 商户ID
	ShopKeeperID string `json:"shop_keeper_id,omitempty"`
	// ShopKeeperName 商户名称
	ShopKeeperName string `json:"shop_keeper_name,omitempty"`
	// ShopKeeperURL PC端商户落地页URL
	ShopKeeperURL string `json:"shop_keeper_url,omitempty"`
	// ShopKeeperURLMobile H5页面商户落地页URL
	ShopKeeperURLMobile string `json:"shop_keeper_url_mobile,omitempty"`
	// ShopKeeperURLAndroidApp Android应用商户直达调起链接
	ShopKeeperURLAndroidApp string `json:"shop_keeper_url_android_app,omitempty"`
	// ShopKeeperURLIosApp IOS应用商户直达调起链接
	ShopKeeperURLIosApp string `json:"shop_keeper_url_ios_app,omitempty"`
	// ShopKeeperURLUniversalLink IOS应用商户调起ulink链接
	ShopKeeperURLUniversalLink string `json:"shop_keeper_url_universal_link,omitempty"`
	// Address 商户地址
	Address string `json:"address,omitempty"`
}

ShopKeeperInfo 商户信息

type Template added in v1.8.0 

type Template struct {
	// TemplateID 模板id
	TemplateID uint64 `json:"template_id,omitempty"`
	// TemplateName 模板名称
	TemplateName string `json:"template_name,omitempty"`
	// TemplateMode 模板类型，对应创意素材类型中的大图小图组图
	TemplateMode string `json:"template_mode,omitempty"`
	// Industry 行业
	Industry uint64 `json:"industry,omitempty"`
	// IsPublic 是否是公共模板
	IsPublic bool `json:"is_public,omitempty"`
	// TemplateDataList 模板数据列表
	TemplateDataList []TemplateData `json:"template_data_list,omitempty"`
}

Template 模板

type TemplateData added in v1.8.0 

type TemplateData struct {
	// WebURL 背景图
	WebURL string `json:"web_url,omitempty"`
	// TemplateImageURL 预览图
	TemplateImageURL string `json:"template_image_url,omitempty"`
}

TemplateData 模板数据

type TemplateGetRequest added in v1.8.0 

type TemplateGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Page 页码， 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量， 默认值: 10，最大 100
	PageSize int `json:"page_size,omitempty"`
}

TemplateGetRequest 获取DPA模板 API Request

func (TemplateGetRequest) Encode added in v1.8.0 

func (r TemplateGetRequest) Encode() string

Encode implement GetRequest interface

type TemplateGetResponse added in v1.8.0 

type TemplateGetResponse struct {
	model.BaseResponse
	// Data 返回值
	Data *TemplateGetResponseData `json:"data,omitempty"`
}

TemplateGetResponse 获取DPA模板 API Response

type TemplateGetResponseData added in v1.8.0 

type TemplateGetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 模板列表
	List []Template `json:"list,omitempty"`
}

TemplateGetResponseData 返回值

type UpdateError added in v1.8.0 

type UpdateError struct {
	// ProductID 修改失败的商品id
	ProductID uint64 `json:"product_id,omitempty"`
	// ErrorMsg 失败原因
	ErrorMsg string `json:"error_msg,omitempty"`
}

type Video added in v1.8.0 

type Video struct {
	// ProductPlatformID 商品库id
	ProductPlatformID uint64 `json:"product_platform_id,omitempty"`
	// ProductID 商品库商品id
	ProductID uint64 `json:"product_id,omitempty"`
	// PackageID 商品库视频模板id
	PackageID string `json:"package_id,omitempty"`
	// Name 商品库视频模板名称
	Name string `json:"name,omitempty"`
	// CreateTime 创建时间，格式 %Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// ImageInfo 视频模板封面图信息
	ImageInfo *ImageInfo `json:"image_info,omitempty"`
	// VideoInfo 商品库视频模板视频信息
	VideoInfo *VideoInfo `json:"video_info,omitempty"`
}

Video 视频模板

type VideoGetFilter added in v1.8.0 

type VideoGetFilter struct {
	// ProductPlatformIDs 商品库ids，长度限制 50个
	ProductPlatformIDs []uint64 `json:"product_platform_ids,omitempty"`
	// ProductIDs 商品库商品ids，长度限制 50个
	ProductIDs []uint64 `json:"product_ids,omitempty"`
	// StartTime 视频创建的筛选起始时间
	StartTime string `json:"start_time,omitempty"`
	// EndTime 视频创建的筛选结束时间
	EndTime string `json:"end_time,omitempty"`
	// ImageMode 素材类型，详见【附录-枚举值-素材类型】
	// 可选值: CREATIVE_IMAGE_MODE_VIDEO：横版视频,CREATIVE_IMAGE_MODE_VIDEO_VERTICAL：竖版视频
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// PackageID 根据视频模板id搜索，精确匹配，长度限制 50字
	PackageID string `json:"package_id,omitempty"`
	// PackageName 根据视频模板名称搜索，精确匹配 长度限制 50字
	PackageName string `json:"package_name,omitempty"`
}

VideoGetFilter 过滤条件

type VideoGetRequest added in v1.8.0 

type VideoGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *VideoGetFilter `json:"filtering,omitempty"`
	// Page 页码， 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量， 默认值: 10，最大 100
	PageSize int `json:"page_size,omitempty"`
}

VideoGetRequest 获取 DPA 商品库视频模板 API Request

func (VideoGetRequest) Encode added in v1.8.0 

func (r VideoGetRequest) Encode() string

Encode implement GetRequest interface

type VideoGetResponse added in v1.8.0 

type VideoGetResponse struct {
	model.BaseResponse
	// Data 返回值
	Data *VideoGetResponseData `json:"data,omitempty"`
}

VideoGetResponse 获取 DPA 商品库视频模板 API Response

type VideoGetResponseData added in v1.8.0 

type VideoGetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 商品视频模板列表
	List []Video `json:"list,omitempty"`
}

VideoGetResponseData 返回值

type VideoInfo added in v1.8.0 

type VideoInfo struct {
	// Height 视频高度
	Height int `json:"height,omitempty"`
	// Width 视频宽度
	Width int `json:"width,omitempty"`
	// ImageMode 视频类型，详见【附录-枚举值-素材类型】
	// 可选值: CREATIVE_IMAGE_MODE_VIDEO：横版视频,CREATIVE_IMAGE_MODE_VIDEO_VERTICAL：竖版视频
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// Status 视频状态，可选值: AVAILABLE：可用,UNAVAILABLE：不可用
	Status string `json:"status,omitempty"`
	// VideoID 视频id
	VideoID string `json:"video_id,omitempty"`
}

VideoInfo 商品库视频模板视频信息

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.