Documentation
¶
Overview ¶
Package comment 评论管理
Index ¶
- type AwemeBandedCreateRequest
- type AwemeBandedCreateResponse
- type AwemeBandedCreateResponseData
- type AwemeBandedListRequest
- type AwemeBandedListResponse
- type AwemeBandedListResponseData
- type BandedAweme
- type Comment
- type FailItem
- type GetFilter
- type GetRequest
- type GetResponse
- type GetResponseData
- type OperateRequest
- type OperateResponse
- type Reply
- type ReplyGetRequest
- type ReplyGetResponse
- type ReplyGetResponseData
- type StickOnTopRequest
- type TermsBannedAddRequest
- type TermsBannedDeleteRequest
- type TermsBannedGetRequest
- type TermsBannedGetResponse
- type TermsBannedGetResponseData
- type TermsBannedUpdateRequest
- type UserInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AwemeBandedCreateRequest ¶
type AwemeBandedCreateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 为绑定的抖音号添加屏蔽词, 只允许传入1个,通过【获取绑定的抖音号】 接口获取,当is_apply_to_adv不传或为false时,aweme_id生效 AwemeID string `json:"aweme_id,omitempty"` // IsApplyToAdv 是否应用于当前账户,当is_apply_to_adv不传或为false时,aweme_id生效 IsApplyToAdv bool `json:"is_apply_to_adv,omitempty"` // BandedType 屏蔽类型,; 允许值:CUSTOM_TYPE:自定义规则,根据昵称关键词屏蔽;AWEME_TYPE:根据抖音id屏蔽。 BandedType string `json:"banded_type,omitempty"` // AwemeUserIDs 抖音用户id列表,传入屏蔽用户的抖音号;当banned_type为AWEME_TYPE时必填;每次最多传50个抖音id,纯数字id不能以0开头;一个抖音号最多屏蔽5000个抖音ID。 AwemeUserIDs []string `json:"aweme_user_ids,omitempty"` // NicknameKeywords 抖音昵称关键词列表,当banned_type为CUSTOM_TYPE时必填;关键词长度不大于40个字符,中文算2个字符;每次最多传50个关键词;最多屏蔽5000个关键词。 NicknameKeywords []string `json:"nickname_keywords,omitempty"` }
AwemeBandedCreateRequest 添加屏蔽用户 API Request
func (AwemeBandedCreateRequest) Encode ¶
func (r AwemeBandedCreateRequest) Encode() []byte
Encode implement PostRequest interface
type AwemeBandedCreateResponse ¶
type AwemeBandedCreateResponse struct { model.BaseResponse // Data json 返回值 Data *AwemeBandedCreateResponseData `json:"data,omitempty"` }
AwemeBandedCreateResponse 添加屏蔽用户 API Response
type AwemeBandedCreateResponseData ¶
type AwemeBandedCreateResponseData struct { // Success 屏蔽成功的昵称关键词列表或抖音id列表 Success []string `json:"success,omitempty"` // Fail 屏蔽失败的昵称关键词列表或抖音id列表 Fail []FailItem `json:"fail,omitempty"` }
AwemeBandedCreateResponseData json返回值
type AwemeBandedListRequest ¶
type AwemeBandedListRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 为绑定的抖音号添加屏蔽词, 只允许传入1个,通过【获取绑定的抖音号】 接口获取,当is_apply_to_adv不传或为false时,aweme_id生效 AwemeID string `json:"aweme_id,omitempty"` // IsApplyToAdv 是否应用于当前账户,当is_apply_to_adv不传或为false时,aweme_id生效 IsApplyToAdv bool `json:"is_apply_to_adv,omitempty"` // BandedType 屏蔽类型,; 允许值:CUSTOM_TYPE:自定义规则,根据昵称关键词屏蔽;AWEME_TYPE:根据抖音id屏蔽。 BandedType string `json:"banded_type,omitempty"` // AwemeUserID 抖音用户id AwemeUserID string `json:"aweme_user_id,omitempty"` // NicknameKeyword 昵称关键词,最大不超过20字 NicknameKeyword string `json:"nickname_keyword,omitempty"` // Page 页数 默认值: 1 Page int `json:"page,omitempty"` // PageSize 页面大小默认值: 10 PageSize int `json:"page_size,omitempty"` }
AwemeBandedList 获取屏蔽用户列表 API Request
func (AwemeBandedListRequest) Encode ¶
func (r AwemeBandedListRequest) Encode() string
Encode implement GetRequest interface
type AwemeBandedListResponse ¶
type AwemeBandedListResponse struct { model.BaseResponse // Data json 返回值 Data *AwemeBandedListResponseData `json:"data,omitempty"` }
AwemeBandedListResponse 获取屏蔽用户列表 API Response
type AwemeBandedListResponseData ¶
type AwemeBandedListResponseData struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // List 结果列表 List []BandedAweme `json:"list,omitempty"` }
AwemeBandedListResponseData json 返回值
type BandedAweme ¶
type BandedAweme struct { // AwemeUserID 抖音id AwemeUserID string `json:"aweme_user_id,omitempty"` // AwemeName 抖音昵称 AwemeName string `json:"aweme_name,omitempty"` // BandedType 屏蔽类型,CUSTOM_TYPE:自定义规则,根据昵称关键词屏蔽;AWEME_TYPE:根据抖音id屏蔽。 BandedType string `json:"banded_type,omitempty"` // NicknameKeyword 昵称关键词 NicknameKeyword string `json:"nickname_keyword,omitempty"` }
BandedAweme 屏蔽用户
type Comment ¶
type Comment struct { // ID 评论ID ID uint64 `json:"comment_id,omitempty"` // Text 评论内容 Text string `json:"text,omitempty"` // CreateTime 评论创建时间 CreateTime string `json:"create_time,omitempty"` // ReplyCount 评论的回复数量 ReplyCount int `json:"reply_count,omitempty"` // LikeCount 点赞数 LikeCount int `json:"like_count,omitempty"` // ReplyStatus 评论回复状态,REPLIED表示已回复,NO_REPLY表示未回复 ReplyStatus enum.CommentReplyStatus `json:"reply_status,omitempty"` // HideStatus 隐藏状态, 可选值: // ALL: 全部 // HIDE: 已隐藏 // NOT_HIDE: 未隐藏 HideStatus enum.CommentHideStatus `json:"hide_status,omitempty"` // 评论情感, 可选值: // NEGATIVE: 负向评论 // NEUTRAL: 中性评论 // POSITIVE: 正向评论 EmotionType enum.CommentEmotionType `json:"emotion_type,omitempty"` // IsStick 该评论是否置顶,0:表示不置顶,1:表示置顶 IsStick int `json:"is_stick,omitempty"` // AwemeID 评论用户抖音号 AwemeID string `json:"aweme_id,omitempty"` // AwemeName 评论用户昵称 AwemeName string `json:"aweme_name,omitempty"` // AdID 计划ID ,仅1.0平台适用 AdID uint64 `json:"ad_id,omitempty"` // AdName 计划名 AdName string `json:"ad_name,omitempty"` // CreativeID 评论所属创意id CreativeID uint64 `json:"creative_id,omitempty"` // PromotionID 广告id,仅2.0平台适用 PromotionID uint64 `json:"promotion_id,omitempty"` // ItemID 广告视频ID ItemID uint64 `json:"item_id,omitempty"` // ItemTitle 视频标题 ItemTitle string `json:"item_title,omitempty"` }
Comment 评论
type FailItem ¶
type FailItem struct { // Message 失败原因 Message string `json:"message,omitempty"` // ResultKey 屏蔽失败的昵称关键词列表或抖音id ResultKey string `json:"result_key,omitempty"` }
FailItem 失败信息
type GetFilter ¶ added in v1.9.24
type GetFilter struct { // AdIDs 计划id列表,一次最多10个 AdIDs []uint64 `json:"ad_ids,omitempty"` // CreativeIDs 广告创意id列表,一次最多100个,仅当platform_version=V1时传入生效 CreativeIDs []uint64 `json:"creative_ids,omitempty"` // ItemIDs 广告视频id列表,一次最多100个,仅当platform_version=V2时传入生效,可通过【获取抖音授权关系】获取item_id和视频相关信息 ItemIDs []uint64 `json:"item_ids,omitempty"` // BindRelation 抖音号分类,可选值: // ALL: 全部抖音号(默认值) // BIND_AWEME: 绑定的抖音号 // VIRTUAL_AWEME: 虚拟抖音号 BindRelation string `json:"bind_relation,omitempty"` // LevelType 查询的评论等级,可选值: // LEVEL_ALL: 所有评论(默认值) // LEVEL_ONE: 一级评论 // LEVEL_TWO: 二级评论 LevelType enum.CommentLevelType `json:"level_type,omitempty"` // IsReplied 是否已回复 IsReplied bool `json:"is_replied,omitempty"` // HideStatus 隐藏状态, 可选值: // ALL: 全部(默认值) // HIDE: 已隐藏 // NOT_HIDE: 未隐藏 HideStatus enum.CommentHideStatus `json:"hide_status,omitempty"` // EmotionType 评论情感, 可选值: // NEGATIVE: 负向评论 // NEUTRAL: 中性评论 // POSITIVE: 正向评论 EmotionType enum.CommentEmotionType `json:"emotion_type,omitempty"` }
type GetRequest ¶
type GetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // PlatformVersion 查询的平台版本,查询体验版需传入V2,允许值: // V1: 1.0平台(默认值) // V2: 2.0平台 PlatformVersion string `json:"platform_version,omitempty"` // StartTime 查询起始时间,格式:yyyy-MM-dd,若不填,默认6天前(即获取最近七天的内容) StartTime string `json:"start_time,omitempty"` // EndTime 查询截止时间,格式:yyyy-MM-dd,若不填,默认当天 EndTime string `json:"end_time,omitempty"` // IncludeMetrics 是否包含计算指标,传入True则返回负评数和负评率,默认为True IncludeMetrics bool `json:"include_metrics,omitempty"` // OrderField 排序字段,允许值: // REPLY_COUNT按评论回复数量排序 // LIKE_COUNT 按点赞数量排序 // CREATE_TIME 按评论时间排序(默认值) OrderField string `json:"order_field,omitempty"` // OrderType 排序类型,允许值: // ASC: 升序 // DESC: 降序(默认值) OrderType enum.OrderType `json:"order_type,omitempty"` // Page 页数 默认值: 1 Page int `json:"page,omitempty"` // PageSize 页面大小默认值: 10 PageSize int `json:"page_size,omitempty"` // Filtering 过滤条件,若此字段不传,或传空则视为无限制条件 Filtering *GetFilter `json:"filtering,omitempty"` }
GetRequest 获取评论列表 API Request
func (GetRequest) Encode ¶
func (r GetRequest) Encode() string
Encode implement GetRequest interface
type GetResponse ¶
type GetResponse struct { model.BaseResponse // Data json 返回值 Data *GetResponseData `json:"data,omitempty"` }
GetResponse 获取评论列表 API Response
type GetResponseData ¶
type GetResponseData struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // NegativeVolumn 负评数 NegativeVolumn int `json:"negative_volumn,omitempty"` // NegativeVolumnRate 负评率 NegativeVolumnRate float64 `json:"negative_volumn_rate,omitempty"` // CommentsList 评论列表 CommentsList []Comment `json:"comments_list,omitempty"` }
GetResponseData json 返回值
type OperateRequest ¶
type OperateRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // CommentIDs 评论id列表,只允许传入小于等于20个评论id CommentIDs []uint64 `json:"comment_ids,omitempty"` // ReplyText 回复内容,最多支持100字 ReplyText string `json:"reply_text,omitempty"` }
OperateRequest 评论操作 API Request
func (OperateRequest) Encode ¶
func (r OperateRequest) Encode() []byte
Encode implement PostRequest interface
type OperateResponse ¶
type OperateResponse struct { model.BaseResponse // Data json 返回值 Data struct { // SuccessCommentIDs 回复成功的评论id列表 SuccessCommentIDs []uint64 `json:"success_comment_ids,omitempty"` } `json:"data,omitempty"` }
OperateResponse 评论操作 API Response
type Reply ¶
type Reply struct { // ReplyToCommentID 回复的一级评论ID ReplyToCommentID json.Number `json:"reply_to_comment_id,omitempty"` // CommentID 评论id CommentID uint64 `json:"comment_id,omitempty"` // Text 评论内容 Text string `json:"text,omitempty"` // CreateTime 评论创建时间 CreateTime string `json:"create_time,omitempty"` // ReplyStatus 评论回复状态,可选值: // NO_REPLY: 未回复 // REPLY_AUDIT_FAIL: 回复审核拒接 // REPLY_AUDIT_SUCCESS: 回复审核通过 // REPLY_TO_AUDIT: 回复待审核 ReplyStatus enum.CommentReplyStatus `json:"reply_status,omitempty"` // LikeCount 点赞数 LikeCount int `json:"like_count,omitempty"` // HideStatus 隐藏状态, 可选值: // ALL: 全部 // HIDE: 已隐藏 // NOT_HIDE: 未隐藏 HideStatus enum.CommentHideStatus `json:"hide_status,omitempty"` // IsStick 该评论是否置顶,0:表示不置顶,1:表示置顶 IsStick int `json:"is_stick,omitempty"` // AwemeID 评论用户抖音号 AwemeID string `json:"aweme_id,omitempty"` // AwemeName 评论用户昵称 AwemeName string `json:"aweme_name,omitempty"` // ItemID 广告视频ID ItemID uint64 `json:"item_id,omitempty"` }
Reply 评论回复
type ReplyGetRequest ¶
type ReplyGetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // CommentID 父评论id CommentID uint64 `json:"comment_id,omitempty"` // Page 页数 默认值: 1 Page int `json:"page,omitempty"` // PageSize 页面大小默认值: 10 PageSize int `json:"page_size,omitempty"` }
ReplyGetRequest 获取评论回复列表 API Request
func (ReplyGetRequest) Encode ¶
func (r ReplyGetRequest) Encode() string
Encode implement GetRequest interface
type ReplyGetResponse ¶
type ReplyGetResponse struct { model.BaseResponse // Data json 返回值 Data *ReplyGetResponseData `json:"data,omitempty"` }
ReplyGetResponse 获取评论回复列表 API Response
type ReplyGetResponseData ¶
type ReplyGetResponseData struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // ReplyList 评论列表 ReplyList []Reply `json:"reply_list,omitempty"` }
ReplyGetResponseData json 返回值
type StickOnTopRequest ¶ added in v1.9.24
type StickOnTopRequest struct { // AdvertiserID 广告主id AdvertiserID uint64 `json:"advertiser_id,omitempty"` // CommentID 评论id CommentID uint64 `json:"comment_id,omitempty"` // 操作类型,可选值: // CANCEL_STICK: 取消置顶 // STICK_ON_TOP: 置顶 StickType enum.CommentStickType `json:"stick_type,omitempty"` }
StickOnTopRequest 置顶评论 API Request
func (StickOnTopRequest) Encode ¶ added in v1.9.24
func (r StickOnTopRequest) Encode() []byte
Encode implement PostRequest interface
type TermsBannedAddRequest ¶ added in v1.8.24
type TermsBannedAddRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 为绑定的抖音号添加屏蔽词, 只允许传入1个,通过【获取绑定的抖音号】 接口获取,当is_apply_to_adv不传或为false时,aweme_id生效 AwemeID string `json:"aweme_id,omitempty"` // IsApplyToAdv 是否应用于当前账户,当is_apply_to_adv不传或为false时,aweme_id生效 IsApplyToAdv bool `json:"is_apply_to_adv,omitempty"` // Terms 屏蔽词列表,若添加的屏蔽词已存在,不会再次新增,同一个屏蔽词只会在屏蔽词中记录一次,一次最多添加100个,单个屏蔽词长度范围为0-20字 Terms []string `json:"terms,omitempty"` }
TermsBannedAddRequest 添加屏蔽词 API Request
func (TermsBannedAddRequest) Encode ¶ added in v1.8.24
func (r TermsBannedAddRequest) Encode() []byte
Encode implement PostRequest interface
type TermsBannedDeleteRequest ¶ added in v1.8.24
type TermsBannedDeleteRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 为绑定的抖音号添加屏蔽词, 只允许传入1个,通过【获取绑定的抖音号】 接口获取,当is_apply_to_adv不传或为false时,aweme_id生效 AwemeID string `json:"aweme_id,omitempty"` // IsApplyToAdv 是否应用于当前账户,当is_apply_to_adv不传或为false时,aweme_id生效 IsApplyToAdv bool `json:"is_apply_to_adv,omitempty"` // Terms 屏蔽词列表,一次最多操作100个词,屏蔽词最大20字 Terms []string `json:"terms,omitempty"` }
TermsBannedDeleteRequest 删除屏蔽词 API Request
func (TermsBannedDeleteRequest) Encode ¶ added in v1.8.24
func (r TermsBannedDeleteRequest) Encode() []byte
Encode implement PostRequest interface
type TermsBannedGetRequest ¶ added in v1.8.24
type TermsBannedGetRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 为绑定的抖音号添加屏蔽词, 只允许传入1个,通过【获取绑定的抖音号】 接口获取,当is_apply_to_adv不传或为false时,aweme_id生效 AwemeID string `json:"aweme_id,omitempty"` // IsApplyToAdv 是否应用于当前账户,当is_apply_to_adv不传或为false时,aweme_id生效 IsApplyToAdv bool `json:"is_apply_to_adv,omitempty"` // Page 页数 默认值: 1 Page int `json:"page,omitempty"` // PageSize 页面大小默认值: 10 PageSize int `json:"page_size,omitempty"` }
TermsBannedGetRequest 获取屏蔽词列表 API Request
func (TermsBannedGetRequest) Encode ¶ added in v1.8.24
func (r TermsBannedGetRequest) Encode() string
Encode implement GetRequest interface
type TermsBannedGetResponse ¶ added in v1.8.24
type TermsBannedGetResponse struct { model.BaseResponse // Data json 返回值 Data *TermsBannedGetResponseData `json:"data,omitempty"` }
TermsBannedGetResponse 获取屏蔽词列表 API Response
type TermsBannedGetResponseData ¶ added in v1.8.24
type TermsBannedGetResponseData struct { // PageInfo 分页信息 PageInfo *model.PageInfo `json:"page_info,omitempty"` // Terms 屏蔽词列表 Terms []string `json:"terms,omitempty"` }
TermsBannedGetResponseData json 返回值
type TermsBannedUpdateRequest ¶ added in v1.8.24
type TermsBannedUpdateRequest struct { // AdvertiserID 广告主ID AdvertiserID uint64 `json:"advertiser_id,omitempty"` // AwemeID 为绑定的抖音号添加屏蔽词, 只允许传入1个,通过【获取绑定的抖音号】 接口获取,当is_apply_to_adv不传或为false时,aweme_id生效 AwemeID string `json:"aweme_id,omitempty"` // IsApplyToAdv 是否应用于当前账户,当is_apply_to_adv不传或为false时,aweme_id生效 IsApplyToAdv bool `json:"is_apply_to_adv,omitempty"` // OriginTerms 待更新的屏蔽词; 屏蔽词长度范围为0-100 OriginTerms []string `json:"origin_terms,omitempty"` // 更新后的屏蔽词; 如果new_terms已存在,则等同于删除origin_terms;如果origin_terms不存在,则等同于新增new_terms; 屏蔽词长度范围为0-100 NewTerms []string `json:"new_terms,omitempty"` }
TermsBannedUpdateRequest 更新屏蔽词 API Request
func (TermsBannedUpdateRequest) Encode ¶ added in v1.8.24
func (r TermsBannedUpdateRequest) Encode() []byte
Encode implement PostRequest interface