Documentation ¶
Overview ¶
Package ad 广告计划相关API models
Index ¶
- type Audience
- type CreateRequest
- type CreateResponse
- type DpaProductTarget
- type GetFiltering
- type GetRequest
- type GetResponse
- type GetResponseData
- type GetResponseList
- type UpdateBidRequest
- type UpdateBidRequestList
- type UpdateBudgetRequest
- type UpdateBudgetRequestList
- type UpdateError
- type UpdateRequest
- type UpdateResponse
- type UpdateResponseData
- type UpdateStatusRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Audience ¶
type Audience struct { // District 地域;取值: "CITY"省市, "COUNTY"区县, "BUSINESS_DISTRICT"商圈,"NONE"不限,省市传法:"city": [12],"district": "CITY",区县的传法:"city": [130102],"district": "COUNTY";暂不支持"海外" District string `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"` // Geolocation 从地图添加(地图位置) Geolocation []model.Geolocation `json:"geolocation,omitempty"` // LocationType 位置类型;取值:CURRENT正在该地区的用户,HOME居住在该地区的用户,TRAVEL到该地区旅行的用户,ALL该地区内的所有用户;当city和district有值时返回值 LocationType string `json:"location_type,omitempty"` // Gender 性别 Gender enum.AudienceGender `json:"gender,omitempty"` // Age 年龄 Age []enum.AudienceAge `json:"age,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"` // InterestActionMode 行为兴趣;取值:"UNLIMITED"不限,"CUSTOM"自定义,"RECOMMEND"系统推荐。若与自定义人群同时使用,系统推荐("RECOMMEND")不生效;仅推广范围为默认时可填,且不可与老版行为兴趣定向同时填写,否则会报错 InterestActionMode string `json:"interest_action_mode,omitempty"` // ActionScene 行为场景 ActionScene []enum.ActionScene `json:"action_scene,omitempty"` // ActionDays 用户发生行为天数,当interest_action_mode传CUSTOM时有效 ActionDays uint `json:"action_days,omitempty"` // ActionCategories 行为类目词,当interest_action_mode传CUSTOM时有效 ActionCategories []uint64 `json:"action_categories,omitempty"` // ActionWords 行为关键词,当interest_action_mode传CUSTOM时有效 ActionWords []uint64 `json:"action_words,omitempty"` // InterestCategories 兴趣类目词,当interest_action_mode传CUSTOM时有效 InterestCategories []uint64 `json:"Interest_categories,omitempty"` // InterestWords 兴趣关键词, 传入具体的词id,非兴趣词包id,可以通过词包相关接口或者兴趣关键词word2id接口获取词id,一个计划下最多创建1000个关键词。当interest_action_mode传CUSTOM时有效 InterestWords []uint64 `json:"interest_words,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"` // AwemeFanBehavior 抖音达人互动用户行为类型 AwemeFanBehavior []enum.Behavior `json:"aweme_fan_behavior,omitempty"` // AwemeFanCategories 抖音达人分类ID列表,与aweme_fan_behaviors同时设置才会生效(抖音达人定向) AwemeFanCategories []uint64 `json:"aweme_fan_categories,omitempty"` // AwemeFanAccounts 抖音达人ID列表,与aweme_fan_behaviors同时设置才会生效(抖音达人定向) AwemeFanAccounts []uint64 `json:"aweme_fan_accounts,omitempty"` // AwemeFansNumbers (抖音号推广特有)账号粉丝相似人群(添加抖音账号,会将广告投放给对应账号的相似人群粉丝) AwemeFansNumbers []int64 `json:"aweme_fans_numbers,omitempty"` // FilterAwemeAbnormalActive (抖音号推广特有)过滤高活跃用户; 取值:0表示不过滤,1表示过滤 FilterAwemeAbnormalActive int `json:"filter_aweme_abnormal_active,omitempty"` // FilterAwemeFansCount (抖音号推广特有)过滤高关注数用户,例如"filter_aweme_fans_count": 1000表示过滤粉丝数在1000以上的用户 FilterAwemeFansCount int64 `json:"filter_aweme_fans_count,omitempty"` // FilterOwnAwemeFans (抖音号推广特有)过滤自己的粉丝; 取值:0表示不过滤,1表示过滤 FilterOwnAwemeFans int `json:"filter_own_aweme_fans,omitempty"` // SuperiorPopularityType 媒体定向; SuperiorPopularityType string `json:"superior_popularity_type,omitempty"` // FlowPackage 定向逻辑 FlowPackage []uint64 `json:"flow_package,omitempty"` // ExcludeFlowPackage 排除定向逻辑 ExcludeFlowPackage []uint64 `json:"exclude_flow_package,omitempty"` // Platform 平台,当下载方式包含下载链接时,平台类型需与选择的下载链接类型对应,当下载方式不包含下载方式的时候,平台可多选。为保证投放效果,平台类型定向PC与移动端互斥 Platform []enum.AudiencePlatform `json:"platform,omitempty"` // AndroidOsv 最低安卓版本,当app_type为"APP_ANDROID"选填,其余情况不填, AndroidOsv string `json:"android_osv,omitempty"` // IosOsv 最低IOS版本,当app_type为"APP_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"` // ActivateType 新用户(新用户使用头条的时间) ActivateType []enum.ActivateType `json:"activate_type,omitempty"` // ArticleCategory 文章分类 ArticleCategory []string `json:"article_category,omitempty"` // DeviceBrand 手机品牌 DeviceBrand []string `json:"device_brand,omitempty"` // LauchPrice 手机价格,传入价格区间,最高传入11000(表示1w以上);传值示例 "launch_price": [2000, 11000],表示2000元以上; LaunchPrice []int `json:"launch_price,omitempty"` // AutoExtendEnabled 是否启用智能放量。取值是:0、1。缺省为 0。 AutoExtendEnabled int `json:"auto_extend_enabled,omitempty"` // AutoExtendTarget 可放开定向。当auto_extend_enabled=1 时选填。详见:【附录-可开放定向】。缺省为全不选。 AutoExtendTarget []string `json:"auto_extend_targets,omitempty"` }
Audience 受众
type CreateRequest ¶ added in v1.3.0
type CreateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // CampaignID 广告组ID。注意:广告组ID要求属于广告主ID,且是非删除广告组ID CampaignID uint64 `json:"campaign_id,omitempty"` // Name 广告计划名称,长度为1-100个字符,其中1个中文字符算2位 Name string `json:"name,omitempty"` // Operation 计划状态; 默认值: "enable"开启状态; 允许值: "enable"开启,"disable"关闭 Operation string `json:"operation,omitempty"` // DeliveryRange 投放范围。详见【附录-广告投放范围】;默认值: "DEFAULT"默认; 允许值: DEFAULT 默认, UNION 穿山甲、UNIVERSAL 通投智选; 对于投放范围的解释可参考【广告计划】 DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"` // UnionVideoType 投放形式(穿山甲视频创意类型),当delivery_range为"UNION"时必填。详见【附录-穿山甲视频创意类型】;默认值: ORIGINAL_VIDEO原生; 允许值: ORIGINAL_VIDEO原生, REWARDED_VIDEO激励视频,SPLASH_VIDEO开屏 UnionVideoType string `json:"union_video_type,omitempty"` // DownloadType 下载方式; 默认值:DOWNLOAD_URL下载链接; 可选值:DOWNLOAD_URL下载链接、EXTERNAL_URL落地页链接 DownloadType string `json:"download_type,omitempty"` // DownloadUrl 应用下载方式,推广目的为APP时有值。返回值:DOWNLOAD_URL下载链接,QUICK_APP_URL快应用+下载链接,EXTERNAL_URL落地页链接 DownloadUrl string `json:"download_url,omitempty"` // ExternalUrl 落地页链接(支持橙子建站落地页);对于转化量为目标的计划如OCPM计划不允许更改,非转化为目标的计划如CPC、CPM计划可更改; 获取橙子建站落地页可参考【橙子建站落地页管理】 ExternalUrl string `json:"external_url,omitempty"` // AppType 下载类型,当推广类型为应用推广且download_type为DOWNLOAD_URL或者QUICK_APP_URL时或当推广类型为DPA(商品目录推广)且dpa_adtype为DPA_APP有值 AppType string `json:"app_type,omitempty"` // Package 应用包名,当推广类型为应用推广且download_type为DOWNLOAD_URL时或当推广类型为DPA(商品目录推广)且dpa_adtype为DPA_APP有值 Package string `json:"package,omitempty"` // DownloadMode 优先从系统应用商店下载(下载模式);允许值:APP_STORE_DELIVERY(仅安卓应用下载支持)、 DEFAULT当应用下载时,默认default下载,可选用APP_STORE_DELIVERY(应用商店直投),选择后,将优先跳转目标应用对应手机系统应用商店安装详情页,跳转失败则使用下载链接下载。;请确保投放的应用在应用商店内已上架;详情请参照【帮助中心】 DownloadMode string `json:"download_mode,omitempty"` // ConvertID 转化目标, 当出价方式为"OCPM"时必填,当出价方式为CPC和CPM时非必填。可通过【工具-转化目标管理-查询计划可用转化id】查询可用id ConvertID uint64 `json:"convert_id,omitempty"` // OpenUrl 直达链接(点击唤起APP)直达链接仅支持部分App唤起,点击创意将优先跳转App,再根据投放内容跳转相关链接 OpenUrl string `json:"open_url,omitempty"` // Ulink 直达备用链接,仅支持穿山甲广告位(不支持搜索广告) Ulink string `json:"ulink,omitempty"` // PromotionType 投放内容,允许值:LIVE:直播; AWEME_HOME_PAGE:抖音主页(默认);LANDING_PAGE_LINK:落地页 PromotionType string `json:"promotion_type,omitempty"` // AwemeAccount 抖音号,可从【获取绑定抖音号】接口获取,默认取绑定的第一个抖音号 AwemeAccount string `json:"aweme_account,omitempty"` // ExternalActions 转化类型列表,当出价方式为OCPM时必填,当出价方式为CPC和CPM时非必填。; 可通过【工具-转化目标管理-查询计划可用转化目标】查询可用external_action ExternalActions []string `json:"external_actions,omitempty"` // ProductPlatformID 商品目录ID(ID由【DPA商品广告-查询商品库】 得到) ProductPlatformID uint64 `json:"product_platform_id,omitempty"` // ProductID 商品ID,当广告组商品类型选择SDPA时必填(ID由【DPA商品广告-获取DPA商品库商品列表】 得到,创建后不可修改) ProductID string `json:"product_id,omitempty"` // CategoryType 商品目录投放范围,当广告组商品类型选择 DPA 多商品时可修改;允许值:NONE不限,"CATEGORY"选择分类,"PRODUCT"指定商品 CategoryType string `json:"category_type,omitempty"` // DpaCategories 分类列表,category_type更新为"CATEGORY"时可修改,由【DPA商品广告-获取DPA分类】 得到限制个数1~100 DpaCategories []uint64 `json:"dpa_categories,omitempty"` // DpaProducts 商品列表,category_type更新为"PRODUCT"时可修改,由【DPA商品广告-获取DPA商品库商品列表】 得到;限制个数1~100 DpaProducts []uint64 `json:"dpa_products,omitempty"` // DpaProductTargets 自定义筛选条件(商品投放条件)。用于圈定商品投放范围,结合商品库字段搭配判断条件,圈定商品投放范围。 DpaProductTarget []DpaProductTarget `json:"dpa_product_targets,omitempty"` // DpaAdtype DPA广告类型,允许值: "DPA_LINK"落地页, "DPA_APP"应用下载 DpaAdtype string `json:"dpa_adtype,omitempty"` // ParamsType 链接类型(落地页),当dpa_adtype为"DPA_LINK"时有值,取值: "DPA"商品库所含链接, "CUSTOM"自定义链接 ParamsType string `json:"params_type,omitempty"` // DpaExternalUrlField 落地页链接字段选择,当params_type为"DPA"时有值 DpaExternalUrlField string `json:"dpa_external_url_field,omitempty"` // DpaExternalUrls 落地页链接地址列表,当params_type为"CUSTOM"时有值 DpaExternalUrls []string `json:"dpa_external_urls,omitempty"` // DpaOpenUrlType 直达链接类型,取值: "NONE"不启用, "DPA"商品库所含链接, "CUSTOM"自定义链接商品库链接对应商品库内调起字段。 DpaOpenUrlType string `json:"dpa_open_url_type,omitempty"` // DpaOpenUrlField 直达链接字段选择,当dpa_open_url_type为"DPA"时有值 DpaOpenUrlField string `json:"dpa_open_url_field,omitempty"` // DpaOpenUrls 直达链接地址列表,当dpa_open_url_type为"CUSTOM"时有值 DpaOpenUrls []string `json:"dpa_open_urls,omitempty"` // ExternalUrlParams 落地页检测参数(DPA推广目的特有,在填写的参数后面添加"=urlencode(开放平台提供的h5链接地址)",其中urlencode(开放平台提供的h5链接地址)替换为商品库中的h5地址encode的结果) ExternalUrlParams string `json:"external_url_params,omitempty"` // OpenUrlParams 直达链接检测参数(DPA推广目的特有,在“产品库中提取的scheme地址"后面追加填写的参数) OpenUrlParams string `json:"open_url_params,omitempty"` // FeedDeliverySearch 搜索快投关键词,HAS_OPEN:启用,DISABLE:不启用 FeedDeliverySearch string `json:"feed_delivery_search,omitempty"` // IntelligentFlowSwitch 智能流量开关,ON:开启,OFF:关闭 IntelligentFlowSwitch string `json:"intelligent_flow_switch,omitempty"` // AudiencePackageID 定向包ID AudiencePackageID uint64 `json:"audience_package_id,omitempty"` // District 地域;取值: "CITY"省市, "COUNTY"区县, "BUSINESS_DISTRICT"商圈,"NONE"不限,省市传法:"city": [12],"district": "CITY",区县的传法:"city": [130102],"district": "COUNTY";暂不支持"海外" District string `json:"district,omitempty"` // RegionVersion 行政区域版本号。通过[【获取行政信息】]https://open.oceanengine.com/doc/index.html?key=ad&type=api&id=1709606596424718)接口获取; district =REGION/OVERSEA时必填 RegionVersion string `json:"region_version,omitempty"` // City 地域定向省市或者区县列表(当传递省份ID时,旗下市县ID可省略不传),当district为"CITY"或"COUNTY"时有值 City []uint64 `json:"city,omitempty"` // BusinessIDs 商圈ID数组,district为"BUSINESS_DISTRICT"时有值 BusinessIDs []uint64 `json:"business_ids,omitempty"` // Geolocation 从地图添加(地图位置) Geolocation []model.Geolocation `json:"geolocation,omitempty"` // LocationType 位置类型;取值:CURRENT正在该地区的用户,HOME居住在该地区的用户,TRAVEL到该地区旅行的用户,ALL该地区内的所有用户;当city和district有值时返回值 LocationType string `json:"location_type,omitempty"` // Gender 性别 Gender enum.AudienceGender `json:"gender,omitempty"` // Age 年龄 Age []enum.AudienceAge `json:"age,omitempty"` // Carreer 职业选项,详见【附录-职业】 Career []string `json:"career,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"` // InterestActionMode 行为兴趣;取值:"UNLIMITED"不限,"CUSTOM"自定义,"RECOMMEND"系统推荐。若与自定义人群同时使用,系统推荐("RECOMMEND")不生效;仅推广范围为默认时可填,且不可与老版行为兴趣定向同时填写,否则会报错 InterestActionMode string `json:"interest_action_mode,omitempty"` // ActionScene 行为场景 ActionScene []enum.ActionScene `json:"action_scene,omitempty"` // ActionDays 用户发生行为天数,当interest_action_mode传CUSTOM时有效 ActionDays uint `json:"action_days,omitempty"` // ActionCategories 行为类目词,当interest_action_mode传CUSTOM时有效 ActionCategories []uint64 `json:"action_categories,omitempty"` // ActionWords 行为关键词,当interest_action_mode传CUSTOM时有效 ActionWords []uint64 `json:"action_words,omitempty"` // InterestCategories 兴趣类目词,当interest_action_mode传CUSTOM时有效 InterestCategories []uint64 `json:"Interest_categories,omitempty"` // InterestWords 兴趣关键词, 传入具体的词id,非兴趣词包id,可以通过词包相关接口或者兴趣关键词word2id接口获取词id,一个计划下最多创建1000个关键词。当interest_action_mode传CUSTOM时有效 InterestWords []uint64 `json:"interest_words,omitempty"` // AwemeFanBehaviors 抖音达人互动用户行为类型 AwemeFanBehaviors []enum.Behavior `json:"aweme_fan_behaviors,omitempty"` // AwemeFanTimeScope AwemeFanTimeScope string `json:"aweme_fan_time_scope,omitempty"` // AwemeFanCategories 抖音达人分类ID列表,与aweme_fan_behaviors同时设置才会生效(抖音达人定向) AwemeFanCategories []uint64 `json:"aweme_fan_categories,omitempty"` // AwemeFanAccounts 抖音达人ID列表,与aweme_fan_behaviors同时设置才会生效(抖音达人定向) AwemeFanAccounts []uint64 `json:"aweme_fan_accounts,omitempty"` // FilterAwemeAbnormalActive (抖音号推广特有)过滤高活跃用户; 取值:0表示不过滤,1表示过滤 FilterAwemeAbnormalActive *int `json:"filter_aweme_abnormal_active,omitempty"` // FilterAwemeFansCount (抖音号推广特有)过滤高关注数用户,例如"filter_aweme_fans_count": 1000表示过滤粉丝数在1000以上的用户 FilterAwemeFansCount *int64 `json:"filter_aweme_fans_count,omitempty"` // FilterOwnAwemeFans (抖音号推广特有)过滤自己的粉丝; 取值:0表示不过滤,1表示过滤 FilterOwnAwemeFans *int `json:"filter_own_aweme_fans,omitempty"` // SuperiorPopularityType 媒体定向; SuperiorPopularityType string `json:"superior_popularity_type,omitempty"` // FlowPackage 定向逻辑 FlowPackage []uint64 `json:"flow_package,omitempty"` // ExcludeFlowPackage 排除定向逻辑 ExcludeFlowPackage []uint64 `json:"exclude_flow_package,omitempty"` // Platform 平台,当下载方式包含下载链接时,平台类型需与选择的下载链接类型对应,当下载方式不包含下载方式的时候,平台可多选。为保证投放效果,平台类型定向PC与移动端互斥 Platform []enum.AudiencePlatform `json:"platform,omitempty"` // AndroidOsv 最低安卓版本,当app_type为"APP_ANDROID"选填,其余情况不填, AndroidOsv string `json:"android_osv,omitempty"` // IosOsv 最低IOS版本,当app_type为"APP_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 过滤已安装,当推广目标为安卓应用下载时可填,0表示不限,1表示过滤,2表示定向。默认为不限;默认值:0; 取值: 0, 1, 2。建议促进app活跃度客户使用定向安装功能。选择定向安装时,向已安装客户展示广告;投放时优先获取直达链接,无直达链接时使用应用包名进行投放;如果无直达链接或应用包名,定向安装选项实际不生效;仅对Android链接生效。 HideIfExists int `json:"hide_if_exists,omitempty"` // HideIfConverted 过滤已转化用户 HideIfConverted string `json:"hide_if_converted,omitempty"` // ConvertedTimeDuration 过滤时间范围 ConvertedTimeDuration string `json:"converted_time_duration,omitempty"` // ActivateType 新用户(新用户使用头条的时间) ActivateType []enum.ActivateType `json:"activate_type,omitempty"` // ArticleCategory 文章分类 ArticleCategory []string `json:"article_category,omitempty"` // DeviceBrand 手机品牌 DeviceBrand []string `json:"device_brand,omitempty"` // LauchPrice 手机价格,传入价格区间,最高传入11000(表示1w以上);传值示例 "launch_price": [2000, 11000],表示2000元以上; LaunchPrice []int `json:"launch_price,omitempty"` // AutoExtendEnabled 是否启用智能放量。取值是:0、1。缺省为 0。 AutoExtendEnabled int `json:"auto_extend_enabled,omitempty"` // AutoExtendTarget 可放开定向。当auto_extend_enabled=1 时选填。详见:【附录-可开放定向】。缺省为全不选。 AutoExtendTarget []string `json:"auto_extend_targets,omitempty"` // DpaLbs 地域匹配-LBS;开启时,根据用户的地理位置信息,给用户投放位于其附近的产品 ;取值:0,1(0表示不启用,1表示启用) DpaLbs *int `json:"dpa_lbs,omitempty"` // DpaCity 地域匹配-商品所在城市;开启时,仅将商品投放给位于该商品设置的可投城市的用户 ;取值:0,1(0表示不启用,1表示启用) DpaCity *int `json:"dpa_city,omitempty"` // DpaProvince 地域匹配-商品所在省份;开启时,将商品仅投放给位于该商品设置的可投省份的用户 ;取值:0,1(0表示不启用,1表示启用) DpaProvince *int `json:"dpa_province,omitempty"` // DpaLocationAudience DPA行为重定向,0:不启用,1:启用 DpaLocationAudience *int `json:"dap_location_audience,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"` // DpaRecommendType dpa商品重定向推荐类型,dpa_local_audience为1时有值;取值:1(基于重定向推荐更多商品(根据重定向商品和行业特点,推荐更多相关商品投放,包含重定向商品),2仅重定向商品(仅根据重定向人群内定义的重定向行为商品进行投放) DpaRecommendType int `json:"dpa_recommend_type,omitempty"` // SmartBidType 投放场景(出价方式),详见【附录-自动出价类型】;允许值: 常规投放"SMART_BID_CUSTOM", 放量投放"SMART_BID_CONSERVATIVE"; 概念解释:常规投放:控制成本,尽量消耗完预算;放量投放:接受成本上浮,尽量消耗更多预算 SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"` // AdjustCpa 是否调整自动出价,意味如果预期成本不在范围内将在此基础上调整,仅OCPM支持,当smart_bid_type=SMART_BID_CONSERVATIVE时选填。当smart_bid_type为"SMART_BID_CONSERVATIVE"且adjust_cpa=0时,cpa_bid由系统自动计算;;当smart_bid_type为"SMART_BID_CONSERVATIVE" 且adjust_cpa=1时,cpa_bid必填 AdjustCpa int `json:"adjust_cpa,omitempty"` // FlowControlMode 竞价策略(投放方式) FlowControlMode enum.FlowControlMode `json:"flow_control_mode,omitempty"` // BudgetMode 预算类型(创建后不可修改), 详见【附录-预算类型】;允许值: "BUDGET_MODE_DAY"日预算, "BUDGET_MODE_TOTAL"总预算 BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"` // Budget 预算 Budget float64 `json:"budget,omitempty"` // ScheduleType 投放时间类型 ScheduleType enum.ScheduleType `json:"schedule_type,omitempty"` // StartTime 投放起始时间,当schedule_type为"SCHEDULE_START_END"时取值,形式如:2017-01-01 00:00 StartTime string `json:"start_time,omitempty"` // EndTime 投放结束时间,当schedule_type为"SCHEDULE_START_END"时取值,形式如:2017-01-01 00:00 EndTime string `json:"end_time,omitempty"` // ScheduleTime 投放时段,默认全时段投放,格式是48*7位字符串,且都是0或1。也就是以半个小时为最小粒度,周一至周日每天分为48个区段,0为不投放,1为投放,不传、全传0、全传1均代表全时段投放。 ScheduleTime string `json:"schedule_time,omitempty"` // Pricing 付费方式(计划出价类型), 详见【附录-计划出价类型】(目前仅穿山甲类型支持OCPC(具体方式:出价类型传OCPC类型,cpa_bid传值 )); 决定投放目标的类型,比如CPC表示点击量,OCPM表示转化量 Pricing enum.PricingType `json:"pricing,omitempty"` // Bid 出价 Bid float64 `json:"bid,omitempty"` // CpaBid 目标转化出价/预期成本, 当pricing为"OCPM"、"OCPC"出价方式时有值 CpaBid float64 `json:"cpa_bid,omitempty"` // DeepBidType 深度优化方式,允许值详见【附录-深度优化方式】,对于每次付费的转化,深度优化类型需要设置为BID_PER_ACTION(每次付费出价)具体概念见【深度优化方式】;当转化目标中含有深度转化时,该字段必填。获取方式见【查询深度优化方式】 DeepBidType enum.DeepBidType `json:"deep_bid_type,omitempty"` // DeepCpabidid 深度优化出价,deep_bid_type为"DEEP_BID_MIN"时有值。当对应的转化convert_id,设定深度转化目标时才会有效。 DeepCpabidid uint64 `json:"deep_cpabidid,omitempty"` // LubanROiGoal 鲁班目标ROI出价策略系数。推广目的为商品推广(GOODS)时可填。当传入该参数时,表示启用鲁班ROI优化,支持范围(0,100],精度:保留小数点后四位 LubanRoiGoal float64 `json:"luban_roi_goal,omitempty"` // RoiGoal 深度转化ROI系数, 范围(0,5],精度:保留小数点后四位, deep_bid_type为"ROI_COEFFICIENT"时有值 RoiGoal float64 `json:"roi_goal,omitempty"` }
CreateRequest 创建计划 API Request
func (CreateRequest) Encode ¶ added in v1.3.0
func (r CreateRequest) Encode() []byte
Encode implement PostRequest interface
type CreateResponse ¶ added in v1.3.0
type CreateResponse struct { model.BaseResponse // Data json返回值 Data struct { // AdID 广告ID AdID uint64 `json:"ad_id,omitempty"` } `json:"data,omitempty"` }
CreateResponse 创建广告计划 API Response
type DpaProductTarget ¶
type DpaProductTarget struct { // Title 筛选字段 Title string `json:"title,omitempty"` // Rule 定向规则,允许值:'=', '!=', '>', '<', '>=', '<=', 'contain', 'exclude', 'notEmpty Rule string `json:"rule,omitempty"` // Type 字段类型,允许值:'int', 'double', 'long', 'string' Type string `json:"type,omitempty"` // Value 规则值 Value string `json:"value,omitempty"` }
DpaProductTarget 商品投放条件
type GetFiltering ¶
type GetFiltering struct { // IDs 按广告计划ID过滤,范围为1-100 IDs []uint64 `json:"ids,omitempty"` // AdName 按广告计划name过滤,长度为1-30个字符 AdName string `json:"ad_name,omitempty"` // PricingList 按出价方式过滤 PricingList enum.PricingType `json:"pricing_list,omitempty"` // Status 按计划状态过滤,默认为返回“所有不包含已删除”,如果要返回所有包含已删除有对应枚举表示 Status enum.AdStatus `json:"status,omitempty"` // AdCreateTime 广告计划创建时间,格式"yyyy-mm-dd",表示过滤出当天创建的广告计划 AdCreateTime string `json:"ad_create_time,omitempty"` // AdModifyTime 广告计划更新时间,格式"yyyy-mm-dd",表示过滤出当天更新的广告计划 AdModifyTime string `json:"ad_modify_time,omitempty"` }
GetFiltering 过滤条件
type GetRequest ¶
type GetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Filtering 过滤条件 Filtering *GetFiltering `json:"filtering,omitempty"` // Fields 查询字段集合, 如果指定, 则返回结果数组中, 每个元素是包含所查询字段的字典允许值: "id", "name", "budget", "budget_mode", "status", "opt_status","open_url", "modify_time", "start_time", "end_time", "bid","advertiser_id", "pricing", "flow_control_mode", "download_url", quick_app_url, "inventory_type", "schedule_type", "app_type", "cpa_bid","cpa_skip_first_phrase", "audience", "external_url", "package","campaign_id", "ad_modify_time", "ad_create_time","audit_reject_reason", "retargeting_type", "retargeting_tags","convert_id", "interest_tags", "hide_if_converted","external_actions", "device_type","auto_extend_enabled", "auto_extend_targets", "dpa_lbs", "dpa_city", "dpa_province", "dpa_recommend_type", "roi_goal","subscribe_url","form_id","form_index","app_desc","app_thumbnails" Fields []string `json:"fields,omitempty"` // Page 页数默认值: 1,page必须大于0 Page int `json:"page,omitempty"` // PageSize 页面大小默认值:10,page_size范围为1-1000 PageSize int `json:"page_size,omitempty"` }
GetRequest 获取广告计划 API Request
func (GetRequest) Encode ¶
func (r GetRequest) Encode() string
Encode implement GetRequest interface
type GetResponse ¶
type GetResponse struct { model.BaseResponse // Data json返回值 Data *GetResponseData `json:"data,omitempty"` }
GetResponse 获取广告计划 API Response
type GetResponseData ¶
type GetResponseData struct { // List 广告数组 List []GetResponseList `json:"list,omitempty"` // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` }
GetResponseData json返回值
type GetResponseList ¶
type GetResponseList struct { // ID 计划ID ID uint64 `json:"id,omitempty"` // AdID 计划ID,返回值同id AdID uint64 `json:"ad_id,omitempty"` // Name 计划名称 Name string `json:"name,omitempty"` // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // CampaignID 广告组ID CampaignID uint64 `json:"campaign_id,omitempty"` // ModifyTime 计划上次修改时间标识(用于更新计划时提交,服务端判断是否基于最新信息修改) ModifyTime string `json:"modify_time,omitempty"` // AdModifyTime 计划上次修改时间 AdModifyTime string `json:"ad_modify_time,omitempty"` // AdCreateTime 计划创建时间 AdCreateTime string `json:"ad_create_time,omitempty"` // UniqueFk 第三方唯一键,传该值时保证接口重试的幂等性,带有相同unique_fk的请求服务端会视为同一个广告处理。仅在创建接口传入且无法修改,如果创建时传入了已存在的唯一键值,那么会返回该唯一键值所对应的广告计划ID。该值可用于内部系统会生成的唯一ID与头条ID做关联的场景,避免超时重试实际上一次创建请求又成功导致的重复创建问题,通过unique_fk可与内部系统ID实现关联并避免重复创建,可结合实际场景选择使用,广告计划中的unique_fk要求不重复,与广告组中的unique_fk无相关。 UniqueFk string `json:"unique_fk,omitempty"` // Status 广告计划投放状态; (进入投放之前,优先披露审核状态,此时优先于启用暂停,启用暂停信息以opt_status为准) Status enum.AdStatus `json:"status,omitempty"` // LearningPhase 学习期状态; 许值:DEFAULT(默认,不在学习期中)、LEARNING(学习中)、LEARNED(学习成功)、LEARN_FAILED(学习失败);关于学习期,此字段即将废弃关于学习期,此字段即将废弃 LearningPhase enum.LearningPhase `json:"learning_phase,omitempty"` // OpStatus 广告计划操作状态, 允许值: "AD_STATUS_ENABLE","AD_STATUS_DISABLE" OptStatus enum.AdOptStatus `json:"opt_status,omitempty"` // DeliveryRange 投放范围 DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"` // UnionVideoType 投放形式(穿山甲视频创意类型);默认值: ORIGINAL_VIDEO原生 UnionVideoType enum.UnionVideoType `json:"union_video_type,omitempty"` // DownloadUrl 应用下载方式,推广目的为APP时有值。返回值:DOWNLOAD_URL下载链接,QUICK_APP_URL快应用+下载链接,EXTERNAL_URL落地页链接 DownloadUrl string `json:"download_url,omitempty"` // QuickAppUrl 快应用链接,当推广类型为应用推广,且download_type为QUICK_APP_URL时有值 QuickAppUrl string `json:"quick_app_url,omitempty"` // ExternalUrl 落地页链接,投放内容或下载方式为落地页时有值 ExternalUrl string `json:"external_url,omitempty"` // TrackUrl 展示(监测链接) TrackUrl []string `json:"track_url,omitempty"` // ActionTrackUrl 点击(监测链接) ActionTrackUrl []string `json:"action_track_url,omitempty"` // VideoPlayEffectTrackUrl 视频有效播放(监测链接) VideoPlayEffectTrackUrl []string `json:"video_play_effect_track_url,omitempty"` // VideoPlayDoneTrackUrl 视频播完(监测链接) VideoPlayDoneTrackUrl []string `json:"video_play_done_track_url,omitempty"` // VideoPlayTrackUrl 视频播放(监测链接) VideoPlayTrackUrl []string `json:"video_play_track_url,omitempty"` // TrackUrlSendType 数据发送方式; 允许值: SERVER_SEND(服务器端上传), CLIENT_SEND(客户端上传) TrackUrlSendType string `json:"track_url_send_type,omitempty"` // DownloadType 应用下载方式,推广目的为APP时有值。返回值:DOWNLOAD_URL下载链接,QUICK_APP_URL快应用+下载链接,EXTERNAL_URL落地页链接 DownloadType string `json:"download_type,omitempty"` // AppType 下载类型,当推广类型为应用推广且download_type为DOWNLOAD_URL或者QUICK_APP_URL时或当推广类型为DPA(商品目录推广)且dpa_adtype为DPA_APP有值 AppType string `json:"app_type,omitempty"` // DonwloadMode 优先从系统应用商店下载(下载模式);允许值:APP_STORE_DELIVERY(仅安卓应用下载支持)、 DEFAULT当应用下载时,默认default下载,可选用APP_STORE_DELIVERY(应用商店直投),当为该值时,将优先跳转目标应用对应手机系统应用商店安装详情页,跳转失败则使用下载链接下载。请确保投放的应用在应用商店内已上架 DownloadMode string `json:"download_mode,omitempty"` // ConvertID 转化目标,其中convert_id数值较小时为预定义转化 ConvertID int `json:"convert_id,omitempty"` // ExternalAction 转化类型,目前当推广类型为抖音时有值,允许值:"AD_CONVERT_TYPE_FOLLOW_ACTION", "AD_CONVERT_TYPE_MESSAGE_ACTION", "AD_CONVERT_TYPE_INTERACTION" ExternalAction string `json:"external_action,omitempty"` // ExternalActions 转化类型,目前当推广类型为抖音时有值,允许值:"AD_CONVERT_TYPE_FOLLOW_ACTION", "AD_CONVERT_TYPE_MESSAGE_ACTION", "AD_CONVERT_TYPE_INTERACTION" ExternalActions []string `json:"external_actions,omitempty"` // DeepExternalAction 深度转化目标 DeepExternalAction string `json:"deep_external_action,omitempty"` // FeedDeliverySearch 搜索快投关键词,HAS_OPEN:启用,DISABLE:不启用 FeedDeliverySearch string `json:"feed_delivery_search,omitempty"` // IntelligentFlowSwitch 智能流量开关,ON:开启,OFF:关闭 IntelligentFlowSwitch string `json:"intelligent_flow_switch,omitempty"` // OpenUrl 直达链接(点击唤起APP) OpenUrl string `json:"open_url,omitempty"` // AdvancedCreativeType 附加创意类型; 允许值: ATTACHED_CREATIVE_GAME_PACKAGE游戏礼包码,ATTACHED_CREATIVE_GAME_FORM游戏表单收集,ATTACHED_CREATIVE_GAME_SUBSCRIBE游戏预约,ATTACHED_CREATIVE_NONE无推广目的为应用推广类型、下载方式选择下载链接且下载链接为安卓应用下载时才可以设置 AdvancedCreativeType string `json:"advanced_creative_type,omitempty"` // GamePackageDesc 应用描述,最少1字,最多15字 GamePackageDesc string `json:"game_package_desc,omitempty"` // GamePackageBatchID 游戏礼包码id,目前仅支持直接发券类型 GamePackageBatchID int64 `json:"game_package_batch_id,omitempty"` // GamePackageThumbnails 应用图片集,图片URL链接,有且仅有两个该字段10.10日下线 GamePackageThumbnails []string `json:"game_package_thumbnails,omitempty"` // GamePackageThumbnailIDs 应用图片集,图片image_id,有且仅有两个,游戏礼包码时有值,可以从 【素材管理-获取图片素材】 接口中获取,建议尺寸 16:9 与game_package_thumbnails同时传入时,以game_package_thumbnail_ids字段为准 GamePackageThumbnailIDs []string `json:"game_package_thumbnail_ids,omitempty"` // StoreproUnit 门店推广-投放内容,当推广目的为STORE(门店推广)时有值。取值: "STORE"门店, "STORE_ACTIVITY"活动;目前暂时不支持线下商品类型 StoreproUnit string `json:"storepro_unit,omitempty"` // StoreType 门店类型,(storepro_unit 为 "STORE" 时有值。取值: "STORE_NORMAL"平台通用门店, "STORE_THIRT_PARTY"第三方门店, "STORE_DOUYIN"抖音POI门店 StoreType string `json:"store_type,omitempty"` // AdvertiserStoreIDs 门店ID列表 (storepro_unit 为 "STORE" 时有值 AdvertiserStoreIDs []uint64 `json:"advertiser_store_ids,omitempty"` // StoreproPackID 活动ID (storepro_unit 为 "STORE_ACTIVITY" 时有值 StoreproPackID uint64 `json:"storepro_pack_id,omitempty"` // ProductPlatformID 产品目录ID(ID由查询产品目录接口得到), 当推广目的landing_type为DPA时有值 ProductPlatformID int64 `json:"product_platform_id,omitempty"` // ProductID 商品id,当推广目的为 DPA 广告组商品类型为 SDPA 时有值 ProductID string `json:"product_id,omitempty"` // AssetID 物件id,当广告组商品类型为 SDPA 且商品库为汽车商品库时有值 AssetID uint64 `json:"asset_id,omitempty"` // CategoryType DPA投放范围,取值:NONE不限,"CATEGORY"选择分类,"PRODUCT"指定商品 CategoryType string `json:"category_type,omitempty"` // DpaCategories 分类列表,category_type取值范围为CATEGORY时有值 DpaCategories []uint64 `json:"dpa_categories,omitempty"` // DpaProducts 商品列表,category_type为PRODUCT时有值 DpaProducts []uint64 `json:"dpa_products,omitempty"` // DpaProductTarget 自定义筛选条件(商品投放条件)。用于圈定商品投放范围,结合商品库字段搭配判断条件,圈定商品投放范围。 DpaProductTarget []DpaProductTarget `json:"dpa_product_target,omitempty"` // DpaAdtype dpa广告类型,取值范围:"DPA_LINK"落地页, "DPA_APP"应用下载 DpaAdtype []string `json:"dpa_adtype,omitempty"` // ParamsType 链接类型(落地页),当dpa_adtype为"DPA_LINK"时有值,取值: "DPA"商品库所含链接, "CUSTOM"自定义链接 ParamsType string `json:"params_type,omitempty"` // DpaExternalUrlField 落地页链接字段选择,当params_type为"DPA"时有值 DpaExternalUrlField string `json:"dpa_external_url_field,omitempty"` // DpaExternalUrls 落地页链接地址列表,当params_type为"CUSTOM"时有值 DpaExternalUrls []string `json:"dpa_external_urls,omitempty"` // Package 应用包名,当推广类型为应用推广且download_type为DOWNLOAD_URL时或当推广类型为DPA(商品目录推广)且dpa_adtype为DPA_APP有值 Package string `json:"package,omitempty"` // InventoryCatalog 广告位大类。 MANUAL首选媒体 SCENE场景广告位,SMART优选广告位,UNIVERSAL通投智选 InventoryCatalog string `json:"inventory_catalog,omitempty"` // InventoryType 创意投放位置; 创建选择优选广告位时,此字段回会返回对应的优选广告位 InventoryType []enum.StatInventoryType `json:"inventory_type,omitempty"` // SmartInventory 优选广告位,NORMAL表示不使用优选,SMART表示使用优选,UNIVERSAL表示通投 SmartInventory string `json:"smart_inventory,omitempty"` // SceneInventory 首选场景广告位 SceneInventory string `json:"scene_inventory,omitempty"` // PromotionType 投放内容; GOODS:商品推广;LIVE:直播; AWEME_HOME_PAGE:抖音主页;LANDING_PAGE_LINK:落地页 PromotionType string `json:"promotion_type,omitempty"` // AwemeAccount 抖音号 AwemeAccount string `json:"aweme_account,omitempty"` // SubscribeUrl 游戏营销场景-预约下载链接 SubscribeUrl string `json:"subscribe_url,omitempty"` // FormID 游戏营销场景-表单id FormID uint64 `json:"form_id,omitempty"` // FormIndex 游戏营销场景-表单位置索引 FormIndex int `json:"form_index,omitempty"` // AppDesc 游戏营销场景-应用描述 AppDesc string `json:"app_desc,omitempty"` // AppIntroduction 游戏营销场景-应用介绍 AppIntroduction string `json:"app_introduction,omitempty"` // AppThumbnails 游戏营销场景-应用图片集,返回图片集Id AppThumbnails []string `json:"app_thumbnails,omitempty"` // DpaOpenUrlType 直达链接类型,取值: "NONE"不启用, "DPA"商品库所含链接, "CUSTOM"自定义链接商品库链接对应商品库内调起字段。 DpaOpenUrlType string `json:"dpa_open_url_type,omitempty"` // DpaOpenUrlField 直达链接字段选择,当dpa_open_url_type为"DPA"时有值 DpaOpenUrlField string `json:"dpa_open_url_field,omitempty"` // DpaOpenUrls 直达链接地址列表,当dpa_open_url_type为"CUSTOM"时有值 DpaOpenUrls []string `json:"dpa_open_urls,omitempty"` // ExternalUrlParams 落地页检测参数(DPA推广目的特有,在填写的参数后面添加"=urlencode(开放平台提供的h5链接地址)",其中urlencode(开放平台提供的h5链接地址)替换为商品库中的h5地址encode的结果) ExternalUrlParams string `json:"external_url_params,omitempty"` // OpenUrlParams 直达链接检测参数(DPA推广目的特有,在“产品库中提取的scheme地址"后面追加填写的参数) OpenUrlParams string `json:"open_url_params,omitempty"` // Audience 广告受众, 字典类型, 包含下面字段 Audience *Audience `json:"audience,omitempty"` // AudiencePackageID 定向包ID AudiencePackageID uint64 `json:"audience_package_id,omitempty"` // HideIfExists 过滤已安装,当推广目标为安卓应用下载时可填,0表示不限,1表示过滤,2表示定向。默认为不限;默认值:0; 取值: 0, 1, 2。建议促进app活跃度客户使用定向安装功能。选择定向安装时,向已安装客户展示广告;投放时优先获取直达链接,无直达链接时使用应用包名进行投放;如果无直达链接或应用包名,定向安装选项实际不生效;仅对Android链接生效。 HideIfExists int `json:"hide_if_exists,omitempty"` // HideIfConverted 过滤已转化用户 HideIfConverted string `json:"hide_if_converted,omitempty"` // ConvertedTimeDuration 过滤时间范围 ConvertedTimeDuration string `json:"converted_time_duration,omitempty"` // DpaLbs 地域匹配-LBS;开启时,根据用户的地理位置信息,给用户投放位于其附近的产品 ;取值:0,1(0表示不启用,1表示启用) DpaLbs int `json:"dpa_lbs,omitempty"` // DpaCity 地域匹配-商品所在城市;开启时,仅将商品投放给位于该商品设置的可投城市的用户 ;取值:0,1(0表示不启用,1表示启用) DpaCity int `json:"dpa_city,omitempty"` // DpaProvince 地域匹配-商品所在省份;开启时,将商品仅投放给位于该商品设置的可投省份的用户 ;取值:0,1(0表示不启用,1表示启用) DpaProvince int `json:"dpa_province,omitempty"` // DpaLocationAudience DPA行为重定向,0:不启用,1:启用 DpaLocationAudience int `json:"dap_location_audience,omitempty"` // AssetIDs 事件管理下资产 id AssetIDs []uint64 `json:"asset_ids,omitempty"` // ValueOptimizedType 目标优化类型,0表示行为优化,1表示价值优化 ValueOptimizedType int `json:"value_optimized_type,omitempty"` // ValueOptimizedOpen 价值优选,0表示关闭,1表示开启 ValueOptimizedOpen int `json:"value_optimized_open,omitempty"` // IncludeCustomActions 包含人群包((DPA推广目的特有,格式举例[{"days": 7, "code": 1001},], dpa_local_audience为1时有值; day可选范围:1, 7, 14, 28, 60, 90, 120, 180。 IncludeCustomActions json.RawMessage `json:"include_custom_actions,omitempty"` // ExcludeCustomActions 排除人群包((DPA推广目的特有,格式举例{"days": 7, "code": 1002},],day可选范围: 1, 7, 14, 28, 60, 90, 120, 180。 ExcludeCustomActions json.RawMessage `json:"exclude_custom_actions,omitempty"` // DpaRecommendType dpa商品重定向推荐类型,dpa_local_audience为1时有值;取值:1(基于重定向推荐更多商品(根据重定向商品和行业特点,推荐更多相关商品投放,包含重定向商品),2仅重定向商品(仅根据重定向人群内定义的重定向行为商品进行投放) DpaRecommendType int `json:"dpa_recommend_type,omitempty"` // SmartBidType 投放场景(出价方式) SmartBidType enum.SmartBidType `json:"smart_bid_type,omitempty"` // AdjustCpa 是否调整自动出价,意味如果预期成本不在范围内将在此基础上调整,仅OCPM支持,当smart_bid_type=SMART_BID_CONSERVATIVE时选填。当smart_bid_type为"SMART_BID_CONSERVATIVE"且adjust_cpa=0时,cpa_bid由系统自动计算;;当smart_bid_type为"SMART_BID_CONSERVATIVE" 且adjust_cpa=1时,cpa_bid必填 AdjustCpa int `json:"adjust_cpa,omitempty"` // FlowControlMode 竞价策略(投放方式) FlowControlMode enum.FlowControlMode `json:"flow_control_mode,omitempty"` // BudgetMode 预算类型(创建后不可修改), BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"` // Budget 预算 Budget float64 `json:"budget,omitempty"` // ScheduleType 投放时间类型 ScheduleType enum.ScheduleType `json:"schedule_type,omitempty"` // StartTime 投放起始时间,当schedule_type为"SCHEDULE_START_END"时取值,形式如:2017-01-01 00:00 StartTime string `json:"start_time,omitempty"` // EndTime 投放结束时间,当schedule_type为"SCHEDULE_START_END"时取值,形式如:2017-01-01 00:00 EndTime string `json:"end_time,omitempty"` // ScheduleTime 投放时段,默认全时段投放,格式是48*7位字符串,且都是0或1。也就是以半个小时为最小粒度,周一至周日每天分为48个区段,0为不投放,1为投放,不传、全传0、全传1均代表全时段投放。 ScheduleTime string `json:"schedule_time,omitempty"` // Pricing 付费方式(计划出价类型) Pricing enum.PricingType `json:"pricing,omitempty"` // Bid 出价 Bid float64 `json:"bid,omitempty"` // CpaBid 目标转化出价/预期成本, 当pricing为"OCPM"、"OCPC"出价方式时有值 CpaBid float64 `json:"cpa_bid,omitempty"` // DeepBidType 深度优化方式 DeepBidType enum.DeepBidType `json:"deep_bid_type,omitempty"` // DeepCpabidid 深度优化出价,deep_bid_type为"DEEP_BID_MIN"时有值。当对应的转化convert_id,设定深度转化目标时才会有效。 DeepCpabidid uint64 `json:"deep_cpabidid,omitempty"` // LubanROiGoal 鲁班目标ROI出价策略系数。推广目的为商品推广(GOODS)时可填。当传入该参数时,表示启用鲁班ROI优化,支持范围(0,100],精度:保留小数点后四位 LubanRoiGoal float64 `json:"luban_roi_goal,omitempty"` // RoiGoal 深度转化ROI系数, 范围(0,5],精度:保留小数点后四位, deep_bid_type为"ROI_COEFFICIENT"时有值 RoiGoal float64 `json:"roi_goal,omitempty"` }
GetResponseList 广告信息
type UpdateBidRequest ¶
type UpdateBidRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Data 批量修改,包含计划id和出价 Data []UpdateBidRequestList `json:"data,omitempty"` }
UpdateBidRequest 更新计划出价 API Request
func (UpdateBidRequest) Encode ¶
func (r UpdateBidRequest) Encode() []byte
Encode implement PostRequest interface
type UpdateBidRequestList ¶
type UpdateBidRequestList struct { // AdID 广告计划ID,广告计划ID需要属于广告主 AdID uint64 `json:"ad_id,omitempty"` // Bid 出价,单位“元”,精度:两位小数。 Bid float64 `json:"bid,omitempty"` }
UpdateBidRequestList 修改信息
type UpdateBudgetRequest ¶
type UpdateBudgetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // Data 批量修改,包含计划id和出价 Data []UpdateBudgetRequestList `json:"data,omitempty"` }
UpdateBudgetRequest 更新计划预算 API Request
func (UpdateBudgetRequest) Encode ¶
func (r UpdateBudgetRequest) Encode() []byte
Encode implement PostRequest interface
type UpdateBudgetRequestList ¶
type UpdateBudgetRequestList struct { // AdID 广告计划ID,广告计划ID需要属于广告主 AdID uint64 `json:"ad_id,omitempty"` // Budget 预算,单位“元”,精度:两位小数。 Budget float64 `json:"budget,omitempty"` }
UpdateBudgetRequestList 修改信息
type UpdateError ¶ added in v1.2.3
type UpdateError struct { // AdID 广告计划ID AdID uint64 `json:"ad_id,omitempty"` // ErrorMessage 错误信息 ErrorMessage string `json:"error_message"` }
UpdateError 更新失败的广告计划
type UpdateRequest ¶ added in v1.2.12
type UpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AdID 广告计划ID,广告计划id需要属于广告主,且ad_id不能重复,否则会报错! AdID uint64 `json:"ad_id,omitempty"` // Name 广告计划名称,长度为1-100个字符,其中1个中文字符算2位 Name string `json:"name,omitempty"` // DownloadMode 优先从系统应用商店下载(下载模式),当下载方式为下载链接时,可修改。允许值:APP_STORE_DELIVERY(仅安卓应用下载支持)、 DEFAULT当应用下载时,默认default下载,可选用APP_STORE_DELIVERY(应用商店直投),选择后,将优先跳转目标应用对应手机系统应用商店安装详情页,跳转失败则使用下载链接下载。 DownloadMode string `json:"download_mode,omitempty"` // OpenUrl 直达链接(点击唤起APP)直达链接仅支持部分App唤起,点击创意将优先跳转App,再根据投放内容跳转相关链接 OpenUrl string `json:"open_url,omitempty"` // Ulink 直达备用链接,仅支持穿山甲广告位(不支持搜索广告) Ulink string `json:"ulink,omitempty"` // ExternalUrl 落地页链接(支持橙子建站落地页);对于转化量为目标的计划如OCPM计划不允许更改,非转化为目标的计划如CPC、CPM计划可更改; 获取橙子建站落地页可参考【橙子建站落地页管理】 ExternalUrl string `json:"external_url,omitempty"` // CategoryType 商品目录投放范围,当广告组商品类型选择 DPA 多商品时可修改;允许值:NONE不限,"CATEGORY"选择分类,"PRODUCT"指定商品 CategoryType string `json:"category_type,omitempty"` // DpaCategories 分类列表,category_type更新为"CATEGORY"时可修改,由【DPA商品广告-获取DPA分类】 得到限制个数1~100 DpaCategories []uint64 `json:"dpa_categories,omitempty"` // DpaProducts 商品列表,category_type更新为"PRODUCT"时可修改,由【DPA商品广告-获取DPA商品库商品列表】 得到;限制个数1~100 DpaProducts []uint64 `json:"dpa_products,omitempty"` // DpaProductTargets 自定义筛选条件(商品投放条件)。用于圈定商品投放范围,结合商品库字段搭配判断条件,圈定商品投放范围。 DpaProductTarget []DpaProductTarget `json:"dpa_product_targets,omitempty"` // ParamsType 链接类型(落地页),当dpa_adtype为"DPA_LINK"时有值,取值: "DPA"商品库所含链接, "CUSTOM"自定义链接 ParamsType string `json:"params_type,omitempty"` // DpaExternalUrlField 落地页链接字段选择,当params_type为"DPA"时有值 DpaExternalUrlField string `json:"dpa_external_url_field,omitempty"` // DpaExternalUrls 落地页链接地址列表,当params_type为"CUSTOM"时有值 DpaExternalUrls []string `json:"dpa_external_urls,omitempty"` // AppType 下载类型,当推广类型为应用推广且download_type为DOWNLOAD_URL或者QUICK_APP_URL时或当推广类型为DPA(商品目录推广)且dpa_adtype为DPA_APP有值 AppType string `json:"app_type,omitempty"` // DownloadUrl 应用下载方式,推广目的为APP时有值。返回值:DOWNLOAD_URL下载链接,QUICK_APP_URL快应用+下载链接,EXTERNAL_URL落地页链接 DownloadUrl string `json:"download_url,omitempty"` // Package 应用包名,当推广类型为应用推广且download_type为DOWNLOAD_URL时或当推广类型为DPA(商品目录推广)且dpa_adtype为DPA_APP有值 Package string `json:"package,omitempty"` // DpaOpenUrlType 直达链接类型,取值: "NONE"不启用, "DPA"商品库所含链接, "CUSTOM"自定义链接商品库链接对应商品库内调起字段。 DpaOpenUrlType string `json:"dpa_open_url_type,omitempty"` // DpaOpenUrlField 直达链接字段选择,当dpa_open_url_type为"DPA"时有值 DpaOpenUrlField string `json:"dpa_open_url_field,omitempty"` // DpaOpenUrls 直达链接地址列表,当dpa_open_url_type为"CUSTOM"时有值 DpaOpenUrls []string `json:"dpa_open_urls,omitempty"` // ExternalUrlParams 落地页检测参数(DPA推广目的特有,在填写的参数后面添加"=urlencode(开放平台提供的h5链接地址)",其中urlencode(开放平台提供的h5链接地址)替换为商品库中的h5地址encode的结果) ExternalUrlParams string `json:"external_url_params,omitempty"` // OpenUrlParams 直达链接检测参数(DPA推广目的特有,在“产品库中提取的scheme地址"后面追加填写的参数) OpenUrlParams string `json:"open_url_params,omitempty"` // FeedDeliverySearch 搜索快投关键词,HAS_OPEN:启用,DISABLE:不启用 FeedDeliverySearch string `json:"feed_delivery_search,omitempty"` // IntelligentFlowSwitch 智能流量开关,ON:开启,OFF:关闭 IntelligentFlowSwitch string `json:"intelligent_flow_switch,omitempty"` // AudiencePackageID 定向包ID AudiencePackageID uint64 `json:"audience_package_id,omitempty"` // District 地域;取值: "CITY"省市, "COUNTY"区县, "BUSINESS_DISTRICT"商圈,"NONE"不限,省市传法:"city": [12],"district": "CITY",区县的传法:"city": [130102],"district": "COUNTY";暂不支持"海外" District string `json:"district,omitempty"` // RegionVersion 行政区域版本号。通过[【获取行政信息】]https://open.oceanengine.com/doc/index.html?key=ad&type=api&id=1709606596424718)接口获取; district =REGION/OVERSEA时必填 RegionVersion string `json:"region_version,omitempty"` // City 地域定向省市或者区县列表(当传递省份ID时,旗下市县ID可省略不传),当district为"CITY"或"COUNTY"时有值 City []uint64 `json:"city,omitempty"` // BusinessIDs 商圈ID数组,district为"BUSINESS_DISTRICT"时有值 BusinessIDs []uint64 `json:"business_ids,omitempty"` // Geolocation 从地图添加(地图位置) Geolocation []model.Geolocation `json:"geolocation,omitempty"` // LocationType 位置类型;取值:CURRENT正在该地区的用户,HOME居住在该地区的用户,TRAVEL到该地区旅行的用户,ALL该地区内的所有用户;当city和district有值时返回值 LocationType string `json:"location_type,omitempty"` // Gender 性别 Gender enum.AudienceGender `json:"gender,omitempty"` // Age 年龄 Age []enum.AudienceAge `json:"age,omitempty"` // Carreer 职业选项,详见【附录-职业】 Career []string `json:"career,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"` // InterestActionMode 行为兴趣;取值:"UNLIMITED"不限,"CUSTOM"自定义,"RECOMMEND"系统推荐。若与自定义人群同时使用,系统推荐("RECOMMEND")不生效;仅推广范围为默认时可填,且不可与老版行为兴趣定向同时填写,否则会报错 InterestActionMode string `json:"interest_action_mode,omitempty"` // ActionScene 行为场景 ActionScene []enum.ActionScene `json:"action_scene,omitempty"` // ActionDays 用户发生行为天数,当interest_action_mode传CUSTOM时有效 ActionDays uint `json:"action_days,omitempty"` // ActionCategories 行为类目词,当interest_action_mode传CUSTOM时有效 ActionCategories []uint64 `json:"action_categories,omitempty"` // ActionWords 行为关键词,当interest_action_mode传CUSTOM时有效 ActionWords []uint64 `json:"action_words,omitempty"` // InterestCategories 兴趣类目词,当interest_action_mode传CUSTOM时有效 InterestCategories []uint64 `json:"Interest_categories,omitempty"` // InterestWords 兴趣关键词, 传入具体的词id,非兴趣词包id,可以通过词包相关接口或者兴趣关键词word2id接口获取词id,一个计划下最多创建1000个关键词。当interest_action_mode传CUSTOM时有效 InterestWords []uint64 `json:"interest_words,omitempty"` // AwemeFanBehaviors 抖音达人互动用户行为类型 AwemeFanBehaviors []enum.Behavior `json:"aweme_fan_behaviors,omitempty"` // AwemeFanTimeScope AwemeFanTimeScope string `json:"aweme_fan_time_scope,omitempty"` // AwemeFanCategories 抖音达人分类ID列表,与aweme_fan_behaviors同时设置才会生效(抖音达人定向) AwemeFanCategories []uint64 `json:"aweme_fan_categories,omitempty"` // AwemeFanAccounts 抖音达人ID列表,与aweme_fan_behaviors同时设置才会生效(抖音达人定向) AwemeFanAccounts []uint64 `json:"aweme_fan_accounts,omitempty"` // FilterAwemeAbnormalActive (抖音号推广特有)过滤高活跃用户; 取值:0表示不过滤,1表示过滤 FilterAwemeAbnormalActive *int `json:"filter_aweme_abnormal_active,omitempty"` // FilterAwemeFansCount (抖音号推广特有)过滤高关注数用户,例如"filter_aweme_fans_count": 1000表示过滤粉丝数在1000以上的用户 FilterAwemeFansCount *int64 `json:"filter_aweme_fans_count,omitempty"` // FilterOwnAwemeFans (抖音号推广特有)过滤自己的粉丝; 取值:0表示不过滤,1表示过滤 FilterOwnAwemeFans *int `json:"filter_own_aweme_fans,omitempty"` // SuperiorPopularityType 媒体定向; SuperiorPopularityType string `json:"superior_popularity_type,omitempty"` // FlowPackage 定向逻辑 FlowPackage []uint64 `json:"flow_package,omitempty"` // ExcludeFlowPackage 排除定向逻辑 ExcludeFlowPackage []uint64 `json:"exclude_flow_package,omitempty"` // Platform 平台,当下载方式包含下载链接时,平台类型需与选择的下载链接类型对应,当下载方式不包含下载方式的时候,平台可多选。为保证投放效果,平台类型定向PC与移动端互斥 Platform []enum.AudiencePlatform `json:"platform,omitempty"` // AndroidOsv 最低安卓版本,当app_type为"APP_ANDROID"选填,其余情况不填, AndroidOsv string `json:"android_osv,omitempty"` // IosOsv 最低IOS版本,当app_type为"APP_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 过滤已安装,当推广目标为安卓应用下载时可填,0表示不限,1表示过滤,2表示定向。默认为不限;默认值:0; 取值: 0, 1, 2。建议促进app活跃度客户使用定向安装功能。选择定向安装时,向已安装客户展示广告;投放时优先获取直达链接,无直达链接时使用应用包名进行投放;如果无直达链接或应用包名,定向安装选项实际不生效;仅对Android链接生效。 HideIfExists *int `json:"hide_if_exists,omitempty"` // HideIfConverted 过滤已转化用户 HideIfConverted string `json:"hide_if_converted,omitempty"` // ConvertedTimeDuration 过滤时间范围 ConvertedTimeDuration string `json:"converted_time_duration,omitempty"` // ActivateType 新用户(新用户使用头条的时间) ActivateType []enum.ActivateType `json:"activate_type,omitempty"` // ArticleCategory 文章分类 ArticleCategory []string `json:"article_category,omitempty"` // DeviceBrand 手机品牌 DeviceBrand []string `json:"device_brand,omitempty"` // LauchPrice 手机价格,传入价格区间,最高传入11000(表示1w以上);传值示例 "launch_price": [2000, 11000],表示2000元以上; LaunchPrice []int `json:"launch_price,omitempty"` // AutoExtendEnabled 是否启用智能放量。取值是:0、1。缺省为 0。 AutoExtendEnabled *int `json:"auto_extend_enabled,omitempty"` // AutoExtendTarget 可放开定向。当auto_extend_enabled=1 时选填。详见:【附录-可开放定向】。缺省为全不选。 AutoExtendTarget []string `json:"auto_extend_targets,omitempty"` // DpaLbs 地域匹配-LBS;开启时,根据用户的地理位置信息,给用户投放位于其附近的产品 ;取值:0,1(0表示不启用,1表示启用) DpaLbs *int `json:"dpa_lbs,omitempty"` // DpaCity 地域匹配-商品所在城市;开启时,仅将商品投放给位于该商品设置的可投城市的用户 ;取值:0,1(0表示不启用,1表示启用) DpaCity *int `json:"dpa_city,omitempty"` // DpaProvince 地域匹配-商品所在省份;开启时,将商品仅投放给位于该商品设置的可投省份的用户 ;取值:0,1(0表示不启用,1表示启用) DpaProvince *int `json:"dpa_province,omitempty"` // DpaLocationAudience DPA行为重定向,0:不启用,1:启用 DpaLocationAudience *int `json:"dap_location_audience,omitempty"` // IncludeCustomActions 包含人群包((DPA推广目的特有,格式举例[{"days": 7, "code": 1001},], dpa_local_audience为1时有值; day可选范围:1, 7, 14, 28, 60, 90, 120, 180。 IncludeCustomActions json.RawMessage `json:"include_custom_actions,omitempty"` // ExcludeCustomActions 排除人群包((DPA推广目的特有,格式举例{"days": 7, "code": 1002},],day可选范围: 1, 7, 14, 28, 60, 90, 120, 180。 ExcludeCustomActions json.RawMessage `json:"exclude_custom_actions,omitempty"` // DpaRecommendType dpa商品重定向推荐类型,dpa_local_audience为1时有值;取值:1(基于重定向推荐更多商品(根据重定向商品和行业特点,推荐更多相关商品投放,包含重定向商品),2仅重定向商品(仅根据重定向人群内定义的重定向行为商品进行投放) DpaRecommendType int `json:"dpa_recommend_type,omitempty"` // AdjustCpa 是否调整自动出价,意味如果预期成本不在范围内将在此基础上调整,仅OCPM支持,当smart_bid_type=SMART_BID_CONSERVATIVE时选填。当smart_bid_type为"SMART_BID_CONSERVATIVE"且adjust_cpa=0时,cpa_bid由系统自动计算;;当smart_bid_type为"SMART_BID_CONSERVATIVE" 且adjust_cpa=1时,cpa_bid必填 AdjustCpa *int `json:"adjust_cpa,omitempty"` // FlowControlMode 竞价策略(投放方式) FlowControlMode enum.FlowControlMode `json:"flow_control_mode,omitempty"` // Budget 预算 Budget float64 `json:"budget,omitempty"` // ScheduleType 投放时间类型 ScheduleType enum.ScheduleType `json:"schedule_type,omitempty"` // StartTime 投放起始时间,当schedule_type为"SCHEDULE_START_END"时取值,形式如:2017-01-01 00:00 StartTime string `json:"start_time,omitempty"` // EndTime 投放结束时间,当schedule_type为"SCHEDULE_START_END"时取值,形式如:2017-01-01 00:00 EndTime string `json:"end_time,omitempty"` // ScheduleTime 投放时段,默认全时段投放,格式是48*7位字符串,且都是0或1。也就是以半个小时为最小粒度,周一至周日每天分为48个区段,0为不投放,1为投放,不传、全传0、全传1均代表全时段投放。 ScheduleTime string `json:"schedule_time,omitempty"` // Bid 出价 Bid float64 `json:"bid,omitempty"` // CpaBid 目标转化出价/预期成本, 当pricing为"OCPM"、"OCPC"出价方式时有值 CpaBid float64 `json:"cpa_bid,omitempty"` // DeepCpabidid 深度优化出价,deep_bid_type为"DEEP_BID_MIN"时有值。当对应的转化convert_id,设定深度转化目标时才会有效。 DeepCpabidid uint64 `json:"deep_cpabidid,omitempty"` // LubanROiGoal 鲁班目标ROI出价策略系数。推广目的为商品推广(GOODS)时可填。当传入该参数时,表示启用鲁班ROI优化,支持范围(0,100],精度:保留小数点后四位 LubanRoiGoal float64 `json:"luban_roi_goal,omitempty"` // RoiGoal 深度转化ROI系数, 范围(0,5],精度:保留小数点后四位, deep_bid_type为"ROI_COEFFICIENT"时有值 RoiGoal float64 `json:"roi_goal,omitempty"` }
UpdateRequest 更新计划 API Request
func (UpdateRequest) Encode ¶ added in v1.2.12
func (r UpdateRequest) Encode() []byte
Encode implement PostRequest interface
type UpdateResponse ¶ added in v1.2.3
type UpdateResponse struct { model.BaseResponse // Data json返回值 Data *UpdateResponseData `json:"data,omitempty"` }
UpdateResponse 更新计划API Response
type UpdateResponseData ¶ added in v1.2.3
type UpdateResponseData struct { // AdID 广告计划ID AdID uint64 `json:"ad_id,omitempty"` // NeedAudit 此次修改是否触发进入待审状态(1表示进入待审状态,0表示不进入待审状态) NeedAudit int `json:"need_audit,omitempty"` // AdIDs 广告计划ID集合 AdIDs []uint64 `json:"ad_ids,omitempty"` // Errors 更新失败的广告计划列表 Errors []UpdateError `json:"errors,omitempty"` }
UpdateResponseData json返回值
type UpdateStatusRequest ¶
type UpdateStatusRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AdIDs 计划ID集合,限制1~100. 广告计划id需属于广告主 AdIDs []uint64 `json:"ad_ids,omitempty"` // OptStatus 操作, "enable"表示启用, "delete"表示删除, "disable"表示暂停;允许值: "enable", "delete", "disable",; 对于删除的广告组不可进行任何操作,否则会报错哈 OptStatus string `json:"opt_status,omitempty"` }
UpdateStatusRequest 更新计划状态 API Request
func (UpdateStatusRequest) Encode ¶
func (r UpdateStatusRequest) Encode() []byte
Encode implement PostRequest interface