tools

Documentation

Overview

Package tools 查询工具

Index

• type AllowCouponRequest
  • func (r AllowCouponRequest) Encode() string
• type AllowCouponResponse
• type AllowCouponResult
• type AwemeAllowCoupon
• type AwemeAuthRequest
  • func (r AwemeAuthRequest) Encode() []byte
• type AwemeAuthResponse
• type EstimateAudienceRequest
  • func (r EstimateAudienceRequest) Encode() string
• type EstimateAudienceResponse
• type EstimateAudienceResult
• type GrayGetResponse
• type GrayGetResult
• type ProductAllowCoupon
• type ShopAuthRequest
  • func (r ShopAuthRequest) Encode() []byte

Types

type AllowCouponRequest

type AllowCouponRequest struct {
	// AdvertiserID 千川广告主账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MarketingGoal 营销目标，允许值：
	// VIDEO_PROM_GOODS 推商品
	// LIVE_PROM_GOODS 推直播间
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// CampaignScene 营销场景 ，允许值：
	// DAILY_SALE日常销售
	//  NEW_CUSTOMER_CONVERT新客转化
	CampaignScene qianchuan.CampaignScene `json:"campaign_scene,omitempty"`
	// MarketingScene 广告类型，允许值：
	// FEED 通投广告
	// SEARCH 搜索广告
	// SHOPPING_MALL商城广告
	MarketingScene qianchuan.MarketingScene `json:"marketing_scene,omitempty"`
	// AwemeIDs 抖音id，即商品广告背后关联的抖音号，可通过【查询可推广抖音号列表】接口获取名下可推广抖音号
	AwemeIDs []uint64 `json:"aweme_ids,omitempty"`
	// ProductIDs 商品id列表，即准备推广的商品列表，可通过【查询店铺商品列表】接口获取名下可推广商品
	ProductIDs []uint64 `json:"product_ids,omitempty"`
}

AllowCouponRequest 智能优惠券白名单 API Request

func (AllowCouponRequest) Encode

func (r AllowCouponRequest) Encode() string

Encode implement GetRequest interface

type AllowCouponResponse

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

AllowCouponResponse 智能优惠券白名单 API Response

type AllowCouponResult

type AllowCouponResult struct {
	// AdvAllowCoupon 广告主是否支持智能优惠券
	// true：支持
	// fale：不支持
	AdvAllowCoupon bool `json:"adv_allow_coupon,omitempty"`
	// AwemeAllowCoupon 抖音号是否支持智能优惠券信息
	AwemeAllowCoupon []AwemeAllowCoupon `json:"aweme_allow_coupon,omitempty"`
	// ProductAllowCoupon 商品是否支持智能优惠券信息
	ProductAllowCoupon []ProductAllowCoupon `json:"product_allow_coupon,omitempty"`
}

type AwemeAllowCoupon

type AwemeAllowCoupon struct {
	// AwemeID 抖音号id，入參包含aweme_id时返回
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// AllowCoupon 抖音号是否支持智能优惠券
	// true：支持
	// fale：不支持
	AllowCoupon bool `json:"allow_coupon,omitempty"`
}

AwemeAllowCoupon 抖音号是否支持智能优惠券信息

type AwemeAuthRequest

type AwemeAuthRequest struct {
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 要授权的抖音号
	AwemeID string `json:"aweme_id,omitempty"`
	// Code 达人合作码
	Code string `json:"code,omitempty"`
	// AuthType 授权类型，可选值
	// 合作达人：AWEME_COOPERATOR，支持选取主页视频投放、支持推广该抖音号直播间
	// 自运营：SELF，支持选取主页视频投放、支持推广该抖音号直播间、支持发布视频到主页、支持获取抖音号数据(包括被投放广告数据、粉丝数据)
	AuthType enum.AwemeBindType `json:"auth_type,omitempty"`
	// EndTime 授权结束时间，格式为yyyy-MM-dd HH:mm:ss
	// 如果想要不限，end_time=2099-12-31 23:59:59
	EndTime string `json:"end_time,omitempty"`
}

AwemeAuthRequest 广告主添加抖音号 API Request

func (AwemeAuthRequest) Encode

func (r AwemeAuthRequest) Encode() []byte

Encode implemnet PostRequest interface

type AwemeAuthResponse

type AwemeAuthResponse struct {
	model.BaseResponse
	Data struct {
		// AuthSuccess 授权状态，返回值：true 授权成功、false授权失败
		AuthSuccess bool `json:"auth_success,omitempty"`
	} `json:"data,omitempty"`
}

AwemeAuthResponse 广告主添加抖音号 API Response

type EstimateAudienceRequest

type EstimateAudienceRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// MarketingGoal 可选值:
	// LIVE_PROM_GOODS: 直播间带货
	// VIDEO_PROM_GOODS: 短视频带货
	MarketingGoal enum.MarketingGoal `json:"marketing_goal,omitempty"`
	// ExternalAction 短视频带货目的允许值：
	// AD_CONVERT_TYPE_SHOPPING 商品购买
	// AD_CONVERT_TYPE_QC_FOLLOW_ACTION 粉丝提升
	// AD_CONVERT_TYPE_QC_MUST_BUY 点赞评论
	// 注意：搜索广告短视频带货只支持AD_CONVERT_TYPE_SHOPPING直播带货目的允许值：
	// AD_CONVERT_TYPE_LIVE_ENTER_ACTION 进入直播间
	// AD_CONVERT_TYPE_LIVE_CLICK_PRODUCT_ACTION 直播间商品点击
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_ACTION 直播间下单
	// AD_CONVERT_TYPE_NEW_FOLLOW_ACTION 直播间粉丝提升
	// AD_CONVERT_TYPE_LIVE_COMMENT_ACTION 直播间评论
	// AD_CONVERT_TYPE_LIVE_SUCCESSORDER_PAY直播间成交
	ExternalAction qianchuan.ExternalAction `json:"external_action,omitempty"`
	// ProductID 商品ID
	ProductID uint64 `json:"product_id,omitempty"`
	// AwemeID 抖音号ID
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// Audience 定向设置
	Audience *ad.Audience `json:"audience,omitempty"`
}

EstimateAudienceRequest 获取定向受众预估 API Request

func (EstimateAudienceRequest) Encode

func (r EstimateAudienceRequest) Encode() string

Encode implement GetRequest interface

type EstimateAudienceResponse

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

EstimateAudienceResponse 获取定向受众预估 API Response

type EstimateAudienceResult

type EstimateAudienceResult struct {
	// CrowdCoverTotal 用户覆盖数
	CrowdCoverTotal int64 `json:"crowd_cover_total,omitempty"`
	// ShowCntTotal 广告展示数
	ShowCntTotal int64 `json:"show_cnt_total,omitempty"`
}

type GrayGetResponse

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

GrayGetResponse 查询白名单能力 API Response

type GrayGetResult

type GrayGetResult struct {
	// SuccessList 命中白名单请求
	SuccessList []tools.GrayItem `json:"success_list,omitempty"`
	// ErrorList 如果用户传入的key不存在/错误，会在该list中返回
	ErrorList []string `json:"error_list,omitempty"`
}

type ProductAllowCoupon

type ProductAllowCoupon struct {
	// ProductID 商品id，入參包含product_id时返回
	ProductID uint64 `json:"product_id,omitempty"`
	// AllowCoupon 抖音号是否支持智能优惠券
	// true：支持
	// fale：不支持
	AllowCoupon bool `json:"allow_coupon,omitempty"`
}

ProductAllowCoupon 商品是否支持智能优惠券信息

type ShopAuthRequest

type ShopAuthRequest struct {
	// AdvertiserID 广告账户id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// ShopID 要授权的店铺id
	ShopID uint64 `json:"shop_id,omitempty"`
	// ShopAuthTimeType 授权时间类型，默认不限，允许值
	// NONE 不限
	// CUSTOM 自定义
	ShopAuthTimeType string `json:"shop_auth_time_type,omitempty"`
	// EndTime 授权结束时间，当shop_auth_time_type=CUSTOM时必填
	// 格式为yyyy-MM-dd HH:mm:ss
	EndTime string `json:"end_time,omitempty"`
}

ShopAuthRequest 店铺新客定向授权 API Request

func (ShopAuthRequest) Encode

func (r ShopAuthRequest) Encode() []byte

Encode implement PostRequest interface