v3

Documentation

Overview

Package v3 定向包相关V3

Index

• type AudiencePackage
• type BindInfoGetRequest
  • func (r BindInfoGetRequest) Encode() string
• type BindInfoGetResponse
• type BindInfoGetResult
• type BindProject
• type GetFiltering
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResult

Types

type AudiencePackage

type AudiencePackage struct {
	audiencepackage.AudienceBase
	// FilterAwemeAbnormalActive （抖音号推广特有）过滤高活跃用户; 取值：0表示不过滤，1表示过滤
	FilterAwemeAbnormalActive enum.OnOff `json:"filter_aweme_abnormal_active,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InterestActionMode 行为兴趣选择，枚举值：
	// UNLIMITED（不限），CUSTOM（自定义），RECOMMEND（系统推荐）
	InterestActionMode enum.InterestActionMode `json:"interest_action_mode,omitempty"`
	// AudiencePackageID 定向包id
	AudiencePackageID uint64 `json:"audience_package_id,omitempty"`
	// Name 定向包名称
	Name string `json:"name,omitempty"`
	// Description 定向包描述
	Description string `json:"description,omitempty"`
	// LandingType 定向包推广类型
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// AdType 广告类型，允许值：
	// ALL 所有广告（默认值）
	// SEARCH 搜索广告
	// 搜索定向包仅支持落地页、应用推广、抖音号、直播间，不支持商品、电商店铺、快应用、小游戏
	AdType enum.CampaignType `json:"ad_type,omitempty"`
	// MarketingGoal 营销场景：VIDEO_AND_IMAGE 短视频/图片， LIVE 直播
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// DeliveryRange 广告投放范围【附录：广告投放范围】
	DeliverRange enum.AdDeliveryRange `json:"delivery_range,omitempty"`
	// HideIfExists 已安装用户，0表示不限，1表示过滤，2表示定向；过滤表示投放时不给安装客户展示广告，支持应用推广；定向表示投放时给安装客户展示广告；投放时优先获取直达链接，无直达链接时使用应用包名进行投放；如果无直达链接或应用包名，定向安装选项实际不生效；定向仅对Android链接生效。
	// 过滤已安装
	// UNLIMITED不限（默认值）
	// FILTER 过滤，仅安卓应用推广时支持，其他情况传入不生效
	// TARGETING 定向
	HideIfExists enum.HideIfExists `json:"hide_if_exists,omitempty"`
	// FiltetEvent 自定义过滤事件
	// 枚举值：
	// 优化目标：AD_CONVERT_EXTERNAL_ACTION
	// 激活：AD_CONVERT_TYPE_ACTIVE
	// 注册：AD_CONVERT_TYPE_ACTIVE_REGISTER
	// 付费：AD_CONVERT_TYPE_PAY
	FilterEvent []enum.AudiencePackageFiltetEvent `json:"filter_event,omitempty"`
	// HideIfConverted 过滤已转化
	// 枚举值：NO_EXCLUDE 不限制、PROMOTION 广告、PROJECT 项目、ADVERTISER 广告账户、APP 应用、CUSTOMER 客户、ORGANIZATION 组织（仅加白广告主可用）
	HideIfConverted enum.HideIfConverted `json:"hide_if_converted,omitempty"`
	// ConvertedTimeDuration 过滤时间范围，详见， 【附录-过滤时间范围】，当过滤已转化用户类型选择"公司账户"时填写，教育行业专属，非教育行业不会生效
	ConvertedTimeDuration enum.ConvertedTimeDuration `json:"converted_time_duration,omitempty"`
	// CarrierRegionOptimize 运营商号段开关，枚举值：ON 开启 / OFF 关闭
	CarrierRegionOptimize enum.OnOff `json:"carrier_region_optimize,omitempty"`
}

AudiencePackage 定向包信息

type BindInfoGetRequest

type BindInfoGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AudiencePackageID 定向包ID
	AudiencePackageID uint64 `json:"audience_package_id,omitempty"`
	// Page 分页
	Page int `json:"page,omitempty"`
	// Size  分页尺寸
	Size int `json:"size,omitempty"`
}

BindInfoGetRequest 定向包查询关联项目信息 API Request

func (BindInfoGetRequest) Encode

func (r BindInfoGetRequest) Encode() string

Encode implements GetRequest interface

type BindInfoGetResponse

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

BindInfoGetResponse 定向包查询关联项目信息 API Response

type BindInfoGetResult

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

type BindProject

type BindProject struct {
	// ProjectName 项目名称
	ProjectName string `json:"project_name,omitempty"`
	// ProjectID 项目ID
	ProjectID uint64 `json:"project_id,omitempty"`
}

BindProject 项目信息

type GetFiltering

type GetFiltering struct {
	// Name 定向包名称（支持模糊查询）
	// LandingType 定向包类型
	LandingType enum.LandingType `json:"landing_type,omitempty"`
	// DeliveryRange 广告投放范围
	DeliveryRange enum.AdDeliveryRange `json:"delivery_range,omitempty"`
	// AdType 广告类型，允许值：
	// ALL 所有广告（默认值）
	// SEARCH 搜索广告
	// 搜索定向包仅支持落地页、应用推广、抖音号、直播间，不支持商品、电商店铺、快应用、小游戏
	AdType enum.CampaignType `json:"ad_type,omitempty"`
	// MarketingGoal 营销场景，允许值：VIDEO_AND_IMAGE 短视频/图片（默认值）， LIVE 直播
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
}

GetFiltering 过滤字段

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤字段
	Filtering *GetFiltering `json:"filtering,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 页面数据量
	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 {
	// Data json返回值
	Data *GetResult `json:"data,omitempty"`
	model.BaseResponse
}

GetResponse 获取定向包 API Response

type GetResult

type GetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// AudiencePackages 定向包信息
	AudiencePackages []audiencepackage.AudiencePackage `json:"audience_packages,omitempty"`
}

GetResult json返回值