project

Documentation

Overview

Package project 项目管理模块

Index

• type Audience
• type BudgetUpdateData
• type BudgetUpdateRequest
  • func (r BudgetUpdateRequest) Encode() []byte
• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type DeleteRequest
  • func (r DeleteRequest) Encode() []byte
• type DeliveryRange
• type DeliverySetting
• type Keyword
• type ListFilter
• type ListRequest
  • func (r ListRequest) Encode() string
• type ListResponse
• type ListResponseData
• type OptimizeGoal
• type Project
  • func (p Project) GetActionTrackURL() []string
  • func (p Project) GetID() uint64
  • func (p Project) GetOpenURL() string
  • func (p Project) IsProject() bool
• type RelatedProduct
• type StatusUpdateData
• type StatusUpdateRequest
  • func (r StatusUpdateRequest) Encode() []byte
• type TrackURLSetting
• type UpdateError
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte
• type UpdateResponse
• type UpdateResponseData

Types

type Audience

type Audience struct {
	// AudiencePackageID 定向包ID
	// 如果同时传定向包ID和自定义用户定向参数时，仅定向包中的定向生效
	AudiencePackageID uint64 `json:"audience_package_id,omitempty"`
	// District 地域类型，枚举值: CITY 省市、 COUNTY 区县、REGION 行政区域、OVERSEA 海外区域、NONE 不限
	District enum.District `json:"district,omitempty"`
	// Geolocation 从地图添加(地图位置)
	Geolocation []model.Geolocation `json:"geolocation,omitempty"`
	// RegionVersion 行政区域版本号
	RegionVersion string `json:"region_version,omitempty"`
	// City 地域定向省市或者区县列表，当district=CITY/COUNTY/REGION/OVERSEA时
	// district =CITY/COUNTY时，详见【附件-city.json】
	// district =REGION/OVERSEA时，通过【获取行政信息】接口获取
	City *[]uint64 `json:"city,omitempty"`
	// LocationType 位置类型
	// 枚举值：CURRENT正在该地区的用户，HOME居住在该地区的用户，TRAVEL到该地区旅行的用户，ALL该地区内的所有用户
	LocationType enum.LocationType `json:"location_type,omitempty"`
	// Gender 性别， 详见【附录-受众性别】
	Gender enum.AudienceGender `json:"gender,omitempty"`
	// Age 年龄， 详见【附录-受众年龄区间】
	Age *[]enum.AudienceAge `json:"age,omitempty"`
	// RetargetingTageInclude 定向人群包列表（自定义人群）
	RetargetingTagsInclude *[]uint64 `json:"retargeting_tags_include,omitempty"`
	// RetargetingTagsExclude 排除人群包列表（自定义人群）
	RetargetingTagsExclude *[]uint64 `json:"retargeting_tags_exclude,omitempty"`
	// InterestActionMode 行为兴趣，枚举值：UNLIMITED 不限、CUSTOM 自定义、 RECOMMEND系统推荐
	InterestActionMode enum.InterestActionMode `json:"interest_action_mode,omitempty"`
	// ActionScene 行为场景，枚举值：E-COMMERCE 电商互动行为、 NEWS 资讯互动行为、 APP APP推广互动行为行为场景
	ActionScene *[]enum.ActionScene `json:"action_scene,omitempty"`
	// ActionDays 用户发生行为天数，枚举值：7、 15、 30、 60、 90、 180、 365用户发生行为天数
	ActionDays int `json:"action_days,omitempty"`
	// ActionCategories 行为类目词，行为类目可以通过【工具-行为兴趣词管理-行为类目查询】获取行为类目词
	ActionCategories *[]uint64 `json:"action_categories,omitempty"`
	// ActionWords 行为关键词，行为类目可以通过【工具-行为兴趣词管理-行为关键词查询】获取行为关键词
	ActionWords *[]uint64 `json:"action_words,omitempty"`
	// InterestCategories 兴趣类目词
	InterestCategories *[]uint64 `json:"interest_categories,omitempty"`
	// InterestWords 兴趣关键词
	InterestWords *[]uint64 `json:"interest_words,omitempty"`
	// AwemeFanBehaviors 抖音达人互动用户行为类型, 详见【附录-抖音用户行为类型】
	AwemeFanBehaviors *[]enum.Behavior `json:"aweme_fan_behaviors,omitempty"`
	// AwemeFanTimeScope 抖音达人互动行为时间范围，枚举值：FIFTEEN_DAYS 15天、THIRTY_DAYS 30天、SIXTY_DAYS 60天
	AwemeFanTimeScope string `json:"aweme_fan_time_scope,omitempty"`
	// AwemeFanCategories 抖音达人分类ID列表，可通过【工具-抖音达人-查询抖音类目列表】接口获取
	AwemeFanCategories *[]uint64 `json:"aweme_fan_categories,omitempty"`
	// AwemeFanAccounts 抖音达人ID列表，可通过【工具-抖音达人-查询抖音类目下的推荐达人】接口获取。
	AwemeFanAccounts *[]uint64 `json:"aweme_fan_accounts,omitempty"`
	// SuperiorPopularityType 媒体定向，详见【附录-媒体定向】
	SuperiorPopularityType enum.SuperiorPopularityType `json:"superior_popularity_type,omitempty"`
	// FlowPackage 定向逻辑，可通过【工具-穿山甲流量包-获取穿山甲流量包】
	FlowPackage *[]uint64 `json:"flow_package,omitempty"`
	// ExcludeFlowPackage 排除定向逻辑，可通过【工具-穿山甲流量包-获取穿山甲流量包】
	ExcludeFlowPackage *[]uint64 `json:"exclude_flow_package,omitempty"`
	// Platform 投放平台列表，枚举值：ANDROID、IOS
	Platform *[]enum.AudiencePlatform `json:"platform,omitempty"`
	// AndroidOsv 最低安卓版本
	AndroidOsv string `json:"android_osv,omitempty"`
	// IosOsv 最低IOS版本
	IosOsv string `json:"ios_osv,omitempty"`
	// DeviceType 设备类型，枚举值：MOBILE、PAD
	DeviceType *[]string `json:"device_type,omitempty"`
	// Ac 网络类型, 详见【附录-受众网络类型】
	Ac *[]string `json:"ac,omitempty"`
	// Carrier 运营商, 详见【附录-受众运营商类型】
	Carrier *[]enum.Carrier `json:"carrier,omitempty"`
	// HideIfExists 过滤已安装，枚举值：UNLIMITED不限、FILTER 过滤、TARGETING 定向
	HideIfExists string `json:"hide_if_exists,omitempty"`
	// HideIfConverted 过滤已转化用户
	// 枚举值：NO_EXCLUDE 不限制、PROMOTION 广告、PROJECT 推广项目、ADVERTISER 广告账户、APP 应用、CUSTOMER 客户、ORGANIZATION 组织
	HideIfConverted string `json:"hide_if_converted,omitempty"`
	// ConvertedTimeDuration 过滤时间范围，详见 【附录-过滤时间范围】
	ConvertedTimeDuration string `json:"converted_time_duration,omitempty"`
	// FilterAwemeAbnormalActive 过滤高活跃用户，即过滤关注、点赞、评论行为高活跃的用户允许值：
	// ON 过滤
	// OFF不过滤（默认值）
	// 当marketing_goal= LIVE 且inventory_type非仅穿山甲时，支持该字段
	FilterAwemeAbnormalActive *model.OnOffInt `json:"filter_aweme_abnormal_active,omitempty"`
	// FilterAwemeFansCount 过滤高关注数用户，例如"filter_aweme_fans_count": 1000表示过滤粉丝数在1000以上的用户
	// 允许值：1000、500、200
	// 当marketing_goal= Live 且inventory_type非仅穿山甲时，支持该字段
	FilterAwemeFansCount int `json:"filter_aweme_fans_count,omitempty"`
	// 过滤自己的粉丝，允许值：
	// ON 过滤
	// OFF不过滤（默认值）
	// 当marketing_goal= Live 且inventory_type非仅穿山甲时，支持该字段
	FilterOwnAwemeFans *model.OnOffInt `json:"filter_own_aweme_fans,omitempty"`
	// DeviceBrand 手机品牌, 详见【附录-手机品牌】
	DeviceBrand *[]string `json:"device_brand,omitempty"`
	// LaunchPrice 手机价格，价格区间，最高11000（表示1w以上）
	LaunchPrice *[]int `json:"launch_price,omitempty"`
	// AutoExtendTargets 可放开定向，枚举值：AGE 年龄、REGION 地域、GENDER 性别、CUSTOM_AUDIENCE 自定人群-定向
	AutoExtendTargets *[]string `json:"auto_extend_targets,omitempty"`
}

Audience 定向设置

type BudgetUpdateData

type BudgetUpdateData struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// BudgetMode 允许值:
	// BUDGET_MODE_DAY日预算
	// BUDGET_MODE_INFINITE不限
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 预算，单位“元”，精度：两位小数。
	Budget float64 `json:"budget,omitempty"`
}

BudgetUpdateData 修改信息

type BudgetUpdateRequest

type BudgetUpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Data 批量修改，包含广告id和出价
	Data []BudgetUpdateData `json:"data,omitempty"`
}

BudgetUpdateRequest 更新项目预算 API Request

func (BudgetUpdateRequest) Encode

func (r BudgetUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Operation 计划状态，允许值: ENABLE开启（默认值）,DISABLE关闭
	Operation enum.OptStatus `json:"operation,omitempty"`
	// DeliveryMode 投放模式，允许值：MANUAL手动投放(默认值）、PROCEDURAL自动投放 自动投放仅支持landing_type=APP或MICRO_GAME
	// 当marketing_goal= LIVE时，仅支持MANUAL手动投放
	DeliveryMode enum.DeliveryMode `json:"delivery_mode,omitempty"`
	// LandingType 推广目的，枚举值：APP 应用推广、LINK 销售线索推广、MICRO_GAME小游戏
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// AppPromotionType 子目标，枚举值：DOWNLOAD 应用下载、LAUNCH 应用调用、RESERVE 预约下载
	AppPromotionType enum.AppPromotionType `json:"app_promotion_type,omitempty"`
	// MarketingGoal 营销场景，枚举值：VIDEO_AND_IMAGE 短视频/图片
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// AdType 广告类型，枚举值：ALL
	AdType enum.CampaignType `json:"ad_type,omitempty"`
	// Name 项目名称
	Name string `json:"name,omitempty"`
	// SearchBidRatio 出价系数
	SearchBidRatio float64 `json:"search_bid_ratio,omitempty"`
	// AudienceExtend 定向拓展
	AudienceExtend string `json:"audience_extend,omitempty"`
	// Keywords 搜索关键词列表
	Keywords []Keyword `json:"keywords,omitempty"`
	// RelatedProduct 关联产品投放相关
	RelatedProduct *RelatedProduct `json:"related_product,omitempty"`
	// DownloadURL 下载链接
	DownloadURL string `json:"download_url,omitempty"`
	// DownloadType 下载方式，枚举值：DOWNLOAD_URL 直接下载、EXTERNAL_URL 落地页下载
	DownloadType enum.DownloadType `json:"download_type,omitempty"`
	// DownloadMode 优先从系统应用商店下载（下载模式），枚举值：APP_STORE_DELIVERY 优先商店下载、 DEFAULT 默认下载
	DownloadMode enum.DownloadMode `json:"download_mode,omitempty"`
	// QuickAppId 快应用资产id ，从【查询快应用信息】接口获取，仅支持已通过审核的快应用资产
	QuickAppId uint64 `json:"quick_app_id,omitempty"`
	// LaunchType 调起方式，枚举值： DIRECT_OPEN 直接调起、EXTERNAL_OPEN 落地页调起
	LaunchType enum.LaunchType `json:"launch_type,omitempty"`
	// OpenURL Deeplink直达链接，landing_type = APP 且子目标为 LAUNCH 时有效且必填
	// 直达链接仅支持部分App唤起（点击唤起APP），点击创意将优先跳转App，再根据投放内容跳转相关链接
	OpenURL string `json:"open_url,omitempty"`
	// UlinkURL ulink直达链接，landing_type = APP 且子目标为LAUNCH 时有效 仅支持穿山甲广告位
	UlinkURL string `json:"ulink_url,omitempty"`
	// SubscribeURL 预约下载链接，landing_type = APP 且子目标为 RESERVE 时有效且必填
	SubscribeURL string `json:"subscribe_url,omitempty"`
	// AssetType 资产类型 landing_type = LINK 或SHOP时有效且必填
	AssetType enum.AssetType `json:"asset_type,omitempty"`
	// 小程序类型，landing_type = MICRO_GAME 时有效且必填
	// 允许值： WECHAT_GAME 微信小游戏、WECHAT_APP微信小程序、BYTE_GAME字节小游戏、BYTE_APP字节小程序
	MicroPromotionType enum.MicroPromotionType `json:"micro_promotion_type,omitempty"`
	// OptimizeGoal 优化目标
	OptimizeGoal *OptimizeGoal `json:"optimize_goal,omitempty"`
	// LandingPageStayTime 店铺停留时长，单位为毫秒，当external_action为AD_CONVERT_TYPE_STAY_TIME时有效且必填
	LandingPageStayTime enum.LandingPageStayTime `json:"landing_page_stay_time,omitempty"`
	// DeliveryRange 广告版位
	DeliveryRange *DeliveryRange `json:"delivery_range,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// TrackURLSetting 监测链接设置
	TrackURLSetting *TrackURLSetting `json:"track_url_setting,omitempty"`
}

CreateRequest 创建项目 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse

type CreateResponse struct {
	model.BaseResponse
	Data struct {
		// ProjectID 项目id
		ProjectID uint64 `json:"project_id,omitempty"`
	} `json:"data,omitempty"`
}

CreateResponse 创建项目 API Response

type DeleteRequest

type DeleteRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ProjectIDs 项目ID集合，list长度限制1～10
	ProjectIDs []uint64 `json:"project_ids,omitempty"`
}

DeleteRequest 批量删除项目 API Request

func (DeleteRequest) Encode

func (r DeleteRequest) Encode() []byte

Encode implement PostRequest interface

type DeliveryRange

type DeliveryRange struct {
	// InventoryCatalog 广告位大类，枚举值： MANUAL 首选媒体，UNIVERSAL_SMART 通投智选
	InventoryCatalog enum.InventoryCatalog `json:"inventory_catalog,omitempty"`
	// InventoryType 广告投放位置（首选媒体)
	InventoryType []enum.StatInventoryType `json:"inventory_type,omitempty"`
	// UnionVideoType 投放形式（穿山甲视频创意类型），枚举值：ORIGINAL_VIDEO 原生视频、REWARDED_VIDEO 激励视频、SPLASH_VIDEO 开屏视频
	UnionVideoType *enum.UnionVideoType `json:"union_video_type,omitempty"`
}

DeliveryRange 广告版位

type DeliverySetting

type DeliverySetting struct {
	// ScheduleType 投放时间类型，枚举值：SCHEDULE_FROM_NOW 从今天起长期投放、SCHEDULE_START_END 设置开始和结束日期
	ScheduleType enum.ScheduleType `json:"schedule_type,omitempty"`
	// StartTime 投放起始时间，如：2017-01-01 精确到天
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间，如：2017-01-01 精确到天
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时段
	ScheduleTime string `json:"schedule_time,omitempty"`
	// ProjectCustom 项目成本稳投，当ad_type=SEARCH&&bid_type=CUSTOM 稳定成本时有效，当dea有值时，不支持项目成本稳投
	// 允许值：
	// ON 开启（默认值），
	// OFF 不开启
	ProjectCustom string `json:"project_custom,omitempty"`
	// Bid 点击出价/展示出价，当delivery_mode = MANUAL&&项目成本稳投开启&&pricing=CPC时填写有效；取值范围：0.2-999
	Bid float64 `json:"bid,omitempty"`
	// DeepBidType 深度出价方式
	DeepBidType enum.DeepBidType `json:"deep_bid_type,omitempty"`
	// BidType 竞价策略，枚举值：CUSTOM 稳定成本、NO_BID 最大转化投放
	BidType enum.BidType `json:"bid_type,omitempty"`
	// BidSpeed 投放速度，允许值：BALANCE 匀速,FAST 加速
	BidSpeed enum.BidSpeed `json:"bid_speed,omitempty"`
	// BudgetMode 项目预算类型， 枚举值：BUDGET_MODE_INFINITE 不限、BUDGET_MODE_DAY 日预算
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 项目预算
	Budget float64 `json:"budget,omitempty"`
	// Pricing 计费方式，允许值：PRICING_CPM 按展示付费,PRICING_CPC 按点击付费,PRICING_OCPM 目标转化出价-按展示付费（默认值）,PRICING_OCPC 目标转化出价-按点击付费
	// 当ea=AD_CONVERT_TYPE_SHOW_OFF_NUM 展示量时：仅支持CPM；
	// 当ea= AD_CONVERT_TYPE_CLICK_NUM点击量时：仅支持CPC；
	// 当ea !=AD_CONVERT_TYPE_SHOW_OFF_NUM 展示量 或AD_CONVERT_TYPE_CLICK_NUM 点击量时，在固定支持oCPM的情况下，以下情况额外支持oCPC：1)首选媒体仅选择穿山甲 2)广告类型为搜索直投；
	// 当ad_type=SEARCH时，不支持PRICING_CPM
	Pricing enum.PricingType `json:"pricing,omitempty"`
	// CpaBid 目标转化出价/预期成本(注意：nobid不返回该字段)
	CpaBid float64 `json:"cpa_bid,omitempty"`
	// RoiGoal 深度转化ROI系数(注意：nobid不返回该字段)
	RoiGoal float64 `json:"roi_goal,omitempty"`
	// BudgetOptimizeSwitch 支持预算择优分配，枚举值： ON 开启，OFF 不开启
	BudgetOptimizeSwitch enum.BudgetOptimizeSwitch `json:"budget_optimize_switch,omitempty"`
}

DeliverySetting 投放设置

type Keyword

type Keyword struct {
	// Word 关键词
	Word string `json:"word,omitempty"`
	// BidType 出价类型。 允许值:FEED_TO_SEARCH 搜索快投
	BidType string `json:"bid_type,omitempty"`
	// MatchType 匹配类型，允许值: PHRASE短语匹配，EXTENSIVE广泛匹配，PRECISION精准匹配
	MatchType enum.KeywordMatchType `json:"match_type,omitempty"`
	// Bid 出价。取值范围：0.2至999.0。
	// 当pricing为PRICING_OCPC/PRICING_OCPM时，不支持出价
	Bid float64 `json:"bid,omitempty"`
}

Keyword 搜索关键词

type ListFilter

type ListFilter struct {
	// IDs 按广告项目ID过滤，范围为1-100
	IDs []uint64 `json:"ids,omitempty"`
	// DeliveryMode 投放模式，允许值：MANUAL手动投放、PROCEDURAL自动投放
	DeliveryMode enum.DeliveryMode `json:"delivery_mode,omitempty"`
	// LandingType 推广目的，允许值：APP 应用推广、LINK 销售线索推广、MICRO_GAME小游戏
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// AppPromotionType 子目标，允许值：DOWNLOAD 应用下载、LAUNCH 应用调用、RESERVE 预约下载
	AppPromotionType enum.AppPromotionType `json:"app_promotion_type,omitempty"`
	// MarketingGoal 营销场景，允许值：VIDEO_AND_IMAGE 短视频/图片
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// AdType 广告类型，允许值：ALL 所有广告
	AdType enum.CampaignType `json:"ad_type,omitempty"`
	// Name 广告项目名称，长度是1-50个字（两个英文字符占1个字，该字段采取模糊查询的方式）
	Name string `json:"name,omitempty"`
	// Status 广告项目状态过滤，允许值：
	// PROJECT_STATUS_ENABLE 启用
	// PROJECT_STATUS_DISABLE 暂停
	// PROJECT_STATUS_DELETE 删除
	// PROJECT_STATUS_ALL 所有包含已删除
	// PROJECT_STATUS_NOT_DELETE 所有不包含已删除
	// PROJECT_STATUS_BUDGET_EXCEED 项目超出预算
	// PROJECT_STATUS_BUDGET_PRE_OFFLINE_BUDGET 项目接近预算
	// PROJECT_STATUS_NOT_START 未达投放时间
	// PROJECT_STATUS_DONE 已完成
	// PROJECT_STATUS_NO_SCHEDULE 不在投放时段
	Status enum.ProjectStatus `json:"status,omitempty"`
	// ProjectCreateTime 项目创建时间，格式yyyy-mm-dd，表示过滤出当天创建的广告项目
	ProjectCreateTime string `json:"project_create_time,omitempty"`
	// ProjectModifyTime 项目更新时间，格式yyyy-mm-dd，表示过滤出当天更新的广告项目
	ProjectModifyTime string `json:"project_modify_time,omitempty"`
	// Pricing 按计费方式过滤，允许值：PRCING_OCPM OCPM
	Pricing enum.PricingType `json:"pricing,omitempty"`
	// InventoryType 按首选位置过滤，允许值
	// INVENTORY_FEED 今日头条
	// INVENTORY_VIDEO_FEED 西瓜视频
	// INVENTORY_AWEME_FEED 抖音短视频
	// INVENTORY_TOMATO_NOVEL 番茄小说
	// INVENTORY_UNION_SLOT 穿山甲
	// UNION_BOUTIQUE_GAME ohayoo精品游戏
	InventoryType enum.StatInventoryType `json:"inventory_type,omitempty"`
	// Platform 按平台过滤，允许值：IOS、ANDROID
	Platform enum.AudiencePlatform `json:"platform,omitempty"`
}

ListFilter 过滤条件

type ListRequest

type ListRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *ListFilter `json:"filtering,omitempty"`
	// Fields 查询字段集合，如果指定则应答结果仅返回指定字段
	// 可参考应答参数返回的指标字段（不支持audience下字段筛选）
	Fields []string `json:"fields,omitempty"`
	// Page 页数默认值: 1，page必须大于0
	Page int `json:"page,omitempty"`
	// PageSize 页面大小默认值:10，page_size范围为1-10
	PageSize int `json:"page_size,omitempty"`
}

ListRequest 获取项目列表 API Request

func (ListRequest) Encode

func (r ListRequest) Encode() string

Encode implement GetRequest interface

type ListResponse

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

ListResponse 获取项目列表 API Response

type ListResponseData

type ListResponseData struct {
	// List 项目列表
	List []Project `json:"list,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type OptimizeGoal

type OptimizeGoal struct {
	// AssetIDs 事件管理资产id
	AssetIDs []uint64 `json:"asset_ids,omitempty"`
	// ConvertID 转化跟踪id
	ConvertID uint64 `json:"convert_id,omitempty"`
	// ExternalAction 优化目标
	ExternalAction enum.AdConvertType `json:"external_action,omitempty"`
	// DeepExternalAction 深度转化目标
	DeepExternalAction enum.DeepExternalAction `json:"deep_external_action,omitempty"`
}

OptimizeGoal 优化目标

type Project

type Project struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DeliveryMode 投放模式，允许值：MANUAL手动投放、PROCEDURAL自动投放
	DeliveryMode enum.DeliveryMode `json:"delivery_mode,omitempty"`
	// LandingType 推广目的，枚举值：APP 应用推广、LINK 销售线索推广、MICRO_GAME小游戏
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// AppPromotionType 子目标，枚举值：DOWNLOAD 应用下载、LAUNCH 应用调用、RESERVE 预约下载
	AppPromotionType enum.AppPromotionType `json:"app_promotion_type,omitempty"`
	// MarketingGoal 营销场景，枚举值：VIDEO_AND_IMAGE 短视频/图片
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// AdType 广告类型，枚举值：ALL
	AdType enum.CampaignType `json:"ad_type,omitempty"`
	// OptStatus 目标操作，枚举值：ENABLE 启用项目、DISABLE暂停项目
	OptStatus enum.OptStatus `json:"opt_status,omitempty"`
	// Name 项目名称
	Name string `json:"name,omitempty"`
	// ProjectCreateTime 项目创建时间，格式yyyy-MM-dd HH:mm:ss
	ProjectCreateTime string `json:"project_create_time,omitempty"`
	// ProjectModifyTime 项目更新时间，格式yyyy-MM-dd HH:mm:ss
	ProjectModifyTime string `json:"project_modify_time,omitempty"`
	// Status 项目状态
	Status enum.ProjectStatus `json:"status,omitempty"`
	// Pricing 出价方式
	Pricing enum.PricingType `json:"pricing,omitempty"`
	// PackageName 应用包名
	PackageName string `json:"package_name,omitempty"`
	// AppName 应用名
	AppName string `json:"app_name,omitempty"`
	// FeedDeliverySearch 搜索快投关键词功能，HAS_OPEN:启用，DISABLED:未启用
	FeedDeliverySearch enum.FeedDeliverySearch `json:"feed_delivery_search,omitempty"`
	// SearchBidRatio 出价系数
	SearchBidRatio float64 `json:"search_bid_ratio,omitempty"`
	// AudienceExtend 定向拓展
	AudienceExtend string `json:"audience_extend,omitempty"`
	// Keywords 搜索关键词列表
	Keywords []Keyword `json:"keywords,omitempty"`
	// RelatedProduct 关联产品投放相关
	RelatedProduct *RelatedProduct `json:"related_product,omitempty"`
	// AssetType 资产类型
	AssetType enum.AssetType `json:"asset_type,omitempty"`
	// QuickAppId 快应用资产id
	QuickAppId uint64 `json:"quick_app_id,omitempty"`
	// MicroPromotionType 小程序类型
	MicroPromotionType enum.MicroPromotionType `json:"micro_promotion_type,omitempty"`
	// DownloadURL 下载链接
	DownloadURL string `json:"download_url,omitempty"`
	// DownloadType 下载方式，枚举值：DOWNLOAD_URL 直接下载、EXTERNAL_URL 落地页下载
	DownloadType enum.DownloadType `json:"download_type,omitempty"`
	// DownloadMode 优先从系统应用商店下载（下载模式），枚举值：APP_STORE_DELIVERY 优先商店下载、 DEFAULT 默认下载
	DownloadMode enum.DownloadMode `json:"download_mode,omitempty"`
	// LaunchType 调起方式，枚举值： DIRECT_OPEN 直接调起、EXTERNAL_OPEN 落地页调起
	LaunchType enum.LaunchType `json:"launch_type,omitempty"`
	// OpenURL Deeplink直达链接
	OpenURL string `json:"open_url,omitempty"`
	// UlinkURL ulink直达链接
	UlinkURL string `json:"ulink_url,omitempty"`
	// SubscribeURL 预约下载链接
	SubscribeURL string `json:"subscribe_url,omitempty"`
	// OptimizeGoal 优化目标
	OptimizeGoal *OptimizeGoal `json:"optimize_goal,omitempty"`
	// LandingPageStayTime 店铺停留时长，单位为毫秒
	LandingPageStayTime int `json:"landing_page_stay_time,omitempty"`
	// DeliveryRange 广告版位
	DeliveryRange *DeliveryRange `json:"delivery_range,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// TrackURLSetting 监测链接设置
	TrackURLSetting *TrackURLSetting `json:"track_url_setting,omitempty"`
}

Project 项目

func (Project) GetActionTrackURL

func (p Project) GetActionTrackURL() []string

func (Project) GetID

func (p Project) GetID() uint64

func (Project) GetOpenURL

func (p Project) GetOpenURL() string

func (Project) IsProject

func (p Project) IsProject() bool

type RelatedProduct

type RelatedProduct struct {
	// ProductSetting 商品库设置，枚举值：SINGLE 启用SDPA、NO_MAP不启用
	ProductSetting enum.ProductSetting `json:"product_setting,omitempty"`
	// ProductPlatformID 商品库ID
	ProductPlatformID uint64 `json:"product_platform_id,omitempty"`
	// ProductID 产品ID
	ProductID string `json:"product_id,omitempty"`
}

RelatedProduct 关联产品投放相关

type StatusUpdateData

type StatusUpdateData struct {
	// ProjectID 广告项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// OptStatus  操作ENABLE启 用广告、DISABLE 暂停广告
	OptStatus enum.OptStatus `json:"opt_status,omitempty"`
}

type StatusUpdateRequest

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

StatusUpdateRequest 更新项目状态 API Request

func (StatusUpdateRequest) Encode

func (r StatusUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type TrackURLSetting

type TrackURLSetting struct {
	// TrackURLType 监测链接类型，区分使用监测链接组或者自定义链接
	// 枚举值：CUSTOM 自定义链接、GROUP_ID 监测链接组
	TrackURLType string `json:"track_url_type,omitempty"`
	// TrackURLGroupID 监测链接组id
	TrackURLGroupID uint64 `json:"track_url_group_id,omitempty"`
	// TrackURL 展示（监测链接）
	TrackURL *[]string `json:"track_url,omitempty"`
	// ActionTrackURL 点击（监测链接）
	ActionTrackURL *[]string `json:"action_track_url,omitempty"`
	// VideoPlayEffectiveTrackURL 视频有效播放（监测链接）
	VideoPlayEffectiveTrackURL *[]string `json:"video_play_effective_track_url,omitempty"`
	// VideoPlayDoneTrackURL 视频播完（监测链接）
	VideoPlayDoneTrackURL *[]string `json:"video_play_done_track_url,omitempty"`
	// VideoPlayFirstTrackURL 视频开始播放（监测链接）
	VideoPlayFirstTrackURL *[]string `json:"video_play_first_track_url,omitempty"`
	// SendType 数据发送方式，枚举值：SERVER_SEND 服务器端上传, CLIENT_SEND 客户端上传
	SendType enum.SendType `json:"send_type,omitempty"`
}

TrackURLSetting 监测链接设置

type UpdateError

type UpdateError struct {
	// ProjectID 广告项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// ObjectType 错误对象类型
	// 枚举值： BASIC 广告基本设置、MATERIAL 广告素材组合、BUDGET 广告预算
	ObjectType string `json:"object_type,omitempty"`
	// ErrorCode 错误信息
	ErrorCode int `json:"error_code,omitempty"`
	// ErrorMessage 错误信息
	ErrorMessage string `json:"error_message"`
}

UpdateError 更新失败的广告项目

type UpdateRequest

type UpdateRequest struct {
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// Name 项目名称
	Name string `json:"name,omitempty"`
	// DownloadMode 优先从系统应用商店下载（下载模式），枚举值：APP_STORE_DELIVERY 优先商店下载、 DEFAULT 默认下载
	DownloadMode enum.DownloadMode `json:"download_mode,omitempty"`
	// OpenURL Deeplink直达链接
	OpenURL string `json:"open_url,omitempty"`
	// UlinkURL ulink直达链接
	UlinkURL string `json:"urlink_url,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
	// DeliverySetting 投放设置
	DeliverySetting *DeliverySetting `json:"delivery_setting,omitempty"`
	// TrackURLSetting 监测链接设置
	TrackURLSetting *TrackURLSetting `json:"track_url_setting,omitempty"`
}

UpdateRequest 更新项目 API Request

func (UpdateRequest) Encode

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

type UpdateResponse

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

UpdateResponse 更新计划API Response

type UpdateResponseData

type UpdateResponseData struct {
	// ProjectID 广告项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// PromotionIDs 广告项目ID集合
	ProjectIDs []uint64 `json:"project_ids,omitempty"`
	// Errors 更新失败的广告计划列表
	Errors []UpdateError `json:"errors,omitempty"`
}

UpdateResponseData json返回值