carousel

Documentation

Index

• type Audio
• type AwemeCarousel
• type AwemeGetFilter
• type AwemeGetRequest
  • func (r AwemeGetRequest) Encode() string
• type AwemeGetResponse
• type AwemeGetResult
• type Carousel
• type GetFilter
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResult
• type Image
• type Metrics

Types

type Audio

type Audio struct {
	// VideoID 音频id
	VideoID string `json:"video_id,omitempty"`
	// URL 音频URL
	URL string `json:"url,omitempty"`
}

Audio 音频信息

type AwemeCarousel

type AwemeCarousel struct {
	// AwemeCarouselID 图文itemid
	AwemeCarouselID string `json:"aweme_carousel_id,omitempty"`
	// Title 图文标题
	Title string `json:"title,omitempty"`
	// Description 图文描述
	Description string `json:"description,omitempty"`
	// Images 图文图片列表
	Images []Image `json:"images,omitempty"`
	// MusicID 音乐ID
	MusicID string `json:"music_id,omitempty"`
	// MusicURL 音乐播放链接
	MusicURL string `json:"music_url,omitempty"`
	// Metrics 数据指标
	Metrics *Metrics `json:"metrics,omitempty"`
}

AwemeCarousel 抖音号图文

type AwemeGetFilter

type AwemeGetFilter struct {
	// ProductID 商品id
	ProductID uint64 `json:"product_id,omitempty"`
	// AwemeItemURL 图文url链接
	AwemeItemURL string `json:"aweme_item_url,omitempty"`
	// AwemeCarouselID 挂车商品指定的筛选主页图文id
	AwemeCarouseID uint64 `json:"aweme_carousel_id,omitempty"`
}

type AwemeGetRequest

type AwemeGetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AwemeID 抖音号uid，需拉取图文的抖音号，可通过「千川账户下已授权抖音号」获取
	AwemeID uint64 `json:"aweme_id,omitempty"`
	// Filtering 图文过滤条件
	Filtering *AwemeGetFilter `json:"filtering,omitempty"`
	// Cursor 页码游标值，第一次拉取，无需入参
	Cursor int `json:"cursor,omitempty"`
	// Count 页面大小，默认值30，限制1-50
	Count int `json:"count,omitempty"`
}

AwemeGetRequest 获取抖音号下图文 API Request

func (AwemeGetRequest) Encode

func (r AwemeGetRequest) Encode() string

Encode implement GetRequest interface

type AwemeGetResponse

type AwemeGetResponse struct {
	model.BaseResponse
	Data *AwemeGetResult `json:"data,omitempty"`
}

AwemeGetResponse 获取抖音号下图文 API Response

type AwemeGetResult

type AwemeGetResult struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// ImageAggregateList 图文列表
	ImageAggregateList []AwemeCarousel `json:"image_aggregate_list,omitempty"`
}

type Carousel

type Carousel struct {
	// MaterialID 素材id
	MaterialID uint64 `json:"material_id,omitempty"`
	// ImageMode 素材类型:
	// CAROUSEL 图文
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// Images 图片信息
	Images []Image `json:"images,omitempty"`
	// Audio 音频信息
	Audio *Audio `json:"audio,omitempty"`
	// Filename 素材的文件名
	Filename string `json:"filename,omitempty"`
	// CreateTime 图文创建时间
	CreateTime string `json:"create_time,omitempty"`
	// Description 素材描述
	Description string `json:"description,omitempty"`
}

Carousel 素材信息

type GetFilter

type GetFilter struct {
	// MaterialIDs 素材id列表，可以根据material_ids（素材报表使用的id，一个素材唯一对应一个素材id）进行过滤
	// 数量限制：<=100
	MaterialIDs []uint64 `json:"material_ids,omitempty"`
	// Sources 图文素材来源，允许值
	// JICHAUNG 即创
	Sources []qianchuan.CarouselSource `json:"sources,omitempty"`
	// ImageMode 素材类型，允许值
	// CAROUSEL 图文
	ImageMode enum.MaterialMode `json:"image_mode,omitempty"`
	// QueryString 支持根据图文名称/ID搜索
	QueryString string `json:"query_string,omitempty"`
	// StartTime 根据图片上传时间进行过滤的起始时间，与end_time搭配使用，格式："yyyy-mm-dd"
	StartTime string `json:"start_time,omitempty"`
	// EndTime 根据图片上传时间进行过滤的截止时间，与start_time搭配使用，格式："yyyy-mm-dd"
	EndTime string `json:"end_time,omitempty"`
}

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 图文过滤信息
	Filtering *GetFilter `json:"filtering,omitempty"`
	// OrderFields 排序字段，默认不传为create_time，见返回参数中metrics
	OrderFields string `json:"order_fields,omitempty"`
	// OrderType 排序方式，允许值：
	// ASC 升序（默认）
	// DESC 降序
	OrderType enum.OrderType `json:"order_type,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值20
	PageSize int `json:"page_size,omitempty"`
}

GetRequest 获取千川素材库图文 API Request

func (GetRequest) Encode

func (r GetRequest) Encode() string

Encode implement GetRequest interface

type GetResponse

type GetResponse struct {
	model.BaseResponse
	Data *GetResult `json:"data,omitempty"`
}

GetResponse 获取千川素材库图文 API Response

type GetResult

type GetResult struct {
	PageInfo  *model.PageInfo `json:"page_info,omitempty"`
	Carousels []Carousel      `json:"carousels,omitempty"`
}

type Image

type Image struct {
	// ImageID 图片id
	ImageID string `json:"image_id,omitempty"`
	// ImageMaterialID 图片素材id
	ImageMaterialID uint64 `json:"image_material_id,omitempty"`
	// Height 图片高度
	Height int `json:"height,omitempty"`
	// Width 图片宽度
	Width int `json:"width,omitempty"`
	// Ratio 图片比例
	Ratio float64 `json:"ratio,omitempty"`
	// WebURL 图片url
	WebURL string `json:"web_url,omitempty"`
	// URL 图片url
	URL string `json:"url,omitempty"`
}

Image 图片信息

type Metrics

type Metrics struct {
	// ViewCnt 观看数
	ViewCnt int64 `json:"view_cnt,omitempty"`
	// LikeCnt 点赞数
	LikeCnt int64 `json:"like_cnt,omitempty"`
	// ShareCnt 分享数
	ShareCnt int64 `json:"share_cnt,omitempty"`
	// CommentCnt 评论数
	CommentCnt int64 `json:"comment_cnt,omitempty"`
}

Metrics 数据指标