enterprise

Documentation

Index

• type AuthorizeTimes
• type BasicData
• type BindItem
• type Filter
• type FlowCategoryData
• type GetBindListRequest
  • func (r GetBindListRequest) Encode() string
• type GetBindListResponse
• type GetDataRequest
  • func (r GetDataRequest) Encode() string
• type GetFlowCategoryResponse
• type GetOverviewResponse
• type GetVideoInfoDataResponse
• type Item
• type ListItemRequest
  • func (r ListItemRequest) Encode() string
• type ListItemResponse
• type ListMediaRequest
  • func (r ListMediaRequest) Encode() string
• type ListMediaResponse
• type Media
• type OpenIDFilter
• type OverviewData
• type VideoInfoData

Types

type AuthorizeTimes

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

type BasicData

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

type BindItem

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

type Filter

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

Filter

type FlowCategoryData

type FlowCategoryData struct {
	StartTimeDay      string `json:"start_time_day"`      // 数据统计时间
	FirstFlowCategory string `json:"first_flow_category"` // 流量来源名称
	BasicData
}

type GetBindListRequest

type GetBindListRequest struct {
	AdvertiserId uint64 `json:"advertiser_id"`
}

func (GetBindListRequest) Encode

func (r GetBindListRequest) Encode() string

type GetBindListResponse

type GetBindListResponse struct {
	model.BaseResponse
	Data struct {
		List []*BindItem `json:"list"`
	} `json:"data"`
}

type GetDataRequest

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

func (GetDataRequest) Encode

func (r GetDataRequest) Encode() string

type GetFlowCategoryResponse

type GetFlowCategoryResponse struct {
	model.BaseResponse
	Data struct {
		List         []*FlowCategoryData `json:"list"`
		TotalMetrics BasicData           `json:"total_metrics"`
		TotalRatio   BasicData           `json:"total_ratio"`
	} `json:"data"`
	// TotalCount 总数
	TotalCount int `json:"total_count,omitempty"`
	// TotalPage 总页数
	TotalPage int `json:"total_page,omitempty"`
}

type GetOverviewResponse

type GetOverviewResponse struct {
	model.BaseResponse
	Data struct {
		List         []*OverviewData `json:"list"`
		TotalMetrics BasicData       `json:"total_metrics"`
		TotalRatio   BasicData       `json:"total_ratio"`
	} `json:"data"`
	// TotalCount 总数
	TotalCount int `json:"total_count,omitempty"`
	// TotalPage 总页数
	TotalPage int `json:"total_page,omitempty"`
}

type GetVideoInfoDataResponse

type GetVideoInfoDataResponse struct {
	model.BaseResponse
	Data struct {
		List         []*VideoInfoData `json:"list"`
		TotalMetrics BasicData        `json:"total_metrics"`
		TotalRatio   BasicData        `json:"total_ratio"`
	} `json:"data"`
	// TotalCount 总数
	TotalCount int `json:"total_count,omitempty"`
	// TotalPage 总页数
	TotalPage int `json:"total_page,omitempty"`
}

type Item

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

type ListItemRequest

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

func (ListItemRequest) Encode

func (r ListItemRequest) Encode() string

type ListItemResponse

type ListItemResponse struct {
	model.BaseResponse
	Data struct {
		ItemList []*Item `json:"item_list"`
	} `json:"data"`
}

type ListMediaRequest

type ListMediaRequest struct {
	EDouyinId string `json:"e_douyin_id" required:"true"` // 企业号账户ID，获取到授权的纵横组织ID后，再通过【获取纵横组织下资产账户列表（分页）】接口，查询到e_douyin_id，即为企业号账户ID，需确保传入的企业号账户ID与纵横组织ID已建立绑定关系，且绑定关系未解除
	Page      int    `json:"page"`                        // 页数，默认值：1
	PageSize  int    `json:"page_size"`                   // 页面大小，支持范围1-100 之间，默认值：20
}

func (ListMediaRequest) Encode

func (r ListMediaRequest) Encode() string

type ListMediaResponse

type ListMediaResponse struct {
	model.BaseResponse
	Data struct {
		ItemList []*Media `json:"item_list"`
	} `json:"data"`
}

type Media

type Media struct {
	MediaID   string `json:"media_id"`   // 素材ID
	MediaType string `json:"media_type"` // 素材类型 (枚举值：IMAGE 图片素材、PDF PDF素材)
	URL       string `json:"url"`        // 素材URL
	Status    string `json:"status"`     // 素材审核状态 (枚举值：INVALID 无效/逻辑删除、VALID 有效、AUDITING 审核中、AUDIT_FAIL 审核不通过)
	URI       string `json:"uri"`        // 素材URI
}

type OpenIDFilter

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

type OverviewData

type OverviewData struct {
	BasicData
	StartTimeDay string `json:"start_time_day"` // 数据统计时间
}

type VideoInfoData

type VideoInfoData struct {
	StartTimeDay string `json:"start_time_day"` // 数据统计时间
	VideoId      string `json:"video_id"`       // 视频itemId
	BasicData
}