dmp

package
v1.27.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Overview

Package dmp DMP人群管理

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Audience added in v1.17.2 

type Audience struct {
	// AudienceID 人群ID
	AudienceID uint64 `json:"audience_id,omitempty"`
	// AudienceName 人群名称
	AudienceName string `json:"audience_name,omitempty"`
	// AudienceSource 人群来源，枚举值:
	// 0: 云图
	// 1：千川DMP
	// 2：用户360
	// 3：抖点罗盘
	// 4：抖点用户中心
	// 5：巨量引擎DMP
	AudienceSource int `json:"audience_source,omitempty"`
	// Status 人群状态，枚举值：
	// 1：计算完成
	// 2：等待计算
	// 3：计算中
	// 4：计算失败
	// 5：即将过期
	// 6：已过期
	// 7：推送中
	// 8：推送完成
	// 9：推送失败
	Status int `json:"status,omitempty"`
	// AudienceType 人群类型，枚举值:
	// BASIC: 基础
	// EXTEND: 扩展
	// UPLOAD: 上传
	AudienceType qianchuan.AudienceType `json:"audience_type,omitempty"`
	// AudienceGroup 人群分组
	AudienceGroup string `json:"audience_group,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
	// PushProduct 推送产品
	PushProduct string `json:"push_product,omitempty"`
	// StockNum 库存数量，品牌计划才有返回值
	StockNum int64 `json:"stock_num,omitempty"`
	// StockStatus 库存状态，品牌计划才有返回值
	// 0：无库存信息
	// 1：可定库存
	// 2：不可定库存（可更新）
	// 3：不可定库存（不可更新）
	StockStatus int `json:"stock_status,omitempty"`
}

Audience 人群

type AudienceCreateByFileRequest added in v1.17.2 

type AudienceCreateByFileRequest struct {
	// AdvertiserID 千川广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AudienceName 人群名称，限制长度30个字符
	AudienceName string `json:"audience_name,omitempty"`
	// AudienceGroup 人群分组
	// 注意：若传入的人群分组不存在，系统会自动创建
	AudienceGroup string `json:"audience_group,omitempty"`
	// DataType 文件数据类型，允许值：
	// 1: 'IMEI原值'
	// 2: 'IDFA原值'
	// 3: 'UID原值 '
	// 4: '手机号-原值'
	// 5: 'MAC地址'
	// 11: 'IMEI-MD5'
	// 12: 'IDFA-MD5'
	// 14: '手机号-SHA256'
	// 15: 'OAID'
	// 16: 'OAID-MD5'
	// 17: '手机号-MD5'
	// 18: '字节小程序OPENID'
	DataType int `json:"data_type,omitempty"`
	// MatchType 匹配方式，允许值UID：设备号匹配，定向/排除时直接按照设备号圈选，数据相对量少而精确
	MatchType string `json:"match_type,omitempty"`
	// FileKey 文件唯一标识
	FileKey string `json:"file_key,omitempty"`
}

AudienceCreateByFileRequest 上传人群 API Request

func (AudienceCreateByFileRequest) Encode added in v1.17.2 

func (r AudienceCreateByFileRequest) Encode() []byte

Encode implement PostRequest interface

type AudienceCreateByFileResponse added in v1.17.2 

type AudienceCreateByFileResponse struct {
	model.BaseResponse
	Data struct {
		// AudienceID 生成的人群ID
		AudienceID uint64 `json:"audience_id,omitempty"`
	} `json:"data,omitempty"`
}

AudienceCreateByFileResponse 上传人群 API Response

type AudienceDeleteRequest added in v1.17.2 

type AudienceDeleteRequest struct {
	// AdvertiserID 千川广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AudienceID 人群ID
	AudienceID uint64 `json:"audience_id,omitempty"`
}

AudienceDeleteRequest 删除人群 API Request

func (AudienceDeleteRequest) Encode added in v1.17.2 

func (r AudienceDeleteRequest) Encode() []byte

Encode implement PostRequest interface

type AudienceDeleteResponse added in v1.17.2 

type AudienceDeleteResponse struct {
	model.BaseResponse
	Data struct {
		// AudienceID 生成的人群ID
		AudienceID uint64 `json:"audience_id,omitempty"`
	} `json:"data,omitempty"`
}

AudienceDeleteResponse 删除人群 API Response

type AudienceFilePartUploadRequest added in v1.17.2 

type AudienceFilePartUploadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// File 文件
	File io.Reader `json:"file,omitempty"`
	// Filename 文件名
	Filename string `json:"filename,omitempty"`
	// PartNum 分片序号，从0开始保持递增1，将按该序号将各分片内容进行合并
	PartNum int `json:"part_num,omitempty"`
	// FileKey 文件唯一标识，用于标识多个分片属于同一个文件
	// 分片序号为0时，该字段无需设置；但在上传后续分片时，该字段必填，同时使用前一分片上传后接口返回的file_key值作为入參
	FileKey string `json:"file_key,omitempty"`
	// IsFinish 是否结束分片上传，允许值：
	// 1：是
	// 0：否
	IsFinished int `json:"is_finished,omitempty"`
}

AudienceFilePartUploadRequest 大文件分片上传 API Request

func (AudienceFilePartUploadRequest) Encode added in v1.17.2 

func (r AudienceFilePartUploadRequest) Encode() []model.UploadField

Encode implement UploadReqeust interface

type AudienceFilePartUploadResponse added in v1.17.2 

type AudienceFilePartUploadResponse struct {
	model.BaseResponse
	Data struct {
		// FileKey 文件唯一标识，有效期15天
		// 注意：一个文件的多个分片，文件标识相同
		// 用于后续分片上传时的入參
		FileKey string `json:"file_key,omitempty"`
	} `json:"data,omitempty"`
}

AudienceFilePartUploadResponse 大文件分片上传API Response

type AudienceFileUploadRequest added in v1.17.2 

type AudienceFileUploadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// File 文件
	File io.Reader `json:"file,omitempty"`
	// Filename 文件名
	Filename string `json:"filename,omitempty"`
}

AudienceFileUploadRequest 小文件直接上传 API Request

func (AudienceFileUploadRequest) Encode added in v1.17.2 

func (r AudienceFileUploadRequest) Encode() []model.UploadField

Encode implement UploadReqeust interface

type AudienceFileUploadResponse added in v1.17.2 

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

AudienceFileUploadResponse 小文件直接上传API Response

type AudienceFileUploadResult added in v1.17.2 

type AudienceFileUploadResult struct {
	// FileKey 文件唯一标识，有效期15天
	FileKey string `json:"file_key,omitempty"`
	// FileMd5 文件上传成功后返回的md5，可用于校验与本地文件的一致性
	FileMd5 string `json:"file_md5,omitempty"`
}

AudienceFileUploadResult json返回值

type AudienceGroupFilter added in v1.17.2 

type AudienceGroupFilter struct {
	// Name 人群分组名称
	// 注意：模糊搜索
	Name string `json:"name,omitempty"`
}

AudienceGroupFilter 过滤条件

type AudienceGroupGetRequest added in v1.17.2 

type AudienceGroupGetRequest struct {
	// AdvertiserID 千川广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *AudienceGroupFilter `json:"filtering,omitempty"`
}

AudienceGroupGetRequest 获取人群分组 API Request

func (AudienceGroupGetRequest) Encode added in v1.17.2 

func (r AudienceGroupGetRequest) Encode() string

Encode implement GetRequest interface

type AudienceGroupGetResponse added in v1.17.2 

type AudienceGroupGetResponse struct {
	model.BaseResponse
	Data struct {
		// AudienceGroupList 人群分组名称列表
		AudienceGroupList []string `json:"audience_group_list,omitempty"`
	} `json:"data,omitempty"`
}

AudienceGroupGetResponse 获取人群分组 API Response

type AudienceListFilter added in v1.17.2 

type AudienceListFilter struct {
	// AudienceID 人群ID
	AudienceID []uint64 `json:"audience_id,omitempty"`
	// AudienceName 人群名称
	AudienceName string `json:"audience_name,omitempty"`
	// AudienceType 人群类型，允许值：
	// BASIC 基础
	// EXTEND 扩展
	// UPLOAD 上传
	AudienceType qianchuan.AudienceType `json:"audience_type,omitempty"`
	// Status 人群状态，允许值：
	// 1 计算完成
	// 2 等待计算
	// 3 计算中
	// 4 计算失败
	// 5 即将过期
	// 6 已过期
	// 7 推送中
	// 8 推送完成
	// 9 推送失败
	Status int `json:"status,omitempty"`
	// StartTime 创建开始时间，例如“2022-08-02”
	StartTime string `json:"start_time,omitempty"`
	// EndTime 创建结束时间，例如“2022-08-02”
	EndTime string `json:"end_time,omitempty"`
}

AudienceListFilter 过滤条件

type AudienceListGetRequest added in v1.17.2 

type AudienceListGetRequest struct {
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *AudienceListFilter `json:"filtering,omitempty"`
	// Page 页码，默认为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值20，取值范围：1-100
	PageSize int `json:"page_size,omitempty"`
}

AudienceListGetRequest 获取人群管理列表 API Request

func (AudienceListGetRequest) Encode added in v1.17.2 

func (r AudienceListGetRequest) Encode() string

Encode implement GetRequest interface

type AudienceListGetResponse added in v1.17.2 

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

AudienceListGetResponse 获取人群管理列表 API Response

type AudienceListGetResult added in v1.17.2 

type AudienceListGetResult struct {
	// AudienceList 人群列表
	AudienceList []Audience `json:"audience_list,omitempty"`
	// PageInfo 页码信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type AudiencePushRequest added in v1.17.2 

type AudiencePushRequest struct {
	// AdvertiserID 千川广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// AudienceID 人群ID
	AudienceID uint64 `json:"audience_id,omitempty"`
	// AccountType 推送账户，允许值:
	// LOCAL：本账户
	// NO_LOCAL：其他账户
	AccountType qianchuan.AudienceAccountType `json:"account_type,omitempty"`
	// IsForBrand 人群应用，允许值：
	// 0：仅效果广告（默认）
	// 1：效果广告+品牌广告
	IsForBrand int `json:"is_for_brand,omitempty"`
	// AdvIDs 需要推送到的广告账户id列表
	// 注：仅在“推送账户”为“其他账户”时，条件必填
	AdvIDs []uint64 `json:"adv_ids,omitempty"`
}

AudiencePushRequest 推送人群 API Request

func (AudiencePushRequest) Encode added in v1.17.2 

func (r AudiencePushRequest) Encode() []byte

Encode implement PostRequest interface

type AudiencePushResponse added in v1.17.2 

type AudiencePushResponse struct {
	model.BaseResponse
	Data struct {
		// AudienceID 生成的人群ID
		AudienceID uint64 `json:"audience_id,omitempty"`
	} `json:"data,omitempty"`
}

AudiencePushResponse 推送人群 API Response

type AudiencesGetRequest 

type AudiencesGetRequest struct {
	// AdvertiserID 千川广告账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// RetargetingTagsType 人群包类型，枚举值：0：不限营销目标的平台精选人群包，1：自定义人群包
	RetargetingTagsType int `json:"retargeting_tags_type,omitempty"`
	// Offset 偏移,类似于SQL中offset(起始为0,翻页时new_offset=old_offset+limit），默认值：0，取值范围:≥ 0
	Offset int `json:"offset,omitempty"`
	// Limit 返回数据量，默认值：100，取值范围：1-100
	Limit int `json:"limit,omitempty"`
}

AudiencesGetRequest 查询人群包列表 API Request

func (AudiencesGetRequest) Encode 

func (r AudiencesGetRequest) Encode() string

Encode implement GetRequest interface

type AudiencesGetResponse 

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

AudiencesGetResponse 查询人群包列表 API Response

type AudiencesGetResponseData 

type AudiencesGetResponseData struct {
	// Offset 下一次查询的偏移,类似于SQL中offset(起始为0,翻页时new_offset=old_offset+limit），返回0时，代表已查询到最后一页
	Offset int `json:"offset,omitempty"`
	// TotalNum 总的人群包数量
	TotalNum int `json:"total_num,omitempty"`
	// RetargetingTags 人群包列表
	RetargetingTags []RetargetingTag `json:"retargeting_tags,omitempty"`
}

AudiencesGetResponseData json返回值

type InActiveRetargetingTag added in v1.17.2 

type InActiveRetargetingTag struct {
	// RetargetingTag 失效人群包id
	RetargetingTag uint64 `json:"retargeting_tag,omitempty"`
	// RetargetingName 失效人群包名称
	RetargetingName string `json:"retargeting_name,omitempty"`
	// InActiveType 失效类型，枚举值：
	// EXPIRE: 人群包过期
	// TAG_OFFLINE: 人群包tag下线
	// MANUAL_OFFLINE: 精选人群包手动下线
	InActiveType qianchuan.InActiveRetargetingType `json:"InActive_type,omitempty"`
}

InActiveRetargetingTag 失效人群包

type Orientation added in v1.17.2 

type Orientation struct {
	ad.Audience
	// OrientationName 定向包名称
	OrientationName string `json:"orientation_name,omitempty"`
	// AdNum 关联计划数
	AdNum int `json:"ad_num,omitempty"`
	// OrientationInfo 定向包描述
	OrientationInfo string `json:"orientation_info,omitempty"`
	// InActiveRetargetingTags 失效人群包
	InActiveRetargetingTags []InActiveRetargetingTag `json:"InActive_retargeting_tags,omitempty"`
}

Orientation 定向包

type OrientationPackageGetFilter added in v1.17.2 

type OrientationPackageGetFilter struct {
	// Name 定向包名称，长度限制20个汉字
	Name string `json:"name,omitempty"`
	// ID 定向包ID，最多支持100个
	ID []uint64 `json:"id,omitempty"`
}

OrientationPackageGetFilter 过滤条件

type OrientationPackageGetRequest added in v1.17.2 

type OrientationPackageGetRequest struct {
	// AdvertiserID 千川广告主账户ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Filtering 过滤条件
	Filtering *OrientationPackageGetFilter `json:"filtering,omitempty"`
	// Page 页码，默认值1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认为20，取值范围：1-100
	PageSize int `json:"page_size,omitempty"`
}

OrientationPackageGetRequest 获取定向包列表 API Request

func (OrientationPackageGetRequest) Encode added in v1.17.2 

func (r OrientationPackageGetRequest) Encode() string

Encode implement GetRequest interface

type OrientationPackageGetResponse added in v1.17.2 

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

OrientationPackageGetResponse 获取定向包列表 API Response

type OrientationPackageGetResult added in v1.17.2 

type OrientationPackageGetResult struct {
	// List 定向包列表
	List []Orientation `json:"list,omitempty"`
	// PageInfo 页码信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
}

type RetargetingTag 

type RetargetingTag struct {
	// ID 人群包id
	ID uint64 `json:"retargeting_tags_id,omitempty"`
	// Name 人群包名称
	Name string `json:"name,omitempty"`
	// Source 人群包来源，自定义类详见【附录-DMP相关-人群包来源】，平台精选类返回空值
	Source enum.DmpSource `json:"source,omitempty"`
	// Status 人群包来源，自定义类详见【附录-DMP相关-人群包来源】，平台精选类返回空值
	Status int `json:"status,omitempty"`
	// Op 人群包可选的定向规则，枚举值：INCLUDE只支持定向，EXCLUDE只支持排除，ALL支持两种规则。当source为RETARGETING_TAGS_TYPE_PLATFORM时，只支持INCLUDE或EXCLUDE；当source为RETARGETING_TAGS_TYPE_CUSTOM时，支持ALL
	Op string `json:"retargeting_tags_op,omitempty"`
	// CoverNum 预估人群包覆盖人群数目
	CoverNum int64 `json:"cover_num,omitempty"`
	// Tip 人群包说明
	Tip string `json:"retargeting_tags_tip,omitempty"`
	// IsCommon 0 该人群包不支持通投，1 该人群包支持通投，注意：不支持通投的人群包不能在千川平台创建计划，否则会报错。
	IsCommon int `json:"is_common,omitempty"`
}

RetargetingTag 人群包

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.