diagnosis

Documentation

Overview

Package diagnosis 获取计划诊断信息

Index

• type AdSuggestion
• type ImageMaterial
  • func (m ImageMaterial) Type() ObjectType
• type ObjectParam
• type ObjectType
• type Param
• type ParamValue
• type SuggestScene
• type Suggestion
• type SuggestionAcceptFailed
• type SuggestionAcceptRequest
  • func (r SuggestionAcceptRequest) Encode() []byte
• type SuggestionAcceptResponse
• type SuggestionAcceptResponseData
• type SuggestionGetRequest
  • func (r SuggestionGetRequest) Encode() string
• type SuggestionGetResponse
• type SuggestionGetResponseData
• type TitleMaterial
  • func (m TitleMaterial) Type() ObjectType
• type Tool
• type VideoMaterial

Types

type AdSuggestion

type AdSuggestion struct {
	// AdID 计划id
	AdID model.FlexUint64 `json:"ad_id,omitempty"`
	// SceneList 计划对应的场景列表
	SceneList []SuggestScene `json:"scene_list,omitempty"`
}

AdSuggestion 诊断建议

type ImageMaterial

type ImageMaterial struct {
	// ImageMode 素材类型枚举值
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// ImageID 图片素材URI
	ImageID string `json:"image_id,omitempty"`
}

ImageMaterial 图片素材对象

func (ImageMaterial) Type

func (m ImageMaterial) Type() ObjectType

Type implement ObjectType

type ObjectParam

type ObjectParam interface {
	Type() ObjectType
}

ObjectParam 对象列表类型参数

type ObjectType

type ObjectType int

ObjectType 对象类型

const (
	// ObjectType_TITLE 标题对象
	ObjectType_TITLE ObjectType = iota
	// ObjectType_IMAGE 图片素材对象
	ObjectType_IMAGE
	// ObjectType_VIDEO 视频素材对象
	ObjectType_VIDEO
)

type Param

type Param struct {
	// ParamName 工具参数名称
	ParamName string `json:"param_name,omitempty"`
	// ParamValue 工具参数值
	ParamValue ParamValue `json:"param_value,omitempty"`
}

Param 工具参数

type ParamValue

type ParamValue struct {
	// StringParam 字符类型参数
	StringParam string `json:"string_param,omitempty"`
	// BoolParam 布尔类型参数
	BoolParam string `json:"bool_param,omitempty"`
	// ListParam 列表类型参数
	ListParam []string `json:"list_param,omitempty"`
	// ObjectListParam 对象列表类型参数，详细信息见下方【工具参数名称&工具参数值 对应说明】
	ObjectListParam []ObjectParam `json:"object_list_param,omitempty"`
}

ParamValue 工具参数值

type SuggestScene

type SuggestScene struct {
	// Scene 场景名称，允许值：CLEAN清理低质计划场景、POTENTIAL获取潜力计划场景
	Scene string `json:"scene,omitempty"`
	// Suggestions 建议列表
	Suggestions []Suggestion `json:"suggestions,omitempty"`
}

SuggestScene 计划对应的场景

type Suggestion

type Suggestion struct {
	// Conclusion 诊断结论，当scene=POTENTIAL时，该字段为空
	Conclusion string `json:"conculsion,omitempty"`
	// Msg 该场景下所有建议的详细描述
	Msg string `json:"msg,omitempty"`
	// Name 建议名称
	Name string `json:"name,omitempty"`
	// ToolType 工具类型，允许值：ACTION操作类建议（可直接采纳）、TEXT文案类建议
	ToolType string `json:"tool_type,omitempty"`
	// Tools 工具列表
	Tools []Tool `json:"tools,omitempty"`
}

Suggestion 建议

type SuggestionAcceptFailed

type SuggestionAcceptFailed struct {
	// SuggestionType 采纳失败的工具
	SuggestionType string `json:"suggestion_type,omitempty"`
	// FailReason 采纳失败的原因
	FailReason string `json:"fail_reason,omitempty"`
}

SuggestionAcceptFailed 采纳失败

type SuggestionAcceptRequest

type SuggestionAcceptRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// DiagnosisID 诊断id
	DiagnosisID string `json:"diagnosis_id,omitempty"`
	// Tools 工具列表
	Tools []Tool `json:"tools,omitempty"`
}

SuggestionAcceptRequest 采纳计划诊断建议 API Request

func (SuggestionAcceptRequest) Encode

func (r SuggestionAcceptRequest) Encode() []byte

Encode implement PostRequest interface

type SuggestionAcceptResponse

type SuggestionAcceptResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *SuggestionAcceptResponseData `json:"data,omitempty"`
}

SuggestionAcceptResponse 采纳计划诊断建议 API Response

type SuggestionAcceptResponseData

type SuggestionAcceptResponseData struct {
	// SuggestionAccept 采纳成功的工具列表
	SuggestionAccept []string `json:"suggestion_accept,omitempty"`
	// SuggestionAcceptFailed 采纳失败的工具列表
	SuggestionAcceptFailed []SuggestionAcceptFailed `json:"suggestion_accept_failed,omitempty"`
}

SuggestionAcceptResponseData json返回值

type SuggestionGetRequest

type SuggestionGetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdIDs 广告计划ID列表，最多100个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// Scenes 希望获取建议的场景，允许值：CLEAN 清理低质计划场景、POTENTIAL 获取潜力计划场景
	Scenes []string `json:"scenes,omitempty"`
}

SuggestionGetRequest 获取计划诊断建议 API Request

func (SuggestionGetRequest) Encode

func (r SuggestionGetRequest) Encode() string

Encode implement GetRequest interface

type SuggestionGetResponse

type SuggestionGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *SuggestionGetResponseData `json:"data,omitempty"`
}

SuggestionGetResponse 获取计划诊断建议 API Response

type SuggestionGetResponseData

type SuggestionGetResponseData struct {
	// DiagnosisID 诊断id
	DiagnosisID string `json:"diagnosis_id,omitempty"`
	// ExpireTimestamp 诊断id的过期时间，格式：YYYY-MM-DD HH:mm:ss
	ExpireTimestamp string `json:"expire_timestamp,omitempty"`
	// SuggestList 获取的诊断建议列表
	SuggestionList []AdSuggestion `json:"suggestion_list,omitempty"`
}

SuggestionGetResponseData json返回值

type TitleMaterial

type TitleMaterial struct {
	// Title 标题文案
	Title string `json:"title,omitempty"`
	// WordIDs 标题文案中如果有词包时，传入词包ID，多个词包ID用英文逗号分隔
	WordIDs []uint64 `json:"word_ids,omitempty"`
}

TitleMaterial 标题对象

func (TitleMaterial) Type

func (m TitleMaterial) Type() ObjectType

Type implement ObjectType

type Tool

type Tool struct {
	// Tool 工具名称
	Tool string `json:"tool,omitempty"`
	// Params 工具参数列表
	Params []Param `json:"params,omitempty"`
}

Tool 工具

type VideoMaterial

type VideoMaterial struct {
	// ImageMode 素材类型枚举值
	ImageMode enum.ImageMode `json:"image_mode,omitempty"`
	// VideoID 视频vid
	VideoID string `json:"video_id,omitempty"`
	// CoverImageID 封面图片URI
	CoverImageID string `json:"cover_image_id,omitempty"`
}

VideoMaterial 视频素材对象