enterprise

package
v1.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package enterprise 企业号相关 API

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthorizeTime added in v1.19.8 

type AuthorizeTime struct {
	// AuthorizeStartTime 授权开始时间
	AuthorizeStartTime string `json:"authorize_start_time,omitempty"`
	// AuthorizeEndTime 授权结束时间
	AuthorizeEndTime string `json:"authorize_end_time,omitempty"`
}

AuthorizeTime 授权有效期

type BindItem 

type BindItem struct {
	// OpenID 抖音号open_id（含企业号open_id）
	OpenID string `json:"open_id,omitempty"`
	// AwemeID 抖音号id（含企业号id）
	AwemeID string `json:"aweme_id,omitempty"`
	// AwemeName 抖音号名称（含企业号名称）
	AwemeName string `json:"aweme_name,omitempty"`
	// AwemeAvatar 抖音号头像（含企业号头像）
	AwemeAvatar string `json:"aweme_avatar,omitempty"`
	// AuthorizeTimes 授权有效期
	AuthorizeTimes []AuthorizeTime `json:"authorize_times,omitempty"`
}

BindItem 关联的抖音号

type BindListGetRequest added in v1.19.8 

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

BindListGetRequest 获取广告主关联的企业号列表 API Request

func (BindListGetRequest) Encode added in v1.19.8 

func (r BindListGetRequest) Encode() string

Encode implement GetRequest interface

type BindListGetResponse added in v1.19.8 

type BindListGetResponse struct {
	model.BaseResponse
	Data struct {
		// List 关联的抖音号列表（含企业号）
		List []BindItem `json:"list"`
	} `json:"data"`
}

BindListGetResponse 获取广告主关联的企业号列表 API Response

type Dimension added in v1.19.8 

type Dimension struct {
	// StartTimeDay 数据统计时间
	StartTimeDay string `json:"start_time_day,omitempty"`
	// FirstFlowCategory 流量来源名称
	FirstFlowCategory string `json:"first_flow_category,omitempty"`
	// VideoID 视频itemId
	VideoID uint64 `json:"video_id,omitempty"`
}

type Enterprise added in v1.19.8 

type Enterprise struct {
	// EDouyinID 企业号ID
	EDouyinID string `json:"e_douyin_id,omitempty"`
	// EDouyinName 企业号名称
	EDouyinName string `json:"e_douyin_name,omitempty"`
}

Enterprise 企业号信息

type InfoRequest added in v1.19.8 

type InfoRequest struct {
	// EDouyinIDs 企业号ids，一次传入id数量不超过10个
	EDouyinIDs []string `json:"e_douyin_ids,omitempty"`
}

InfoRequest 获取企业号信息 API Request

func (InfoRequest) Encode added in v1.19.8 

func (r InfoRequest) Encode() string

Encode implement GetRequest interface

type InfoResponse added in v1.19.8 

type InfoResponse struct {
	model.BaseResponse
	Data struct {
		List []Enterprise `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

InfoResponse 获取企业号信息 API Response

type Item 

type Item struct {
	// ItemType 视频类型 允许值：ITEM_AD广告视频、ITEM_CONTENT非广告视频(抖音视频)
	ItemType enterprise.ItemType `json:"item_type,omitempty"`
	// MaterialID 广告视频素材id
	MaterialID int `json:"material_id,omitempty"`
	// ItemID 抖音视频id
	ItemID model.Uint64 `json:"item_id,omitempty"`
	// ItemTitle 抖音视频标题
	ItemTitle string `json:"item_title,omitempty"`
	// ItemCoverURL 抖音视频封面url
	ItemCoverURL string `json:"item_cover_url,omitempty"`
	// ItemDuration 抖音视频时长 单位是秒
	ItemDuration int64 `json:"item_duration,omitempty"`
	// ItemCreateTime 抖音视频发布时间
	ItemCreateTime string `json:"item_create_time,omitempty"`
	// CommentCount 评论数量
	CommentCount model.Int64 `json:"comment_count,omitempty"`
}

Item 视频

type ItemListFilter added in v1.19.8 

type ItemListFilter struct {
	// ItemType 视频类型 允许值：ITEM_AD广告视频、ITEM_CONTENT非广告视频(抖音视频)
	ItemType enterprise.ItemType `json:"item_type,omitempty"`
}

ItemListFilter 筛选字段

type ItemListRequest added in v1.19.8 

type ItemListRequest struct {
	// CcAccountID 纵横组织ID，纵横组织管理员或协作者授权后，通过【获取已授权账户】接口，查询到“账号角色为CUSTOMER_ADMIN-管理员授权的纵横组织、或CUSTOMER_OPERATOR-协作者授权的纵横组织”的advertiser_id，即为纵横组织ID
	CcAccountID uint64 `json:"cc_account_id"`
	// EDouyinID 企业号账户ID，获取到授权的纵横组织ID后，再通过【获取纵横组织下资产账户列表（分页）】接口，查询到e_douyin_id，即为企业号账户ID，需确保传入的企业号账户ID与纵横组织ID已建立绑定关系，且绑定关系未解除
	EDouyinID string `json:"e_douyin_id"`
	// StartTime 开始时间，默认30天前 只支持天级的。e.g.2022-01-01 开始时间必须大于2021-01-01
	StartTime string `json:"start_time,omitempty"`
	// EndTime 结束时间，默认当天 只支持天级的。e.g.2022-01-02 结束时间必须晚于开始时间，查询时间跨度不能大于3个月
	EndTime string `json:"end_time,omitempty"`
	// Filter 筛选字段
	Filter *ItemListFilter `json:"filter,omitempty"`
	// Page 页数，默认值：1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，支持范围1-100 之间，默认值：20
	PageSize int `json:"page_size,omitempty"`
}

ItemListRequest 获取企业号视频列表 API Request

func (ItemListRequest) Encode added in v1.19.8 

func (r ItemListRequest) Encode() string

Encode implement GetRequest interface

type ItemListResponse added in v1.19.8 

type ItemListResponse struct {
	model.BaseResponse
	Data struct {
		ItemList []Item `json:"item_list,omitempty"`
	} `json:"data,omitempty"`
}

ItemListResponse 获取企业号视频列表 API Response

type Metrics added in v1.19.8 

type Metrics struct {
	// BusinessPageHomeVisited 主页访问量
	BusinessPageHomeVisited model.Int64 `json:"business_page_home_visited,omitempty"`
	// BusinessPageHomeVisitedUCount 主页访问人数
	BusinessPageHomeVisitedUCount model.Int64 `json:"business_page_home_visited_ucount,omitempty"`
	// BusinessPageFansNumAll 总粉丝数
	BusinessPageFansNumAll model.Int64 `json:"business_page_fans_num_all,omitempty"`
	// BusinessPageNewFansNum 新增粉丝人数
	BusinessPageNewFansNum model.Int64 `json:"business_page_new_fans_num,omitempty"`
	// BusinessPageDisfollowUCount  流失粉丝人数
	BusinessPageDisfollowUCount model.Int64 `json:"business_page_disfollow_ucount,omitempty"`
	// BusinessPageComment 评论提交数
	BusinessPageComment model.Int64 `json:"business_page_comment,omitempty"`
	// BusinessPageLike 点赞数
	BusinessPageLike model.Int64 `json:"business_page_like,omitempty"`
	// BusinessPageShare 分享数
	BusinessPageShare model.Int64 `json:"business_page_share,omitempty"`
	// BusinessPageDpDownClickCnt 保存数
	BusinessPageDpDownClickCnt model.Int64 `json:"business_page_dp_down_click_cnt,omitempty"`
	// BusinessPageFavouriteVideoCnt 收藏数
	BusinessPageFavouriteVideoCnt model.Int64 `json:"business_page_favourite_video_cnt,omitempty"`
	// BusinessPageFwVideoVV 转发数
	BusinessPageFwVideoVV model.Int64 `json:"business_page_fw_video_vv"`
	// BusinessPagePlayOver 播放完成数
	BusinessPagePlayOver model.Int64 `json:"business_page_play_over"`
	// BusinessPageTotalPlay 播放数
	BusinessPageTotalPlay model.Int64 `json:"business_page_total_play"`
	// BusinessPageDislikeCnt 不感兴趣数
	BusinessPageDislikeCnt model.Int64 `json:"business_page_dislike_cnt"`
	// BusinessPageChatByShareVideoCnt 视频私信分享数
	BusinessPageChatByShareVideoCnt model.Int64 `json:"business_page_chat_by_share_video_cnt"`
	// BusinessPageClickCartCount 查看购物车数
	BusinessPageClickCartCount model.Int64 `json:"business_page_click_cart_count"`
	// BusinessPageClickProduct 商品点击数
	BusinessPageClickProduct model.Int64 `json:"business_page_click_product"`
	// BusinessPageClickProductGoBuy 去购买点击数
	BusinessPageClickProductGoBuy model.Int64 `json:"business_page_click_product_go_buy"`
	// BusinessPageOrderCount 商品下单数
	BusinessPageOrderCount model.Int64 `json:"business_page_order_count"`
	// BusinessPagePayOrderCount 商品订单数
	BusinessPagePayOrderCount model.Int64 `json:"business_page_pay_order_count"`
	// BusinessPagePayOrderGMV 商品订单金额
	BusinessPagePayOrderGMV model.Float64 `json:"business_page_pay_order_gmv"`
}

Metrics 指标

type OperationLog added in v1.19.8 

type OperationLog struct {
	// CreateTime 操作时间
	CreateTime string `json:"create_time,omitempty"`
	// BusinessPageOperationType 企业号推广操作类型
	// LIVE 直播开始、VIDEO 发布视频、DOU 开启DOU+推广、AD 开启广告投放
	BusinessPageOperationType enterprise.OperationType `json:"business_page_operation_type,omitempty"`
	// RoomID 直播间ID
	RoomID uint64 `json:"room_id,omitempty"`
	// RoomTitle 直播间名称
	RoomTitle string `json:"room_title,omitempty"`
	// RoomCover 直播间封面
	RoomCover string `json:"room_cover,omitempty"`
	// VideoID 视频ID
	VideoID uint64 `json:"video_id,omitempty"`
	// VideoImage 视频缩略图
	VideoImage string `json:"video_image,omitempty"`
	// Budget DOU+投放金额,元
	Budget float64 `json:"budget,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID列表
	AdID []uint64 `json:"ad_id,omitempty"`
}

OperationLog 推广操作记录

type OperationLogGetRequest added in v1.19.8 

type OperationLogGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// OpenID 企业号open_id
	OpenID string `json:"open_id,omitempty"`
	// StartTime 查询时间，格式为yyyy-mm-dd ，默认为今天，仅支持查询2020年11月1日之后的数据
	StartTime string `json:"start_time,omitempty"`
	// Offset 偏移，类似于SQL中offset（起始为0，翻页时new_offset=old_offset+limit），默认值：0，取值范围:≥ 0
	Offset int `json:"offset,omitempty"`
	// Limit 返回数据量，默认值：100，取值范围：1-100
	Limit int `json:"limit,omitempty"`
}

OperationLogGetRequest 获取企业号推广操作记录 API Request

func (OperationLogGetRequest) Encode added in v1.19.8 

func (r OperationLogGetRequest) Encode() string

Encode implement GetRequest interface

type OperationLogGetResponse added in v1.19.8 

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

OperationLogGetResponse 获取企业号推广操作记录 API Response

type OperationLogGetResult added in v1.19.8 

type OperationLogGetResult struct {
	// ActionCount 推广操作次数
	ActionCount int `json:"action_count,omitempty"`
	// Offset 偏移
	Offset int `json:"offset,omitempty"`
	// List 推广操作记录列表
	List []OperationLog `json:"list,omitempty"`
}

type ReportFilter added in v1.19.8 

type ReportFilter struct {
	// OpenID 抖音号open_id，同时支持查询企业号和普通抖音号数据
	OpenID string `json:"open_id,omitempty"`
}

type ReportRequest added in v1.19.8 

type ReportRequest struct {
	// AdvertiserID 广告主ID (必填)
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// StartTime 报表开始时间，格式为yyyy-mm-dd，仅支持查询2020年11月1日之后的数据 (必填)
	StartTime string `json:"start_time,omitempty"`
	// EndTime 报表结束时间，格式为yyyy-mm-dd，最大时间范围365天 (必填)
	EndTime string `json:"end_time,omitempty"`
	// LastStartTime 环比周期开始时间，格式为yyyy-mm-dd
	LastStartTime string `json:"last_start_time,omitempty"`
	// LastEndTime 环比周期结束时间，格式为yyyy-mm-dd
	LastEndTime string `json:"last_end_time,omitempty"`
	// Fields 指标字段，默认传入指标：business_page_home_visited、business_page_new_fans_num、business_page_like、business_page_total_play，若需自定义，请点击查看各维度下支持查询的指标，否则会报错
	Fields []string `json:"fields,omitempty"`
	// RatioFields 需要环比指标字段
	RatioFields []string `json:"ratio_fields,omitempty"`
	// TimeDimension 是否需要分天数据，默认值SUM允许值：SUM 合计数据、DAILY 分天数据
	TimeDimension enterprise.TimeDimension `json:"time_dimension,omitempty"`
	// OrderFIeld 排序指标字段，不传默认为空
	OrderField string `json:"order_field,omitempty"`
	// OrderType 排序类型；默认值: DESC允许值: ASC、 DESC，未传入order_field时不生效
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Filter 筛选字段
	Filter *ReportFilter `json:"filter,omitempty"`
	// Offset 偏移，类似于SQL中offset（起始为0，翻页时new_offset=old_offset+limit），默认值：0，取值范围:≥ 0
	Offset int `json:"offset,omitempty"`
	// Limit 返回数据量，默认值：100，取值范围：1-100
	Limit int `json:"limit,omitempty"`
}

ReportRequest 获取数据 API Request

func (ReportRequest) Encode added in v1.19.8 

func (r ReportRequest) Encode() string

type ReportResponse added in v1.19.8 

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

ReportResponse 获取数据 API Response

type ReportResult added in v1.19.8 

type ReportResult struct {
	// List 指标列表
	List         []Stat   `json:"list,omitempty"`
	TotalMetrics *Metrics `json:"total_metrics,omitempty"`
	TotalRatio   *Metrics `json:"total_ratio,omitempty"`
	// TotalCount 总数
	TotalCount int `json:"total_count,omitempty"`
	// Offset 偏移
	Offset int `json:"offset,omitempty"`
}

type Stat added in v1.19.8 

type Stat struct {
	Dimension
	Metrics
}

Stat

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.