tools

package
v1.19.4 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package tools 工具相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionTextGetRequest added in v1.6.8 

type ActionTextGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// LandingType 推广类型
	// 允许值：APP，SHOP，LINK
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// AdvanceCreativeType 附加创意类型，详见枚举
	AdvancedCreativeType enum.AdvancedCreativeType `json:"advanced_creative_type,omitempty"`
	// Industry 广告主行业id，可以从获取行业接口进行获取
	Industry uint64 `json:"industry,omitempty"`
}

ActionTextGetRequest 行动号召字段内容获取 API Request

func (ActionTextGetRequest) Encode added in v1.6.8 

func (r ActionTextGetRequest) Encode() string

Encode implement GetRequest interface

type ActionTextGetResponse added in v1.6.8 

type ActionTextGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data []string `json:"data,omitempty"`
}

ActionTextGetResponse 行动号召字段内容获取 API Response

type AdQuality 

type AdQuality struct {
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// QualityScore 计划综合质量得分
	QualityScore float64 `json:"quality_score,omitempty"`
	// CtrScore 创意质量得分
	CtrScore float64 `json:"ctr_score,omitempty"`
	// WebScore 落地页响应得分
	WebScore float64 `json:"web_score,omitempty"`
	// CvrScore 落地页素材得分
	CvrScore float64 `json:"cvr_score,omitempty"`
}

AdQuality 广告质量度

type AdQualityGetRequest 

type AdQualityGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 广告id列表
	AdIDs []uint64 `json:"ad_ids,omitempty"`
}

AdQualityGetRequest 查询广告质量度 API Request

func (AdQualityGetRequest) Encode 

func (r AdQualityGetRequest) Encode() string

Encode implement GetRequest interface

type AdQualityGetResponse 

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

AdQualityGetResponse 查询广告质量度 API Response

type AdStatExtraInfo 

type AdStatExtraInfo struct {
	// AdID 计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// LearningPhase  学习期状态
	LearningPhase enum.LearningPhase `json:"learning_phase,omitempty"`
}

AdStatExtraInfo 广告计划学习期

type AdStatExtraInfoGetRequest 

type AdStatExtraInfoGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 广告id列表, 最多传100个广告计划id
	AdIDs []uint64 `json:"ad_ids,omitempty"`
}

AdStatExtraInfoGetRequest 查询广告计划学习期状态 API Request

func (AdStatExtraInfoGetRequest) Encode 

func (r AdStatExtraInfoGetRequest) Encode() string

Encode implement GetRequest interface

type AdStatExtraInfoGetResponse 

type AdStatExtraInfoGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data []AdStatExtraInfo `json:"data,omitempty"`
}

AdStatExtraInfoGetResponse 查询广告计划学习期状态 API Request

type AdminInfoRequest added in v1.5.11 

type AdminInfoRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Codes 行政区域编码列表
	Codes []string `json:"codes,omitempty"`
	// Language 语言类型;
	// ZH_CN表示常用名，如“北京”
	// ZH_CN_GOV表示官方全称，如“北京市”
	Language string `json:"language,omitempty"`
	// SubDistrict 行政区域层级。
	// NONE 当前层级
	// ONE_LEVEL下一级区域
	// TWO_LEVEL下二级区域
	// THREE_LEVEL下三级区域
	// FOUR_LEVEL下四级区域
	SubDistrict string `json:"sub_district,omitempty"`
}

AdminInfoRequest 获取行政信息 API Request

func (AdminInfoRequest) Encode added in v1.5.11 

func (r AdminInfoRequest) Encode() string

Encode implement GetRequest interface

type AdminInfoResponse added in v1.5.11 

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

AdminInfoResponse 获取行政信息 API Response

type AdminInfoResponseData added in v1.5.11 

type AdminInfoResponseData struct {
	// Version 行政信息版本号
	Version string `json:"version,omitempty"`
	// Districts 行政层级信息
	Districts []District `json:"districts,omitempty"`
}

AdminInfoResponseData json返回值

type AwemeAuthItem added in v1.8.11 

type AwemeAuthItem struct {
	// AuthType 授权类型
	AuthType enum.AwemeAuthType `json:"auth_type,omitempty"`
	// AwemeID 抖音号
	AwemeID string `json:"aweme_id,omitempty"`
	// AwemeName 抖音账号名称
	AwemeName string `json:"aweme_name,omitempty"`
	// AuthStatus 授权状态
	AuthStatus enum.AwemeAuthStatus `json:"auth_status,omitempty"`
	// SubStatus 授权子状态，返回值
	// INVALID_CANCEL: 主动操作解除授权、INVALID_EXPIRED: 授权期限已到、INVALID_REJECT: C端拒绝授权、INVALID_TIME_OUT: 超时未确认、RENEWING: 续期待确认、RENEW_FAIL: 续期申请失效、RENEW_SUCCESS: 续期成功
	SubStatus enum.AwemeAuthSubStatus `json:"sub_status,omitempty"`
	// StartTime 授权开始时间，格式为yyyy-MM-dd HH:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 授权结束时间，格式为yyyy-MM-dd HH:mm:ss
	EndTime string `json:"end_time,omitempty"`
	// VideoInfo 授权视频信息，若为单视频授权会返回
	VideoInfo *AwemeAuthVideo `json:"video_info,omitempty"`
}

type AwemeAuthListData added in v1.8.11 

type AwemeAuthListData struct {
	// List .
	List []AwemeAuthItem `json:"list,omitempty"`
	// PageInfo .
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

AwemeAuthListData .

type AwemeAuthListFilter added in v1.8.11 

type AwemeAuthListFilter struct {
	// AuthType 授权类型，可选值:
	// AWEME_ACCOUNT: 抖音号授权、VIDEO_ITEM: 单视频授权
	AuthType []enum.AwemeAuthType `json:"auth_type,omitempty"`
	// AuthStatus 授权状态， 可选值:
	// AUTHRIZED: 授权中、AUTHRIZING: 待授权确认、INVALID: 授权失效
	AuthStatus []enum.AwemeAuthStatus `json:"auth_status,omitempty"`
}

AwemeAuthListFilter 筛选条件

type AwemeAuthListRequest added in v1.8.11 

type AwemeAuthListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 筛选条件
	Filtering *AwemeAuthListFilter `json:"filtering,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 页面大小
	PageSize int `json:"page_size,omitempty"`
}

AwemeAuthListRequest 获取抖音授权关系

func (AwemeAuthListRequest) Encode added in v1.8.11 

func (r AwemeAuthListRequest) Encode() string

Encode implement GetRequest interface

type AwemeAuthListResponse added in v1.8.11 

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

AwemeAuthListResponse 获取抖音授权关系

type AwemeAuthVideo added in v1.8.11 

type AwemeAuthVideo struct {
	// ItemID 抖音视频ID
	ItemID uint64 `json:"item_id,omitempty"`
	// ImageMode 素材类型
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// VideoID 视频ID
	VideoID string `json:"video_id,omitempty"`
	// Title 视频名称
	Title string `json:"title,omitempty"`
	// AwemePlayURL 视频播放链接
	AwemePlayURL string `json:"aweme_play_url,omitempty"`
	// Duration 视频时长，单位为秒
	Duration float64 `json:"duration,omitempty"`
	// VideoCoverID 视频封面ID
	VideoCoverID string `json:"video_cover_id,omitempty"`
	// VideoCoverURL 视频封面链接
	VideoCoverURL string `json:"video_cover_url,omitempty"`
}

AwemeAuthVideo 授权视频信息，若为单视频授权会返回

type BidSuggest added in v1.6.8 

type BidSuggest struct {
	// SuggestedBid 建议出价
	SuggestedBid float64 `json:"suggested_bid,omitempty"`
	// BidHigh30 竞争力超过30%广告的高跑量出价
	BidHigh30 float64 `json:"bid_high_30,omitempty"`
	// BidHigh50 竞争力超过50%的计划（手动出价获取）
	BidHigh50 float64 `json:"bid_high_50,omitempty"`
	// BidHigh90 竞争力超过90%的计划（手动出价获取）
	BidHigh90 float64 `json:"bid_high_90,omitempty"`
	// SmartBidSuggestBudget 建议日预算（自动出价获取）
	SmartBidSuggestBudget float64 `json:"smart_bid_suggest_budget,omitempty"`
	// SmartBudgetRange 建议日预算范围（自动出价获取）
	SmartBudgetRange []float64 `json:"smart_budget_range,omitempty"`
	// SmartBidRange 预期成本范围（自动出价获取）
	SmartBidRange []float64 `json:"smart_bid_range,omitempty"`
}

BidSuggest 建议日预算及预期成本

type BidSuggestRequest added in v1.6.8 

type BidSuggestRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Pricing 出价类型，查看【附录-出价类型】
	Pricing enum.PricingType `json:"pricing,omitempty"`
	// CampaignID 广告组ID
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// AdID 广告ID，修改广告时需要传
	AdID uint64 `json:"ad_id,omitempty"`
	// BidMode 出价方式，手动&自动
	// 允许值："SUGGEST"、"AUTO_BID"
	// - 手动获取到的是建议出价
	// - 自动获取到的是建议日预算和预期成本
	BidMode string `json:"bid_mode,omitempty"`
	// BudgetMode 广告预算类型(创建后不可修改), 详见【附录-预算类型】
	// 允许值: "BUDGET_MODE_DAY","BUDGET_MODE_TOTAL"
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 广告预算(出价方式为CPC、CPM、CPV时，不少于100元；出价方式为OCPM、OCPC时，不少于300元。单次预算修改幅度不小于100元,日修改预算不超过20次)
	// 取值范围: "≥ 0"
	Budget float64 `json:"budget,omitempty"`
	// ScheduleType 广告投放时间类型, 详见【附录-广告投放时间类型】
	// 允许值:"SCHEDULE_FROM_NOW","SCHEDULE_START_END"
	ScheduleType enum.ScheduleType `json:"schedule_type,omitempty"`
	// FlowControlMode 广告投放速度类型, 详见【附录-广告投放速度类型】
	// 允许值: "FLOW_CONTROL_MODE_FAST","FLOW_CONTROL_MODE_SMOOTH"
	FlowControlMode enum.FlowControlMode `json:"flow_control_mode,omitempty"`
	// ConvertID 转化id，可通过【工具模块-OCPC广告创建转化查询】查询可用id
	ConvertID uint64 `json:"convert_id,omitempty"`
	// RetargetingType 定向人群包类型,详见【附录-定向人群包类型】,即将下线
	// 允许值: "RETARGETING_INCLUDE", "RETARGETING_EXCLUDE","RETARGETING_NONE"
	RetargetingType enum.RetargetingType `json:"retargeting_type,omitempty"`
	// RetargetingTags 当选择使用人群包定向时填写，内容为人群包id，即将下线
	RetargetingTags []uint64 `json:"retargeting_tags,omitempty"`
	// RetargetingTagsInclude 定向人群包列表（自定义人群），内容为人群包id。如果选择"同时定向与排除"，需传入retargeting_tags_include和retargeting_tags_exclude
	RetargetingTagsInclude []uint64 `json:"retargeting_tags_include,omitempty"`
	// RetargetingTagsExclude 排除人群包列表（自定义人群），内容为人群包id。如果选择"同时定向与排除"，需传入retargeting_tags_include和retargeting_tags_exclude
	RetargetingTagsExclude []uint64 `json:"retargeting_tags_exclude,omitempty"`
	// Gender 性别
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 年龄
	Age []enum.AudienceAge `json:"age,omitempty"`
	// AndroidOsv 最低安卓版本，当app_type为"APP_ANDROID"选填,其余情况不填,
	AndroidOsv string `json:"android_osv,omitempty"`
	// IosOsv 最低IOS版本，当app_type为"APP_IOS"选填,其余情况不填
	IosOsv string `json:"ios_osv,omitempty"`
	// Ac 网络类型
	Ac []string `json:"ac,omitempty"`
	// Carrier 运营商
	Carrier []enum.Carrier `json:"carrier,omitempty"`
	// DeviceBrand 手机品牌
	DeviceBrand []string `json:"device_brand,omitempty"`
	// ArticleCategory 文章分类
	ArticleCategory []string `json:"article_category,omitempty"`
	// ActivateType 用户首次激活时间, 详见【附录-用户首次激活时间】
	// 允许值:"WITH_IN_A_MONTH","ONE_MONTH_2_THREE_MONTH","THREE_MONTH_EAILIER"
	ActivateType []enum.ActivateType `json:"activate_type,omitempty"`
	// Platform 平台，当下载方式包含下载链接时，平台类型需与选择的下载链接类型对应，当下载方式不包含下载方式的时候，平台可多选。为保证投放效果,平台类型定向PC与移动端互斥
	Platform []enum.AudiencePlatform `json:"platform,omitempty"`
	// District 地域;取值: "CITY"省市, "COUNTY"区县, "BUSINESS_DISTRICT"商圈,"NONE"不限，省市传法："city": [12],"district": "CITY",区县的传法："city": [130102],"district": "COUNTY";暂不支持"海外"
	District enum.District `json:"district,omitempty"`
	// City 地域定向省市或者区县列表(当传递省份ID时,旗下市县ID可省略不传),当district为"CITY"或"COUNTY"时有值
	City []uint64 `json:"city,omitempty"`
	// BusinessIDs 商圈ID数组，district为"BUSINESS_DISTRICT"时有值
	BusinessIDs []uint64 `json:"business_ids,omitempty"`
	// LocationType 位置类型;取值：CURRENT正在该地区的用户，HOME居住在该地区的用户，TRAVEL到该地区旅行的用户，ALL该地区内的所有用户;当city和district有值时返回值
	LocationType enum.LocationType `json:"location_type,omitempty"`
	// AdTags （老版行为兴趣）兴趣分类,如果传"空数组"表示不限，如果"数组传0"表示系统推荐,如果按兴趣类型传表示自定义
	AdTags []uint64 `json:"ad_tags,omitempty"`
	// InterestTags （老版行为兴趣）兴趣关键词, 传入具体的词id，非兴趣词包id，可以通过词包相关接口或者兴趣关键词word2id接口获取词id，一个计划下最多创建1000个关键词。
	InterestTags []uint64 `json:"interest_tags,omitempty"`
	// AppBehaviorTarget （老版行为兴趣）APP行为; 取值：NONE不限，CATEGORY按分类，APP按APP
	AppBehaviorTarget string `json:"app_behavior_target,omitempty"`
	// AppCategory 老版行为兴趣）APP行为定向——按分类
	AppCategory []uint64 `json:"app_category,omitempty"`
	// AppIDs （老版行为兴趣）APP行为定向——按APP（请注意如果投放的是"应用下载-IOS"不支持设置APP行为定向，请勿传值。）可通过【工具-查询工具-查询应用信息】获取。当app_behavior_target为APP时有值
	AppIDs []uint64 `json:"app_ids,omitempty"`
	// SuperiorPopularityType 媒体定向;
	SuperiorPopularityType string `json:"superior_popularity_type,omitempty"`
	// FlowPackage 定向逻辑
	FlowPackage []uint64 `json:"flow_package,omitempty"`
	// ExcludeFlowPackage 排除定向逻辑
	ExcludeFlowPackage []uint64 `json:"exclude_flow_package,omitempty"`
	// IncludeCustomActions 包含人群包((DPA推广目的特有,格式举例[{"days": 7, "code": 1001},]， dpa_local_audience为1时有值; day可选范围:1, 7, 14, 28, 60, 90, 120, 180。
	IncludeCustomActions []interface{} `json:"include_custom_actions,omitempty"`
	// ExcludeCustomActions 排除人群包((DPA推广目的特有,格式举例{"days": 7, "code": 1002},]，day可选范围: 1, 7, 14, 28, 60, 90, 120, 180。
	ExcludeCustomActions []interface{} `json:"exclude_custom_actions,omitempty"`
}

BidSuggestRequest 建议日预算及预期成本 API Request

func (BidSuggestRequest) Encode added in v1.6.8 

func (r BidSuggestRequest) Encode() string

Encode implement GetRequest interface

type BidSuggestResponse added in v1.6.8 

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

BidSuggestResponse 建议日预算及预期成本 API Response

type CountryInfoRequest added in v1.6.8 

type CountryInfoRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Language 语言类型;
	// ZH_CN表示常用名，如“北京”
	// ZH_CN_GOV表示官方全称，如“北京市”
	Language string `json:"language,omitempty"`
}

CountryInfoRequest 查询国家/区域信息 API Request

func (CountryInfoRequest) Encode added in v1.6.8 

func (r CountryInfoRequest) Encode() string

Encode implement GetRequest interface

type CountryInfoResponse added in v1.6.8 

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

CountryInfoResponse 查询国家/区域信息 API Response

type CountryInfoResponseData added in v1.6.8 

type CountryInfoResponseData struct {
	// Districts 行政区域信息
	Districts []District `json:"districts,omitempty"`
}

CountryInfoResponseData json返回值

type District added in v1.5.11 

type District struct {
	// Name 行政区域名称
	Name string `json:"name,omitempty"`
	// Level 行政区域层级
	Level string `json:"level,omitempty"`
	// Code 中国大陆行政区域编码
	Code string `json:"code,omitempty"`
	// GeonameID 港澳台、国外行政区域编码
	GeonameID uint64 `json:"geoname_id,omitempty"`
	// SubDistricts 子行政层级信息
	SubDistricts []District `json:"sub_districts,omitempty"`
	// Description 行政区域类型
	// COUNTRY表示国家
	// STATE表示国家
	// REGION表示区域
	Description string `json:"description,omitempty"`
}

District 行政层级信息

type EstimateAudienceRequest added in v1.6.8 

type EstimateAudienceRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// RetargetingType 定向人群包类型,详见【附录-定向人群包类型】,即将下线
	// 允许值: "RETARGETING_INCLUDE", "RETARGETING_EXCLUDE","RETARGETING_NONE"
	RetargetingType enum.RetargetingType `json:"retargeting_type,omitempty"`
	// RetargetingTags 当选择使用人群包定向时填写，内容为人群包id，即将下线
	RetargetingTags []uint64 `json:"retargeting_tags,omitempty"`
	// RetargetingTagsInclude 定向人群包列表（自定义人群），内容为人群包id。如果选择"同时定向与排除"，需传入retargeting_tags_include和retargeting_tags_exclude
	RetargetingTagsInclude []uint64 `json:"retargeting_tags_include,omitempty"`
	// RetargetingTagsExclude 排除人群包列表（自定义人群），内容为人群包id。如果选择"同时定向与排除"，需传入retargeting_tags_include和retargeting_tags_exclude
	RetargetingTagsExclude []uint64 `json:"retargeting_tags_exclude,omitempty"`
	// Gender 性别
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 年龄
	Age []enum.AudienceAge `json:"age,omitempty"`
	// AndroidOsv 最低安卓版本，当app_type为"APP_ANDROID"选填,其余情况不填,
	AndroidOsv string `json:"android_osv,omitempty"`
	// IosOsv 最低IOS版本，当app_type为"APP_IOS"选填,其余情况不填
	IosOsv string `json:"ios_osv,omitempty"`
	// Ac 网络类型
	Ac []string `json:"ac,omitempty"`
	// Carrier 运营商
	Carrier []enum.Carrier `json:"carrier,omitempty"`
	// DeviceBrand 手机品牌
	DeviceBrand []string `json:"device_brand,omitempty"`
	// ArticleCategory 文章分类
	ArticleCategory []string `json:"article_category,omitempty"`
	// ActivateType 用户首次激活时间, 详见【附录-用户首次激活时间】
	// 允许值:"WITH_IN_A_MONTH","ONE_MONTH_2_THREE_MONTH","THREE_MONTH_EAILIER"
	ActivateType enum.ActivateType `json:"activate_type,omitempty"`
	// Platform 平台，当下载方式包含下载链接时，平台类型需与选择的下载链接类型对应，当下载方式不包含下载方式的时候，平台可多选。为保证投放效果,平台类型定向PC与移动端互斥
	Platform []enum.AudiencePlatform `json:"platform,omitempty"`
	// District 地域;取值: "CITY"省市, "COUNTY"区县, "BUSINESS_DISTRICT"商圈,"NONE"不限，省市传法："city": [12],"district": "CITY",区县的传法："city": [130102],"district": "COUNTY";暂不支持"海外"
	District enum.District `json:"district,omitempty"`
	// City 地域定向省市或者区县列表(当传递省份ID时,旗下市县ID可省略不传),当district为"CITY"或"COUNTY"时有值
	City []uint64 `json:"city,omitempty"`
	// BusinessIDs 商圈ID数组，district为"BUSINESS_DISTRICT"时有值
	BusinessIDs []uint64 `json:"business_ids,omitempty"`
	// LocationType 位置类型;取值：CURRENT正在该地区的用户，HOME居住在该地区的用户，TRAVEL到该地区旅行的用户，ALL该地区内的所有用户;当city和district有值时返回值
	LocationType enum.LocationType `json:"location_type,omitempty"`
	// AdTags （老版行为兴趣）兴趣分类,如果传"空数组"表示不限，如果"数组传0"表示系统推荐,如果按兴趣类型传表示自定义
	AdTags []uint64 `json:"ad_tags,omitempty"`
	// InterestTags （老版行为兴趣）兴趣关键词, 传入具体的词id，非兴趣词包id，可以通过词包相关接口或者兴趣关键词word2id接口获取词id，一个计划下最多创建1000个关键词。
	InterestTags []uint64 `json:"interest_tags,omitempty"`
	// AppBehaviorTarget （老版行为兴趣）APP行为; 取值：NONE不限，CATEGORY按分类，APP按APP
	AppBehaviorTarget string `json:"app_behavior_target,omitempty"`
	// AppCategory 老版行为兴趣）APP行为定向——按分类
	AppCategory []uint64 `json:"app_category,omitempty"`
	// AppIDs （老版行为兴趣）APP行为定向——按APP（请注意如果投放的是"应用下载-IOS"不支持设置APP行为定向，请勿传值。）可通过【工具-查询工具-查询应用信息】获取。当app_behavior_target为APP时有值
	AppIDs []uint64 `json:"app_ids,omitempty"`
	// SuperiorPopularityType 媒体定向;
	SuperiorPopularityType string `json:"superior_popularity_type,omitempty"`
	// FlowPackage 定向逻辑
	FlowPackage []uint64 `json:"flow_package,omitempty"`
	// ExcludeFlowPackage 排除定向逻辑
	ExcludeFlowPackage []uint64 `json:"exclude_flow_package,omitempty"`
	// IncludeCustomActions 包含人群包((DPA推广目的特有,格式举例[{"days": 7, "code": 1001},]， dpa_local_audience为1时有值; day可选范围:1, 7, 14, 28, 60, 90, 120, 180。
	IncludeCustomActions []interface{} `json:"include_custom_actions,omitempty"`
	// ExcludeCustomActions 排除人群包((DPA推广目的特有,格式举例{"days": 7, "code": 1002},]，day可选范围: 1, 7, 14, 28, 60, 90, 120, 180。
	ExcludeCustomActions []interface{} `json:"exclude_custom_actions,omitempty"`
}

EstimateAudienceRequest 查询受众预估结果 API Request

func (EstimateAudienceRequest) Encode added in v1.6.8 

func (r EstimateAudienceRequest) Encode() string

Encode implement GetRequest interface

type EstimateAudienceResponse added in v1.6.8 

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

EstimateAudienceResponse 查询受众预估结果 API Response

type EstimateAudienceResponseData added in v1.6.8 

type EstimateAudienceResponseData struct {
	// TouTiao 今日头条预估用户覆盖量结果
	TouTiao EstimateAudienceResult `json:"toutiao,omitempty"`
	// Aweme 抖音视频预估用户覆盖量结果
	Aweme EstimateAudienceResult `json:"aweme,omitempty"`
	// VideoApp 西瓜视频预估用户覆盖量结果
	VideoApp EstimateAudienceResult `json:"video_app,omitempty"`
	// Hotsoon 火山视频预估用户覆盖量结果
	Hotsoon EstimateAudienceResult `json:"hotsoon,omitempty"`
}

EstimateAudienceResponseData 受众预估结果

type EstimateAudienceResult added in v1.6.8 

type EstimateAudienceResult struct {
	// Num 覆盖量
	Num int64 `json:"num,omitempty"`
}

EstimateAudienceResult

type EstimatedPrice added in v1.3.0 

type EstimatedPrice struct {
	// UpperBound 建议出价上界，单位为元
	UpperBound float64 `json:"upper_bound,omitempty"`
	// LowerBound 建议出价下界，单位为元
	LowerBound float64 `json:"lower_bound,omitempty"`
	// CpcPrice 回填建议出价，单位为元
	CpcPrice float64 `json:"cpc_price,omitempty"`
}

EstimatedPrice 预估点击成本

type EstimatedPriceGetRequest added in v1.3.0 

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

EstimatedPriceGetRequest 获取预估点击成本 API Request

func (EstimatedPriceGetRequest) Encode added in v1.3.0 

func (r EstimatedPriceGetRequest) Encode() string

Encode implement GetRequest interface

type EstimatedPriceGetResponse added in v1.3.0 

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

EstimatedPriceGetResponse 获取预估点击成本 API Response

type GrayGetRequest added in v1.12.0 

type GrayGetRequest struct {
	// AdvertiserID 广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// GrayKeys 白名单能力key，目前仅支持单次查询1个白名单能力key
	GrayKeys []enum.GrayKey `json:"gray_keys,omitempty"`
	// 抖音号id
	// gray_keys = comm_roi 时，有效且必填
	AwemeIDs []uint64 `json:"aweme_ids,omitempty"`
}

GrayGetRequest 查询白名单能力 API Request

func (GrayGetRequest) Encode added in v1.12.0 

func (r GrayGetRequest) Encode() string

Encode implement GetRequest interface

type GrayGetResponse added in v1.12.0 

type GrayGetResponse struct {
	model.BaseResponse
	Data struct {
		// List 命中白名单请求
		List []GrayItem `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

GrayGetResponse 查询白名单能力 API Response

type GrayItem added in v1.12.0 

type GrayItem struct {
	// GrayKey 白名单能力的唯一key
	GrayKey string `json:"gray_key,omitempty"`
	// InGray 当前白名单能力是否已全量，true、false。对于已经全量的key，请不要再次查询
	InGray bool `json:"in_gray,omitempty"`
	// InWhitelist 是否命中白名单。0代表命中，1代表未命中
	InWhitelist model.Bool `json:"in_whitelist,omitempty"`
	// AwemeIDs 命中白名单的抖音号列表
	AwemeIDs []uint64 `json:"aweme_ids,omitempty"`
}

GrayItem 白名单

type Industry added in v1.3.0 

type Industry struct {
	// IndustryID 行业ID
	IndustryID uint64 `json:"industry_id,omitempty"`
	// IndustryName 名称
	IndustryName string `json:"industry_name,omitempty"`
	// Level 所在级别，1：一级行业、2：二级行业、3：三级行业
	Level int `json:"level,omitempty"`
	// FirstIndustryID 该行业的一级行业ID
	FirstIndustryID uint64 `json:"first_industry_id,omitempty"`
	// FirstIndustryName 该行业的一级行业名称
	FirstIndustryName string `json:"first_industry_name,omitempty"`
	// SecondIndustryID 该行业的二级行业ID
	SecondIndustryID uint64 `json:"second_industry_id,omitempty"`
	// SecondIndustryName 该行业的二级行业名称
	SecondIndustryName string `json:"second_industry_name,omitempty"`
	// ThirdIndustryID 该行业的三级行业ID
	ThirdIndustryID uint64 `json:"third_industry_id,omitempty"`
	// ThirdIndustryName 该行业的三级行业名称
	ThirdIndustryName string `json:"third_industry_name,omitempty"`
}

Industry 行业

type IndustryGetRequest added in v1.3.0 

type IndustryGetRequest struct {
	// Level 只获取某级别数据，1:第一级,2:第二级,3:第三级，默认都返回
	Level int `json:"level,omitempty"`
	// Type 可选值："ADVERTISER"，"AGENT"，"ADVERTISER"为原有广告3.0行业, "AGENT"为代理商行业获取，代理商行业level都为1
	Type string `json:"type,omitempty"`
}

IndustryGetRequest 获取行业列表 API Request

func (IndustryGetRequest) Encode added in v1.3.0 

func (r IndustryGetRequest) Encode() string

Encode implement GetRequest interface

type IndustryGetResponse added in v1.3.0 

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

IndustryGetResponse 获取行业列表 API Response

type IsSupportUniversalGetRequest added in v1.6.8 

type IsSupportUniversalGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// LandingType 广告组推广目的，详见【附录-推广目的类型】，允许值：
	// APP 应用推广、ARTICLE 头条文章推广、AWEME 抖音号推广、DPA 商品目录推广、GOODS 商品推广、LINK 销售线索收集、QUICK_APP 快应用、SHOP 电商店铺推广
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// ExternalAction 优化目标，可通过【获取优化目标】接口获取
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// DeepExternalAction 深度转化目标，可通过【获取优化目标】接口获取
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
	// DeepBidType 深度优化方式，允许值详见【附录-深度优化方式】
	DeepBidType enum.DeepBidType `json:"deep_bid_type,omitempty"`
}

IsSupportUniversalGetRequest 查询是否支持通投智选 API Request

type IsSupportUniversalGetResponse added in v1.6.8 

type IsSupportUniversalGetResponse struct {
	model.BaseResponse
	Data struct {
		IsSupportUniversal string `json:"is_support_universal,omitempty"`
	} `json:"data,omitempty"`
}

IsSupportUniversalGetResponse 查询是否支持通投智选 API Response

type PromotionCardRecommendTitleGetRequest added in v1.6.8 

type PromotionCardRecommendTitleGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划id，需要传入"advertiser_id"广告主id名下的计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// IndustryID 行业id，可通过【工具——查询工具——获取行业列表】来获取行业id，任何级别行业id都可以传入
	IndustryID uint64 `json:"industry_id,omitempty"`
	// TextType 推荐文案类型
	// 允许值："PROMOTION": 推广卖点"CARD_TITLE": 卡片标题"CALL_TO_ACTION": 行动号召
	TextType string `json:"text_type,omitempty"`
	// ExternalURL 落地页链接,可通过【建站管理】模块中的落地页获取接口来获取落地页链接
	ExternalURL string `json:"external_url,omitempty"`
	// ContentType 推广类型
	// 允许值："UNKNOWN"：未知 "DOWNLOAD"： 应用下载类 "LANDING"： 落地页类 "TABLE"：附加创意-表单 "CARD"： 附加创意-卡券 "CONSULT"： 附加创意-咨询 "PHONE"： 附加创意-电话 "GAME_PACKAGE"： 游戏礼包码 "GAME_FORM"： 游戏表单 "GAME_SUBSCRIBE"： 游戏预约
	// 默认值："UNKNOWN": 未知
	// 只对行动号召文案产生影响，系统会根据用户传入的推广类型枚举值来在返回文案中添加和推广类型风格一致的文案。
	ContentType string `json:"content_type,omitempty"`
}

PromotionCardRecommendTitleGetRequest 查询推广卡片推荐内容（新版） API Request

func (PromotionCardRecommendTitleGetRequest) Encode added in v1.6.8 

func (r PromotionCardRecommendTitleGetRequest) Encode() string

Encode implement GetRequest interface

type PromotionCardRecommendTitleGetResponse added in v1.6.8 

type PromotionCardRecommendTitleGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// List 推荐文案列表
		List []string `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

PromotionCardRecommendTitleGetResponse 查询推广卡片推荐内容（新版） API Response

type QuotaGetRequest added in v1.6.39 

type QuotaGetRequest struct {
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignType 广告组类型，FEED：信息流 SEARCH:搜索广告
	CampaignType enum.CampaignType `json:"campaign_type,omitempty"`
	// DeliveryRange
	DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"`
}

QuotaGetRequest 查询在投计划配额 API Request

func (QuotaGetRequest) Encode added in v1.6.39 

func (r QuotaGetRequest) Encode() string

Encode implement GetRequest interface

type QuotaGetResponse added in v1.6.39 

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

QuotaGetResponse 查询在投计划配额 API Response

type QuotaGetResult added in v1.6.39 

type QuotaGetResult struct {
	// UsedQuota 在投计划数
	UsedQuota int64 `json:"used_quota,omitempty"`
	// SumQuota 在投计划配额
	SumQuota int64 `json:"sum_quota,omitempty"`
	// InLearning 是否在学习期
	InLearning bool `json:"in_learning,omitempty"`
	// MaxCost 最高月消耗
	MaxCost float64 `json:"max_cost,omitempty"`
}

QuotaGetResult

type Region added in v1.3.0 

type Region struct {
	// ID
	ID uint64 `json:"id,omitempty"`
	// Name 名称
	Name string `json:"name,omitempty"`
	// ParentID 父级id
	ParentID uint64 `json:"parent_id,omitempty"`
	// RegionLevel 地域所在层级
	RegionLevel string `json:"region_level,omitempty"`
}

Region 地域

type RegionGetRequest added in v1.3.0 

type RegionGetRequest struct {
	// RegionType 地域类型，目前只支持：BUSINESS_DISTRICT(商圈);允许值:"BUSINESS_DISTRICT"
	RegionType string `json:"region_type,omitempty"`
	// RegionLevel 只获取某层级数据，详见【附录-地域层级】
	RegionLevel enum.RegionLevel `json:"region_level,omitempty"`
}

RegionGetRequest 获取地域列表 API Request

func (RegionGetRequest) Encode added in v1.3.0 

func (r RegionGetRequest) Encode() string

Encode implement GetRequest interface

type RegionGetResponse added in v1.3.0 

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

RegionGetResponse 获取地域列表 API Response

type SearchBidRatioGetRequest added in v1.8.11 

type SearchBidRatioGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告ID，修改广告时需要传
	AdID uint64 `json:"ad_id,omitempty"`
}

SearchBidRatioGetRequest 获取快投推荐出价系数 API Request

func (SearchBidRatioGetRequest) Encode added in v1.8.11 

func (r SearchBidRatioGetRequest) Encode() string

Encode implement GetRequest interface

type SearchBidRatioGetResponse added in v1.8.11 

type SearchBidRatioGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data struct {
		// Ratio 推荐的快投出价系数
		Ratio float64 `json:"ratio,omitempty"`
	} `json:"data,omitempty"`
}

SearchBidRatioGetResponse 获取快投推荐出价系数 API Response

Source Files

View all Source files

Directories

Path Synopsis
Package abtest AB实验工具
 Package abtest AB实验工具
Package adconvert 转化目标管理 API Models
 Package adconvert 转化目标管理 API Models
Package adpreview 广告预览相关API models
 Package adpreview 广告预览相关API models
v3
Package v3 广告升级版预览相关API models
 Package v3 广告升级版预览相关API models
Package adraise 一键起量相关API
 Package adraise 一键起量相关API
v3
Package appmanagement 应用管理相关API
 Package appmanagement 应用管理相关API
Package aweme 抖音达人
 Package aweme 抖音达人
Package clue 线索及建站工具API 相关models
 Package clue 线索及建站工具API 相关models
Package comment 评论管理
 Package comment 评论管理
Package creativeword 动态创意词包管理
 Package creativeword 动态创意词包管理
Package diagnosis 获取计划诊断信息
 Package diagnosis 获取计划诊断信息
v3
Package v3 获取计划诊断信息体验版
 Package v3 获取计划诊断信息体验版
Package interestaction 行为兴趣关键词管理
 Package interestaction 行为兴趣关键词管理
Package keywordsbidratio 账户优词提量
 Package keywordsbidratio 账户优词提量
Package landinggroup 程序化落地页管理 API models
 Package landinggroup 程序化落地页管理 API models
Package log 工具-查询工具-日志查询API models
 Package log 工具-查询工具-日志查询API models
Package nativeanchor 原生锚点
 Package nativeanchor 原生锚点
Package quickappmanagement 快应用管理相关 API
 Package quickappmanagement 快应用管理相关 API
Package site 橙子建站落地页管理 API models
 Package site 橙子建站落地页管理 API models
Package sitetemplate 橙子建站模版管理 API models
 Package sitetemplate 橙子建站模版管理 API models
Package taskraise 账户优选起量 API models
 Package taskraise 账户优选起量 API models
Package thirdsite 第三方落地页管理API models
 Package thirdsite 第三方落地页管理API models
Package union 穿山流量相关
 Package union 穿山流量相关
Package v3 升级版相关
 Package v3 升级版相关
Package wechat 微信小程序/小游戏管理
 Package wechat 微信小程序/小游戏管理

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.