privativeword

Documentation

Overview

Package privativeword 包含否定词相关API models

Index

• type AdAddRequest
  • func (r AdAddRequest) Encode() []byte
• type AdAddResponse
• type AdAddResponseData
• type AdAddWordList
• type AdUpdateRequest
  • func (r AdUpdateRequest) Encode() []byte
• type AdUpdateResponse
• type AdUpdateResponseData
• type AdWord
• type CampaignAddRequest
  • func (r CampaignAddRequest) Encode() []byte
• type CampaignAddResponse
• type CampaignAddResponseData
• type CampaignAddWordList
• type GetFiltering
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData

Types

type AdAddRequest

type AdAddRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AdList 广告计划否定词列表，批量操作不能超过50个项目
	AdList []AdWord `json:"ad_list,omitempty"`
}

AdAddRequest 批量新增计划否定词 API Request

func (AdAddRequest) Encode

func (r AdAddRequest) Encode() []byte

Encode implement PostRequest interface

type AdAddResponse

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

AdAddResponse 批量新增计划否定词 API Response

type AdAddResponseData

type AdAddResponseData struct {
	// AdErrorList 请求失败的广告计划id
	AdErrorList []string `json:"ad_error_list,omitempty"`
	// AdList 添加成功的广告计划否定词列表
	AdList []AdAddWordList `json:"ad_list,omitempty"`
}

AdAddResponseData json返回值

type AdAddWordList

type AdAddWordList struct {
	// AdID 广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// Status 操作执行状态，只要有操作失败的词，就返回 failure，全部成功返回 success
	Status string `json:"status,omitempty"`
	// DuplicateWords 有重复的否定词词导致操作失败的列表
	DuplicateWords []AdWord `json:"duplicate_words,omitempty"`
	// ExceedLengthWords 否定词词超过200个导致操作失败的列表
	ExceedLengthWords []AdWord `json:"exceed_length_words,omitempty"`
	// ExceedLimitWords 单个否定词的长度超过限制导致操作失败的列表
	ExceedLimitWords []AdWord `json:"exceed_limit_words,omitempty"`
	// HasEmojiWords 有 emoji 导致操作失败的列表
	HasEmojiWords []AdWord `json:"has_emoji_words,omitempty"`
	// SuccessWords 操作成功的否定词列表
	SuccessWords []AdWord `json:"success_words,omitempty"`
}

AdAddWordList 添加广告计划否定词计划结果

type AdUpdateRequest

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

AdUpdateRequest 设置计划否定词 API Request

func (AdUpdateRequest) Encode

func (r AdUpdateRequest) Encode() []byte

Encode implement PostRequest interface

type AdUpdateResponse

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

AdUpdateResponse 设置计划否定词 API Response

type AdUpdateResponseData

type AdUpdateResponseData struct {
	// AdID 广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
}

AdUpdateResponseData json返回值

type AdWord

type AdWord struct {
	// AdID 广告计划id
	AdID uint64 `json:"ad_id,omitempty"`
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// PhraseWords 短语否定词，否定词列表不能超过100个否定词，单个否定词长度不能超过30个汉字（或60个英文字符），不能包含emoji，不能为空字符串。
	PhraseWords []string `json:"phrase_words,omitempty"`
	// PreciseWords 精确否定词，否定词列表不能超过100个否定词，单个否定词长度不能超过30个汉字（或60个英文字符），不能包含emoji，不能为空字符串。
	PreciseWords []string `json:"precise_words,omitempty"`
}

AdWord 否定词

type CampaignAddRequest

type CampaignAddRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CampaignList 广告组否定词列表，批量操作不能超过50个项目
	CampaignList []AdWord `json:"campaign_list,omitempty"`
}

CampaignAddRequest 批量新增组否定词 API Request

func (CampaignAddRequest) Encode

func (r CampaignAddRequest) Encode() []byte

Encode implement PostRequest interface

type CampaignAddResponse

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

CampaignAddResponse 批量新增组否定词 API Response

type CampaignAddResponseData

type CampaignAddResponseData struct {
	// CampaignErrorList 请求失败的广告组id
	CampaignErrorList []string `json:"campaign_error_list,omitempty"`
	// CampaignList 添加成功的广告组否定词列表
	CampaignList []CampaignAddWordList `json:"campaign_list,omitempty"`
}

CampaignAddResponseData json返回值

type CampaignAddWordList

type CampaignAddWordList struct {
	// CampaignID 广告组id
	CampaignID uint64 `json:"campaign_id,omitempty"`
	// Status 操作执行状态，只要有操作失败的词，就返回 failure，全部成功返回 success
	Status string `json:"status,omitempty"`
	// DuplicateWords 有重复的否定词词导致操作失败的列表
	DuplicateWords []AdWord `json:"duplicate_words,omitempty"`
	// ExceedLengthWords 否定词词超过200个导致操作失败的列表
	ExceedLengthWords []AdWord `json:"exceed_length_words,omitempty"`
	// ExceedLimitWords 单个否定词的长度超过限制导致操作失败的列表
	ExceedLimitWords []AdWord `json:"exceed_limit_words,omitempty"`
	// HasEmojiWords 有 emoji 导致操作失败的列表
	HasEmojiWords []AdWord `json:"has_emoji_words,omitempty"`
	// SuccessWords 操作成功的否定词列表
	SuccessWords []AdWord `json:"success_words,omitempty"`
}

CampaignAddWordList 添加广告组否定词计划结果

type GetFiltering

type GetFiltering struct {
	// AdIDs 广告计划ids, 最多100个, ad_ids 与 campaign_ids 同时传入，取并集操作
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// CampaignIDs 广告组ids, 最多100个, ad_ids 与 campaign_ids 同时传入，取并集操作
	CampaignIDs []uint64 `json:"campaign_ids,omitempty"`
}

GetFiltering 搜索否定词查询条件

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 *GetResponseData `json:"data,omitempty"`
}

GetResponse 获取否定词列表 API Response

type GetResponseData

type GetResponseData struct {
	// AdsPrivative 广告计划否定词列表
	AdsPrivative []AdWord `json:"ads_privative,omitempty"`
	// CampaignsPrivative 广告组否定词列表
	CampaignsPrivative []AdWord `json:"campaigns_privative,omitempty"`
	// AdErrorList 请求失败的广告计划id
	AdErrorList []string `json:"ad_error_list,omitempty"`
	// CampaignErrorList 请求失败的广告组id
	CampaignErrorList []string `json:"campaign_error_list,omitempty"`
}

GetResponseData json返回值