keyword

Documentation

Overview

Package keyword 关键词管理

Index

• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type DeleteRequest
  • func (r DeleteRequest) Encode() []byte
• type DeleteResponse
• type DeleteResponseData
• type GetFiltering
  • func (f GetFiltering) GetID() uint64
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type IListFilter
• type Keyword
• type Response
• type ResponseData
• type SuggestKeyword
• type SuggestRequest
  • func (r SuggestRequest) Encode() string
• type SuggestResponse
• type SuggestResponseData
• type UpdateRequest
  • func (r UpdateRequest) Encode() []byte

Types

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 待创建搜索关键词的计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// Keywords 待添加搜索关键词列表，一次最多添加100个关键词，一个计划最多可添加1000
	Keywords []Keyword `json:"keywords,omitempty"`
}

CreateRequest 创建关键词 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type DeleteRequest

type DeleteRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 待删除关键词的计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// KeywordIDs 待删除的关键词id列表，一次最多批量删除100个关键词
	KeywordIDs []uint64 `json:"keyword_ids,omitempty"`
}

DeleteRequest 删除关键词 API Request

func (DeleteRequest) Encode

func (r DeleteRequest) Encode() []byte

Encode implement PostRequest interface

type DeleteResponse

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

DeleteResponse 关键词 API Response

type DeleteResponseData

type DeleteResponseData struct {
	// ErrorList 添加失败的搜索关键词列表
	ErrorList []Keyword `json:"error_list,omitempty"`
	// SuccessList 添加成功的搜索关键词列表
	SuccessList []uint64 `json:"success_list,omitempty"`
}

DeleteResponseData json返回值

type GetFiltering

type GetFiltering struct {
	// AdID 待过滤的广告计划ID
	AdID uint64 `json:"ad_id,omitempty"`
}

GetFiltering 过滤结构

func (GetFiltering) GetID

func (f GetFiltering) GetID() uint64

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤结构
	Filtering *GetFiltering `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 struct {
		// List 关键词列表
		List []Keyword `json:"list,omitempty"`
	} `json:"data,omitempty"`
}

GetResponse 获取关键词列表 API Response

type IListFilter

type IListFilter interface {
	GetID() uint64
}

type Keyword

type Keyword struct {
	// MatchType 匹配类型; 枚举值: "PHRASE"（短语匹配）, "EXTENSIVE"（广泛匹配）,"PRECISION"（精准匹配）
	MatchType enum.KeywordMatchType `json:"match_type"`
	// Word 关键词
	Word string `json:"word,omitempty"`
	// Bid 出价。与bid_type联动，当bit_type="CUSTOM"此字段才有效
	Bid float64 `json:"bid,omitempty"`
	// BidType 出价类型
	BidType enum.KeywordBidType `json:"bid_type,omitempty"`
	// IsPause 是否停用; 枚举值：0（启用），1（停用）
	IsPause *int `json:"is_pause,omitempty"`
	// KeywordID 关键词id，唯一标志计划下的关键词。可根据该id进行搜索、更新、删除
	KeywordID uint64 `json:"keyword_id,omitempty"`
	// WordID 词ID，不同计划下如果关键词的内容相同，词id会相同
	WordID uint64 `json:"word_id,omitempty"`
	// Msv 月搜索量
	Msg int64 `json:"msv,omitempty"`
	// Status  审核状态:
	// AUDITING 审核中
	// AUDIT_ACCEPTED 审核通过
	// AUDIT_REJECTED 审核拒绝
	// DELETED 已删除
	Status enum.KeywordAuditStatus `json:"status,omitempty"`
	// ErrorReason 关键词添加失败原因
	ErrorReason string `json:"error_reason,omitempty"`
}

Keyword 关键词

type Response

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

Response 关键词 API Response

type ResponseData

type ResponseData struct {
	// ErrorList 添加失败的搜索关键词列表
	ErrorList []Keyword `json:"error_list,omitempty"`
	// SuccessList 添加成功的搜索关键词列表
	SuccessList []Keyword `json:"success_list,omitempty"`
}

ResponseData json返回值

type SuggestKeyword

type SuggestKeyword struct {
	// Keyword 推荐关键词
	Keyword string `json:"keyword,omitempty"`
	// MatchType 匹配类型
	MatchType enum.KeywordMatchType `json:"match_type,omitempty"`
	// Msv 月搜索量
	Msv int64 `json:"msv,omitempty"`
}

SuggestKeyword 推荐关键词

type SuggestRequest

type SuggestRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 广告计划id，此参数用于获取与当前计划更为相关的关键词推荐
	AdID uint64 `json:"ad_id,omitempty"`
}

SuggestRequest 搜索快投关键词推荐 API Request

func (SuggestRequest) Encode

func (r SuggestRequest) Encode() string

Encode implement GetRequest interface

type SuggestResponse

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

SuggestResponse 搜索快投关键词推荐 API Response

type SuggestResponseData

type SuggestResponseData struct {
	// List 推荐关键词列表
	List []SuggestKeyword `json:"list,omitempty"`
}

SuggestResponseData json返回值

type UpdateRequest

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdID 待创建搜索关键词的计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// Keywords 待更新搜索关键词列表，一次最多批量更新100个关键词
	Keywords []Keyword `json:"keywords,omitempty"`
}

UpdateRequest 更新关键词 API Request

func (UpdateRequest) Encode

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface