project

Documentation

Overview

Package project 项目管理模块

Index

• type Audience
• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type CustomArea
• type DetailRequest
  • func (r DetailRequest) Encode() string
• type DetailResponse
• type Geolocation
• type ListRequest
  • func (r ListRequest) Encode() string
• type ListRequestFilter
• type ListResponse
• type ListResult
• type PoiAround
• type PoiInfo
• type Project
• type ProjectDetail
• type Region
• type StatusUpdateItem
• type StatusUpdateRequest
  • func (r StatusUpdateRequest) Encode() []byte
• type StatusUpdateResponse
• type UpdateError
  • func (e UpdateError) Error() string
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte
• type UpdateResult

Types

type Audience

type Audience struct {
	// District 地域类型，允许值：
	// ALL 不限
	// LOCAL 自定义/商圈
	// POI 门店附近
	// 当delivery_content_type=POI&& 门店数量>2000家 时，不支持POI_AROUND门店附近
	// REGION 按行政区域划分
	// 使用行政区域示例：{"district":"REGION": "city":[31], "region_versio":"1.0.0"}
	District enum.District `json:"district,omitempty"`
	// Region 行政区域信息
	// 当district=REGION 行政区域划分时有效且必填
	Region *Region `json:"region,omitempty"`
	// CustomArea 自定义区域设置
	// 当district=LOCAL时必填
	CustomArea *CustomArea `json:"custom_area,omitempty"`
	// PoiAround 门店附近定向设置
	// 当district=POI门店附近时有效且必填
	PoiAround *PoiAround `json:"poi_around,omitempty"`
	// Age 年龄，允许值：
	// 年龄不可同时传入 5 分段枚举和 10 分段枚举
	// 5分段（age_5_part_set）
	// AGE_BETWEEN_18_19
	// AGE_BETWEEN_20_23
	// AGE_BETWEEN_24_30
	// AGE_BETWEEN_31_35
	// AGE_BETWEEN_36_40
	// AGE_BETWEEN_41_45
	// AGE_BETWEEN_46_50
	// AGE_BETWEEN_51_55
	// AGE_BETWEEN_56_59
	// AGE_ABOVE_60
	// 10分段（age_10_part_set）
	// AGE_BETWEEN_18_23
	// AGE_BETWEEN_24_30
	// AGE_BETWEEN_31_40
	// AGE_BETWEEN_41_49
	// AGE_ABOVE_50
	Age enum.AudienceAge `json:"age,omitempty"`
	// Gender 性别，不传默认不限，允许值：
	// FEMALE 女
	// MALE 男
	// NONE 不限
	Gender local.Gender `json:"gender,omitempty"`
	// RetargetingTags 定向人群包ID，可通过【查询本地推创编可用人群包】接口获取
	// 数量上限：200
	RetargetingTags []uint64 `json:"retargeting_tags,omitempty"`
	// RetargetingTagsExclude 排除人群包ID，可通过【查询本地推创编可用人群包】接口获取
	// 数量上限：200
	RetargetingTagsExclude []uint64 `json:"retargeting_tags_exclude,omitempty"`
	// HideIfConverted 过滤已转化的维度，可以避免该广告再次投放给已转化过的用户，不传默认不过滤，允许值：
	// NOT_EXCLUDE 不过滤
	// ADVERTISER 广告主账户
	// CC 组织账户
	// CUSTOMER 公司账户
	// PROJECT 项目
	// PROMOTION 广告
	// 当external_action=SHOW 展示量时，不支持该字段
	HideIfConverted enum.HideIfConverted `json:"hide_if_converted,omitempty"`
	// ConvertedTimeDuration 过滤已转化投放时间，允许值：
	// SEVEN_DAY 七天（默认值）
	// ONE_MONTH 1个月
	// THREE_MONTH 3个月
	// SIX_MONTH 6个月
	// TWELVE_MONTH 12个月
	// TODAY 当天
	// 仅当hide_if_converted设置为CUSTOMER或ORGANIZATION，该字段有效，不传默认7天，其余场景该字段无效。
	ConvertedTimeDuration enum.ConvertedTimeDuration `json:"converted_time_duration,omitempty"`
}

Audience 定向设置

type CreateRequest

type CreateRequest struct {
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// Name 项目名称，长度是1-50个字（两个英文字符占1个字）
	Name string `json:"name,omitempty"`
	// MarketingGoal 营销场景，允许值：
	// LIVE 直播
	// VIDEO_IMAGE 短视频/图文
	MarketingGoal local.MarketingGoal `json:"marketing_goal,omitempty"`
	// LocalDeliveryScene 推广目的，允许值：
	// CONTENT_HEAT 内容加热
	// POI_RECOMMEND 门店引流
	// 当marketing_goal =LIVE 直播时，不支持传入POI_RECOMMEND 门店引流
	// PRODUCT_PAY 团购成交
	LocalDeliveryScene local.LocalDeliveryScene `json:"local_delivery_scene,omitempty"`
	// AdType 广告类型，允许值：
	// GENERAL 通投广告
	// SEARCHING 搜索广告
	// 当marketing_goal=VIDEO_IMAGE 短视频/图文 && local_delivery_scene=CONTENT_HEAT 内容加热 时，不支持传入SEARCHING
	AdType local.AdType `json:"ad_type,omitempty"`
	// DeliveryGoal 投放内容，允许值：
	// POI 门店
	// PRODUCT 商品
	// 填写说明：
	// 仅marketing_goal=VIDEO_AND_IMAGE时，该字段生效且必填；当marketing_goal=LIVE时，该字段无效
	// 当marketing_goal=VIDEO_AND_IMAGE且
	// local_delivery_scene=POI_RECOMMEND 门店引流时，仅支持POI
	DeliveryGoal local.DeliveryGoal `json:"delivery_goal,omitempty"`
	// DeliveryPoiMode 是否投放全部门店，允许值：
	// ALL 投放全部门店
	// PART 投放指定门店，需同时传入promotion_poi_ids
	// 填写说明：
	// 当 marketing_goal=VIDEO_AND_IMAGE且delivery_goal=POI时，有效且必传
	DeliveryPoiMode local.DeliveryPoiMode `json:"delivery_poi_mode,omitempty"`
	// PromotionPoiIDs 推广门店ID列表
	// 填写说明：
	// 当delivery_goal=POI且 delivery_poi_mode=CUSTOM 投放指定门店时，有效且必填
	PromotionPoiIDs []uint64 `json:"promotion_poi_ids,omitempty"`
	// ProductID 推广商品ID，可通过【获取可投商品列表】接口查询获取
	// 填写说明：
	// 当marketing_goal=VIDEO_AND_IMAGE 且 delivery_goal=PRODUCT 时有效且必填
	ProductID uint64 `json:"product_id,omitempty"`
	// AwemeID 用于推广直播间的抖音号，可通过【获取本地推创编可用抖音号】接口获取
	// 填写说明：
	// 当marketing_goal=LIVE时有效且必填
	AwemeID string `json:"aweme_id,omitempty"`
	// ExternalAction 优化目标
	// 填写说明：
	// 当marketing_goal=VIDEO_AND_IMAGE短视频时：
	// local_delivery_scene=PRODUCT_PURCHASE团购成交或POI_ATTRACTION门店引流时，不支持传入优化目标
	// local_delivery_scene=CONTENT_HEAT内容加热时，允许值：
	// NATIVE_ACTION 用户互动
	// FOLLOW_ACTION 粉丝增长
	// SHOW展示量
	// 当marketing_goal=LIVE 直播：
	// local_delivery_scene=PRODUCT_PURCHASE团购成交时：
	// 当ad_type= GENERAL 通投广告时，允许值：
	// LIVE_OTO_GROUP_BUYING 直播间团购购买
	// LIVE_OTO_CLICK 商品点击
	// 当ad_type= SEARCHING搜索广告时，允许值：
	// LIVE_OTO_GROUP_BUYING 直播间团购购买
	// local_delivery_scene=CONTENT_HEAT 内容加热时：
	// 当ad_type= GENERAL 通投广告时，允许值：
	// LIVE_ENGAGE 直播加热
	// FOLLOWER_COUNT 粉丝增长
	// SHOW 展示
	// 当ad_type= SEARCHING 搜索广告时，允许值：
	// LIVE_ENTER_ACTION直播间观看
	// LIVE_STAY_TIME 直播间停留
	ExternalAction local.ExternalAction `json:"external_action,omitempty"`
	// Audience 定向设置，接口暂不支持设置抖音达人定向，该定向默认不限
	Audience *Audience `json:"audience,omitempty"`
	// ScheduleType 投放日期类型设置，允许值：
	// FROM_NOW_ON 从今天起长期投放
	// START_TO_END 设置开始结束时间
	// FIXED_TIME 固定时长
	// 仅营销场景=LIVE直播时，该枚举值有效，否则传入报错
	ScheduleType local.ScheduleType `json:"schedule_type,omitempty"`
	// ScheduleFixedSeconds 直播固定投放时长（单位：秒）
	// 填写说明：
	// 仅当营销场景=LIVE && schedule_type=FIXED_TIME 固定时长时有效且必填，其他情况传入报错
	// 输入值需不小于1800，且为1800的整数倍（即半个小时为最小粒度）
	ScheduleFixedSeconds int64 `json:"schedule_fixed_seconds,omitempty"`
	// StartTime 开始投放时间，精确到天，例如：2017-01-01
	// 当schedule_type=START_TO_END时，有效且必填
	// 广告投放起始时间不允许修改
	// 开始时间不得大于结束时间，且开始时间内不得小于今天
	StartTime string `json:"start_time,omitempty"`
	// EndTime 结束投放时间，精确到天，例如：2017-01-01
	// 当schedule_type=START_TO_END时，有效且必填
	// 结束时间不得小于开始时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时段，默认全时段投放。格式是48*7位字符串，且都是0或1，也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	// 当schedule_type=FIXED_TIME固定时长时，该字段无效，传入会报错
	// 例如：000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000，则投放时段为周一到周日的11:30~13:30
	ScheduleTime string `json:"schedule_time,omitempty"`
	// BidType 出价方式，允许值：
	// MANUAL 手动出价
	// SMART 智能出价
	// 填写说明：
	// 优化目标= SHOW 展示量 时，仅支持MANUAL 手动出价
	// 营销目标=LIVE && 推广目的= CONTENT_HEAT内容加热 && 优化目标=LIVE_ENGAGEMENT时，仅支持SMART 智能出价
	BidType local.BidType `json:"bid_type,omitempty"`
	// Bid 出价，当出价方式=MANUAL 手动出价时有效
	// 出价单位：分
	// 展示量取值范围为[400,10000]，其他场景取值范围为[1, 1000000]
	// 【展示量】：分/千次曝光
	Bid int64 `json:"bid,omitempty"`
	// BudgetMode 预算模式设置，允许值：
	// BUDGET_MODE_DAY 日预算
	// BUDGET_MODE_TOTAL 总预算
	// 填写说明：
	// 当sceduale_type=FIXED_TIME固定时长时，仅支持BUDGET_MODE_TOTAL总预算
	// 当sceduale_type=FROM_NOW_ON或START_TO_END时，仅支持BUDGET_MODE_DAY日预算
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 项目预算，单位为：分
	// 填写限制：
	// 当budget_mode=BUDGET_MODE_DAY 日预算 && bid_type=SMART 智能出价时，取值范围为[10000, 999999999]
	// 当budget_mode=BUDGET_MODE_DAY 日预算 && bid_type=MANUAL 手动出价时，取值范围为[30000, 999999999]
	// 当budget_mode=BUDGET_MODE_TOTAL 总预算时，取值范围为[30000, 999999999]
	Budget int64 `json:"budget,omitempty"`
	// IsSetPeakBudget 高峰日预算设置，仅当营销场景为短视频，且推广目的=团购成交或门店引流时，该字段有效且必填，允许值：
	// TURE 开启
	// FALSE 关闭
	// 该字段为FALSE时：高峰日（自然周、节假日）、高峰日预算上调比例 均不可填值
	IsSetPeakBudget string `json:"is_set_peak_budget,omitempty"`
	// PeakWeekDays 高峰日-自然周，允许值：
	// MONDAY 周一
	// TUESDAY 周二
	// WEDNESDAY 周三
	// THURSDAY 周四
	// FRIDAY 周五
	// SATURDAY 周六
	// SUNDAY 周日
	// 注意：peak_holidays和peak_week_days不可同时为空，必须传入至少一个高峰日
	PeakWeekDays []enum.Weekday `json:"peak_week_days,omitempty"`
	// PeakHolidays 高峰日-节假日，允许值：
	// NEW_YEAR 元旦
	// SPRING_FESTIVAL 春节
	// VALENTINES_DAY 情人节
	// LABOUR_DAY 五一
	// DRAGON_BOAT_FESTIVAL 端午
	// CHINESE_VALENTINES_DAY 七夕
	// MOON_FESTIVAL 中秋
	// NATIONAL_DAY 国庆
	// CHRISTMAS 圣诞节
	// SHOPPING_DAY_618 618
	// SHOPPING_DAY_1111 双11
	// 注意：peak_holidays和peak_week_days不可同时为空，必须传入至少一个高峰日
	PeakHolidays []enum.Holiday `json:"peak_holidays,omitempty"`
	// HighBudgetRate 高峰日预算上调比例，单位为百分比，例如：传“40”表示高峰日时预算上调“40%”
	// 当is_set_peak_budget = TURE开启高峰日预算时有效且必填
	// 区间限制： 20～200
	HighBudgetRate int `json:"high_budget_rate,omitempty"`
}

CreateRequest 创建项目 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implements 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 CustomArea

type CustomArea struct {
	// Geolocation 地理位置设置，数量上限：1000
	Geolocation []Geolocation `json:"geolocation,omitempty"`
}

CustomArea 自定义区域设置

type DetailRequest

type DetailRequest struct {
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
}

DetailRequest 获取项目详情 API Request

func (DetailRequest) Encode

func (r DetailRequest) Encode() string

Encode implements GetRequest interface

type DetailResponse

type DetailResponse struct {
	// Project 项目详情
	Data *ProjectDetail `json:"data,omitempty"`
	model.BaseResponse
}

DetailResponse 获取项目详情 API Response

type Geolocation

type Geolocation struct {
	// Name 地点名称
	Name string `json:"name,omitempty"`
	// AreaRadius 半径
	AreaRadius int64 `json:"area_radius,omitempty"`
	// Long 经度
	Long float64 `json:"long,omitempty"`
	// Lat 纬度
	Lat float64 `json:"lat,omitempty"`
}

Geolocation 地理位置信息

type ListRequest

type ListRequest struct {
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// Filtering 过滤字段
	Filtering *ListRequestFilter `json:"filtering,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，最大值100，默认值20
	PageSize int `json:"page_size,omitempty"`
}

ListRequest 获取项目列表 API Request

func (ListRequest) Encode

func (r ListRequest) Encode() string

Encode implements GetRequest interface

type ListRequestFilter

type ListRequestFilter struct {
	// ProjectIDs 项目IDs筛选，最多100个
	ProjectIDs []uint64 `json:"project_ids,omitempty"`
	// ProjectStatusFirst 项目一级状态筛选，允许值：
	// PROJECT_STATUS_ALL 不限（包含已删除）
	// PROJECT_STATUS_DELETE 已删除
	// PROJECT_STATUS_DISABLE 未投放
	// PROJECT_STATUS_DONE 已完成
	// PROJECT_STATUS_ENABLE 启用中
	// PROJECT_STATUS_NOT_DELETE 不限（不包含已删除）
	// 默认值: PROJECT_STATUS_NOT_DELETE 不限（不包含已删除）
	ProjectStatusFirst local.ProjectStatus `json:"project_status_first,omitempty"`
	// ProjectStatusSecond 项目二级状态筛选，允许值：
	// PROJECT_STATUS_BUDGET_EXCEED 项目超出预算
	// PROJECT_STATUS_DISABLE 已暂停
	// PROJECT_STATUS_NOT_SCHEDULE 不在投放时段
	// PROJECT_STATUS_NOT_START 未达投放时间
	// 仅当status_first = PROJECT_STATUS_DISABLE 未投放时传入有效
	ProjectStatusSecond local.ProjectStatus `json:"project_status_second,omitempty"`
	// ShopIDs 按门店IDs筛选，单次限制最多10个
	ShopIDs []uint64 `json:"shop_ids,omitempty"`
	// ProductIDs 按商品IDs筛选，单次限制最多10个
	ProductIDs []uint64 `json:"product_ids,omitempty"`
	// LocalDeliveryScene 推广目的筛选，默认不限，允许值：
	// ALL 不限
	// CONTENT_HEAT 内容加热
	// POI_RECOMMEND 门店引流
	// PRODUCT_PAY 团购成交
	// 默认值: ALL
	LocalDeliveryScene local.LocalDeliveryScene `json:"local_delivery_scene,omitempty"`
	// MarketingGoal 营销场景筛选，默认不限 ，允许值：
	// ALL 不限
	// LIVE 直播
	// VIDEO_IMAGE 短视频/图文
	// 默认值: ALL
	MarketingGoal local.MarketingGoal `json:"marketing_goal,omitempty"`
	// AdType 广告类型筛选，默认不限，允许值：
	// ALL 不限
	// GENERAL 通投广告
	// SEARCHING 搜索广告
	// 默认值: ALL
	AdType local.AdType `json:"ad_type,omitempty"`
	// ProjectName 项目名称，模糊搜索
	ProjectName string `json:"project_name,omitempty"`
	// ProjectCreateTimeStart 项目创建开始时间，格式yyyy-MM-dd HH:mm:ss，与project_create_time_end搭配使用
	ProjectCreateTimeStart string `json:"project_create_time_start,omitempty"`
	// ProjectCreateTimeEnd 项目创建结束时间，格式yyyy-MM-dd HH:mm:ss，与project_create_time_start搭配使用
	ProjectCreateTimeEnd string `json:"project_create_time_end,omitempty"`
	// ProjectModifyTimeStart 项目更新开始时间，格式yyyy-MM-dd HH:mm:ss，与project_modify_time_end搭配使用
	ProjectModifyTimeStart string `json:"project_modify_time_start,omitempty"`
	// ProjectModifyTimeEnd 项目更新结束时间，格式yyyy-MM-dd HH:mm:ss，与project_modify_time_start搭配使用
	ProjectModifyTimeEnd string `json:"project_modify_time_end,omitempty"`
	// BidType 出价方式，默认不限，允许值：
	// ALL 不限
	// MANUAL 手动出价
	// SMART 智能出价
	// 默认值: ALL
	BidType local.BidType `json:"bid_type,omitempty"`
}

type ListResponse

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

ListResponse 获取项目列表 API Response

type ListResult

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

type PoiAround

type PoiAround struct {
	// PoiIDs 定向门店id列表，可通过【获取门店列表】接口查询
	// 数量上限：2000
	// 「短视频推门店」无需传入，自动定位至推广的门店附近
	// 填写说明：
	// marketing_goal=LIVE直播 && district =POI_AROUND门店附近，该字段有效且必填
	// 门店id要求：传入门店id需为本广告账户下的门店ID
	// marketing_goal=VIDEO_AND_IMAGE短视频/图文，且delivery_content_type=PRODUCT为商品，且district =POI_AROUND时，该字段有效。
	// 门店id要求：传入门店id必须为推广的商品适用门店
	// 所推广的商品适用门店数大于2000时必填，且最多传入2000个；
	// 所推广的商品适用门店数不超过2000时，不传默认推商品适用门店附近
	// marketing_goal=VIDEO_AND_IMAGE短视频/图文 && delivery_content_type=POI门店时，该字段无效，无需传入。选择门店附近定向，则默认投所推广的门店附近（仅推广门店数不超过2000家时可选择门店附近定向）
	PoiIDs []uint64 `json:"poi_ids,omitempty"`
	// PoiAroundRadius 半径，门店附近仅支持固定半径的设置，允许值：
	// KM_6 门店附近6km
	// KM_8 门店附近8km
	// KM_10 门店附近10km（默认值）
	// KM_12 门店附近12km
	// KM_15 门店附近15km
	// KM_20 门店附近20km
	PoiAroundRadius local.PoiAroundRadius `json:"poi_around_radius,omitempty"`
}

PoiAround 门店附近定向设置

type PoiInfo

type PoiInfo struct {
	// PoiID 门店id
	// 仅推广单门店项目返回，推广多门店时不返回
	PoiID uint64 `json:"poi_id,omitempty"`
	// PoiName 门店名称
	// 仅推广单门店项目返回，推广多门店时不返回
	PoiName string `json:"poi_name,omitempty"`
	// PoiImageURL 门店头图
	// 仅推广单门店项目返回，推广多门店时不返回
	PoiImageURL string `json:"poi_image_url,omitempty"`
	// MultiPoiNum 推广门店数量
	MultiPoiNum int `json:"multi_poi_num,omitempty"`
	// AllPoiMod 推广门店类型，枚举值：
	// ALL 全部门店
	// PART 指定门店
	AllPoiMode local.DeliveryPoiMode `json:"all_poi_mode,omitempty"`
	// AutoUpdatePoi 是否自动更新门店，枚举值:
	AutoUpdatePoi string `json:"auto_update_poi,omitempty"`
}

PoiInfo 项目推广门店信息

type Project

type Project struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// ProjectStatusFirst 项目一级状态
	ProjectStatusFirst local.ProjectStatus `json:"project_status_first,omitempty"`
	// ProjectStatusSecond 项目二级状态
	ProjectStatusSecond []local.ProjectStatus `json:"project_status_second,omitempty"`
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// AdType 广告类型
	AdType local.AdType `json:"ad_type,omitempty"`
	// MarketingGoal 营销场景
	MarketingGoal local.MarketingGoal `json:"marketing_goal,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"`
	// ExternalAction 优化目标，枚举值：
	// FOLLOW_ACTION 粉丝增长
	// LIVE_ENGAGEMENT 直播加热
	// LIVE_ENTER_ACTION 直播间观看
	// LIVE_OTO_CLICK 直播间商品点击
	// LIVE_OTO_GROUP_BUYING 直播间团购购买
	// LIVE_STAY_TIME 直播间停留NATIVE_ACTION 用户互动
	// SHOW 展示量
	// OTO_PAY 团购购买
	// POI_RECOMMEND 门店引流
	ExternalAction local.ExternalAction `json:"external_action,omitempty"`
	// DeliveryGoal 投放内容，枚举值：
	// POI 门店
	// PRODUCT 商品
	DeliveryGoal local.DeliveryGoal `json:"delivery_goal,omitempty"`
	// ProjectBudgetMode 项目预算类型，枚举值：
	// BUDGET_MODE_DAY 日预算
	// BUDGET_MODE_TOTAL 总预算
	ProjectBudgetMode enum.BudgetMode `json:"project_budget_mode,omitempty"`
	// ProjectBudget 项目预算，单位为：分
	ProjectBudget int64 `json:"project_budget,omitempty"`
	// BidType 出价方式，枚举值：
	// MANUAL 手动出价
	// SMART 智能出价
	BidType local.BidType `json:"bid_type,omitempty"`
	// ProjectBid 项目出价，单位为：分
	ProjectBid int64 `json:"project_bid,omitempty"`
	// StartTime 投放开始时间，如：2017-01-01 精确到天
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间，如：2017-01-01 精确到天
	EndTime string `json:"end_time,omitempty"`
	// PoiInfo 项目推广门店信息
	PoiInfo *PoiInfo `json:"poi_info,omitempty"`
	// ProductInfo 商品信息
	ProductInfo *product.Product `json:"product_info,omitempty"`
	// DeliveryPoiMode 本地投放模式
	DeliveryPoiMode local.DeliveryPoiMode `json:"delivery_poi_mode,omitempty"`
}

Project 项目

type ProjectDetail

type ProjectDetail struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// ProjectStatusFirst 项目一级状态
	ProjectStatusFirst local.ProjectStatus `json:"project_status_first,omitempty"`
	// ProjectStatusSecond 项目二级状态
	ProjectStatusSecond []local.ProjectStatus `json:"project_status_second,omitempty"`
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// AwemeID 抖音号ID
	AwemeID string `json:"aweme_id,omitempty"`
	// AdType 广告类型
	AdType local.AdType `json:"ad_type,omitempty"`
	// LocalDeliveryScene 本地投放场景
	LocalDeliveryScene local.LocalDeliveryScene `json:"local_delivery_scene,omitempty"`
	// MarketingGoal 营销场景
	MarketingGoal local.MarketingGoal `json:"marketing_goal,omitempty"`
	// Name 项目名称
	Name string `json:"name,omitempty"`
	// ExternalAction 优化目标，枚举值：
	// FOLLOW_ACTION 粉丝增长
	// LIVE_ENGAGEMENT 直播加热
	// LIVE_ENTER_ACTION 直播间观看
	// LIVE_OTO_CLICK 直播间商品点击
	// LIVE_OTO_GROUP_BUYING 直播间团购购买
	// LIVE_STAY_TIME 直播间停留NATIVE_ACTION 用户互动
	// SHOW 展示量
	// OTO_PAY 团购购买
	// POI_RECOMMEND 门店引流
	ExternalAction local.ExternalAction `json:"external_action,omitempty"`
	// DeliveryGoal 投放内容，枚举值：
	// POI 门店
	// PRODUCT 商品
	DeliveryGoal local.DeliveryGoal `json:"delivery_goal,omitempty"`
	// BudgetMode 项目预算类型，枚举值：
	// BUDGET_MODE_DAY 日预算
	// BUDGET_MODE_TOTAL 总预算
	BudgetMode enum.BudgetMode `json:"budget_mode,omitempty"`
	// Budget 项目预算，单位为：分
	Budget int64 `json:"budget,omitempty"`
	// BidType 出价方式，枚举值：
	// MANUAL 手动出价
	// SMART 智能出价
	BidType local.BidType `json:"bid_type,omitempty"`
	// Bid 项目出价，单位为：分
	Bid int64 `json:"bid,omitempty"`
	// StartTime 投放开始时间，如：2017-01-01 精确到天
	StartTime string `json:"start_time,omitempty"`
	// EndTime 投放结束时间，如：2017-01-01 精确到天
	EndTime string `json:"end_time,omitempty"`
	// DeliveryPoiMode 本地投放模式
	DeliveryPoiMode local.DeliveryPoiMode `json:"delivery_poi_mode,omitempty"`
	// AutoUpdatePois 自动更新门店开启状态，仅推广全部门店项目返回，枚举值：
	// OFF 不启用
	// ON 启用
	AutoUpdatePois enum.OnOff `json:"auto_update_pois,omitempty"`
	// PoiID 门店id
	// 当项目推广单个门店时返回
	PoiID uint64 `json:"poi_id,omitempty"`
	// MultiPoiNum 推广门店数量
	MultiPoiNum int `json:"multi_poi_num,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
	// ScheduleType 投放日期类型 ，枚举值：
	// FROM_NOW_ON 从今天起长期投放
	// START_TO_END 设置开始结束时间
	// FIXED_TIME 固定时长投放
	ScheduleType local.ScheduleType `json:"schedule_type,omitempty"`
	// ScheduleFixedSeconds 投放时长，单位为秒
	ScheduleFixedSeconds int64 `json:"schedule_fixed_seconds,omitempty"`
	// ScheduleTime 投放时段
	// 格式是48*7位字符串，且都是0或1。也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	// 例如：000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000，则投放时段为周一到周日的11:30~13:30
	ScheduleTime string `json:"schedule_time,omitempty"`
	// IsSetPeakBudget 是否设置峰值预算
	IsSetPeakBudget bool `json:"is_set_peak_budget,omitempty"`
	// HighBudgetRate 上调高峰日预算比例
	// 注意：该字段为百分比，例如：传“40”表示高峰日时预算上调“40%”
	HighBudgetRate int `json:"high_budget_rate,omitempty"`
	// PeakWeekDays 高峰日-自然周
	PeakWeekDays []enum.Weekday `json:"peak_week_days,omitempty"`
	// PeakHolidays 高峰日-节假日
	PeakHolidays []enum.Holiday `json:"peak_holidays,omitempty"`
	// Audience 定向设置
	Audience *Audience `json:"audience,omitempty"`
}

ProjectDetail 项目详情

type Region

type Region struct {
	// City 地域定向省市或者区县列表(当传递省份ID时，旗下市县ID可省略不传)，通过【获取行政信息】接口获取
	City []uint64 `json:"city,omitempty"`
	// CityDivide 城市划分类型，允许值：
	// BY_LEVEL 按发展等级划分
	// BY_LOCATION 按地理划分（默认值）
	CityDivide local.CityDivide `json:"city_divide,omitempty"`
	// LocationType 区域内人群定向设置，允许值：
	// ALL 该地区的所有用户
	// CURRENT 正在该地区的用户（默认值）
	// HOME 居住在该地区的用户
	// TRAVEL 到该地区旅行的用户
	LocationType local.LocationType `json:"location_type,omitempty"`
	// RegionVer 行政区域版本号，通过【获取行政信息】接口获取
	RegionVer string `json:"region_ver,omitempty"`
}

Region 行政区域信息

type StatusUpdateItem

type StatusUpdateItem struct {
	// ProjectID 项目id
	ProjectID uint64 `json:"project_id,omitempty"`
	// OptStatus 目标操作
	// 目标操作，可选值:
	// ENABLE 启用项目
	// PAUSED 暂停项目
	// 对于删除的广告项目不可进行任何操作，否则会报错
	OptStatus string `json:"opt_status,omitempty"`
}

StatusUpdateItem 批量更新项目

type StatusUpdateRequest

type StatusUpdateRequest struct {
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// Data 批量更新项目状态，包含项目ID和目标操作，list长度限制1～50
	Data []StatusUpdateItem `json:"data,omitempty"`
}

StatusUpdateRequest 批量更新项目状态 API Request

func (StatusUpdateRequest) Encode

func (r StatusUpdateRequest) Encode() []byte

Encode implements PostRequest interface

type StatusUpdateResponse

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

StatusUpdateResponse 批量更新项目状态 API Response

type UpdateError

type UpdateError struct {
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// ErrorMessage 失败信息
	ErrorMessage string `json:"error_message,omitempty"`
}

UpdateError 更新失败的项目列表

func (UpdateError) Error

func (e UpdateError) Error() string

type UpdateRequest

type UpdateRequest struct {
	// LocalAccountID 本地推广告账户ID
	LocalAccountID uint64 `json:"local_account_id,omitempty"`
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
	// Name 项目名称，长度是1-50个字（两个英文字符占1个字）
	Name string `json:"name,omitempty"`
	// Audience 定向设置，接口暂不支持设置抖音达人定向，该定向默认不限
	Audience *Audience `json:"audience,omitempty"`
	// ScheduleType 投放日期类型设置，允许值：
	// FROM_NOW_ON 从今天起长期投放
	// START_TO_END 设置开始结束时间
	// FIXED_TIME 固定时长
	// 仅营销场景=LIVE直播时，该枚举值有效，否则传入报错
	ScheduleType local.ScheduleType `json:"schedule_type,omitempty"`
	// ScheduleFixedSeconds 直播固定投放时长（单位：秒）
	// 填写说明：
	// 仅当营销场景=LIVE && schedule_type=FIXED_TIME 固定时长时有效且必填，其他情况传入报错
	// 输入值需不小于1800，且为1800的整数倍（即半个小时为最小粒度）
	ScheduleFixedSeconds int64 `json:"schedule_fixed_seconds,omitempty"`
	// EndTime 结束投放时间，精确到天，例如：2017-01-01
	// 当schedule_type=START_TO_END时，有效且必填
	// 结束时间不得小于开始时间
	EndTime string `json:"end_time,omitempty"`
	// ScheduleTime 投放时段，默认全时段投放。格式是48*7位字符串，且都是0或1，也就是以半个小时为最小粒度，周一至周日每天分为48个区段，0为不投放，1为投放，不传、全传0、全传1均代表全时段投放。
	// 当schedule_type=FIXED_TIME固定时长时，该字段无效，传入会报错
	// 例如：000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000000000000000000000000001111000000000000000000000，则投放时段为周一到周日的11:30~13:30
	ScheduleTime string `json:"schedule_time,omitempty"`
	// Bid 出价，当出价方式=MANUAL 手动出价时有效
	// 出价单位：分
	// 展示量取值范围为[400,10000]，其他场景取值范围为[1, 1000000]
	// 【展示量】：分/千次曝光
	Bid int64 `json:"bid,omitempty"`
	// Budget 项目预算，单位为：分
	// 填写限制：
	// 当budget_mode=BUDGET_MODE_DAY 日预算 && bid_type=SMART 智能出价时，取值范围为[10000, 999999999]
	// 当budget_mode=BUDGET_MODE_DAY 日预算 && bid_type=MANUAL 手动出价时，取值范围为[30000, 999999999]
	// 当budget_mode=BUDGET_MODE_TOTAL 总预算时，取值范围为[30000, 999999999]
	Budget int64 `json:"budget,omitempty"`
	// IsSetPeakBudget 高峰日预算设置，仅当营销场景为短视频，且推广目的=团购成交或门店引流时，该字段有效且必填，允许值：
	// TURE 开启
	// FALSE 关闭
	// 该字段为FALSE时：高峰日（自然周、节假日）、高峰日预算上调比例 均不可填值
	IsSetPeakBudget string `json:"is_set_peak_budget,omitempty"`
	// PeakWeekDays 高峰日-自然周，允许值：
	// MONDAY 周一
	// TUESDAY 周二
	// WEDNESDAY 周三
	// THURSDAY 周四
	// FRIDAY 周五
	// SATURDAY 周六
	// SUNDAY 周日
	// 注意：peak_holidays和peak_week_days不可同时为空，必须传入至少一个高峰日
	PeakWeekDays []enum.Weekday `json:"peak_week_days,omitempty"`
	// PeakHolidays 高峰日-节假日，允许值：
	// NEW_YEAR 元旦
	// SPRING_FESTIVAL 春节
	// VALENTINES_DAY 情人节
	// LABOUR_DAY 五一
	// DRAGON_BOAT_FESTIVAL 端午
	// CHINESE_VALENTINES_DAY 七夕
	// MOON_FESTIVAL 中秋
	// NATIONAL_DAY 国庆
	// CHRISTMAS 圣诞节
	// SHOPPING_DAY_618 618
	// SHOPPING_DAY_1111 双11
	// 注意：peak_holidays和peak_week_days不可同时为空，必须传入至少一个高峰日
	PeakHolidays []enum.Holiday `json:"peak_holidays,omitempty"`
	// HighBudgetRate 高峰日预算上调比例，单位为百分比，例如：传“40”表示高峰日时预算上调“40%”
	// 当is_set_peak_budget = TURE开启高峰日预算时有效且必填
	// 区间限制： 20～200
	HighBudgetRate int `json:"high_budget_rate,omitempty"`
}

UpdateRequest 更新项目 API Request

func (UpdateRequest) Encode

func (r UpdateRequest) Encode() []byte

Encode implements PostRequest interface

type UpdateResult

type UpdateResult struct {
	// ProjectIDs 更新成功的项目ID
	ProjectIDs []uint64 `json:"project_ids,omitempty"`
	// Errors 更新失败的项目列表
	Errors []UpdateError `json:"errors,omitempty"`
}