datasource

package
v1.10.8 Latest Latest
Warning

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

 Go to latest Published: Mar 24, 2023 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Overview

Package datasource 数据源相关API models

Index

Constants

This section is empty.

Variables

View Source 
var (
	IdItem_DataType_name = map[int32]string{
		0: "IMEI",
		1: "IDFA",
		2: "UID",
		4: "IMEI_MD5",
		5: "IDFA_MD5",
		6: "MOBILE_HASH_SHA256",
		7: "OAID",
		8: "OAID_MD5",
	}
	IdItem_DataType_value = map[string]int32{
		"IMEI":               0,
		"IDFA":               1,
		"UID":                2,
		"IMEI_MD5":           4,
		"IDFA_MD5":           5,
		"MOBILE_HASH_SHA256": 6,
		"OAID":               7,
		"OAID_MD5":           8,
	}
)

Enum value maps for IdItem_DataType.

View Source 
var File_github_com_bububa_oceanengine_marketing_api_model_dmp_datasource_dmp_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Audience 

type Audience struct {
	// AdvertiserID 广告主id
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CustomAudienceID 人群包id
	CustomAudienceID uint64 `json:"custom_audience_id,omitempty"`
	// Name 人群包名称
	Name string `json:"name,omitempty"`
	// CustomType 人群类型，枚举值见【DMP相关-人群类型】
	CustomType enum.DmpCustomType `json:"custom_type,omitempty"`
	// Source 来源，枚举值见【DMP相关-人群包来源】
	Source int `json:"source,omitempty"`
	// Status 人群包状态，枚举值见【DMP相关-人群包状态】
	Status int `json:"status,omitempty"`
	// PushStatus 推送状态，枚举值见【DMP相关-DMP推送状态】
	PushStatus enum.DmpPushStatus `json:"push_status,omitempty"`
	// UploadNum 上传数据源包含的人群数目
	UploadNum int64 `json:"upload_num,omitempty"`
	// CoverNum 人群包覆盖人群数目，基于"upload_num"：上传数据源包含的人群数目与uid对应后，再与头条系产品MAU交集后的数量（存在一个设备号/手机号对应多个uid的情况）
	// 实际数量可能多于/少于"upload_num"：上传数据源包含的人群数目
	CoverNum int64 `json:"cover_num,omitempty"`
	// ExpireDate 人群包过期时间
	ExpireDate string `json:"expire_date,omitempty"`
	// CreateTime 人群包创建时间
	CreateTime string `json:"create_time,omitempty"`
	// ModifyTime 人群包修改时间
	ModifyTime string `json:"modify_time,omitempty"`
	// Isdel 删除标志，枚举值："1"：已删除，"0"：未删除
	IsDel int `json:"isdel,omitempty"`
	// CalculateSubType 计算子类型
	CalculateSubType int `json:"calculate_sub_type,omitempty"`
	// CalculateType 计算类型
	CalculateType int `json:"calculate_type,omitempty"`
	// DataSourceID 数据源id
	DataSourceID string `json:"data_source_id,omitempty"`
	// Tag 人群包标签，通过数据源创建的人群包，标签会默认为“API文件数据源”
	Tag string `json:"tag,omitempty"`
	// ThirdPartyInfo 三方信息，均返回“非三方包”
	ThirdPartyInfo string `json:"third_party_info,omitempty"`
	// DeliveryStatus 人群包可投放状态，只有当状态为CUSTOM_AUDIENCE_DELIVERY_STATUS_AVAILABLE时才可进行投放使用
	// 可选值：
	// CUSTOM_AUDIENCE_DELIVERY_STATUS_AVAILABLE：可投放，人群包发布完成且推送完成
	// CUSTOM_AUDIENCE_DELIVERY_STATUS_NEED_PUSH：不可投放，人群包发布完成，但未推送，需要进行推送后再使用
	// CUSTOM_AUDIENCE_DELIVERY_STATUS_NEED_PUBLISH：不可投放，群包未发布但已推送，需要进行发布后再使用
	//CUSTOM_AUDIENCE_DELIVERY_STATUS_UNAVAILABLE：不可投放，未发布完成且未推送
	DeliveryStatus enum.CustomAudienceDeliveryStatus `json:"delivery_status,omitempty"`
}

Audience 数据源对应的人群包，如果还未生成将不会返回

type ChangeLog 

type ChangeLog struct {
	// Action 本次更新进行的操作，枚举值："0"：新建，"1"：添加，"2"：删除，"3"：重置
	Action enum.DmpDatasourceOperationType `json:"action,omitempty"`
	// FilePaths 使用数据源文件上传文件后返回的文件路径参数
	FilePaths []string `json:"file_paths,omitempty"`
	// Status 本次更新的状态，枚举值："0"：新建，"1"：处理中，"2"：生效，"3"：失败
	Status enum.DataSourceStatus `json:"status,omitempty"`
	// CreateTime 本次更新创建时间
	CreateTime string `json:"create_time,omitempty"`
	// ModifyTime 本次更新完成时间
	ModifyTime string `json:"modify_time,omitempty"`
	// ID 更新日志id
	ID int64 `json:"change_log_id,omitempty"`
	// PublishTime 数据源本次更新发布完成时间记录
	PublishTime string `json:"publish_time,omitempty"`
}

ChangeLog 每一次更新，会记录一次日志id

type CreateRequest 

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DataSourceName 数据源名称, 限30个字符内
	DataSourceName string `json:"data_source_name,omitempty"`
	// Description 数据源描述, 限256个字符内
	Description string `json:"description,omitempty"`
	// DataFormat 数据格式, 枚举值:"0"：ProtocolBuffer
	DataFormat int `json:"data_format"`
	// FileStorageType 数据存储类型, 枚举值:"0"：API
	FileStorageType int `json:"file_storage_type"`
	// FilePaths 通过【数据源文件上传】接口得到的文件路径，注意：一次上传最多1000个
	FilePaths []string `json:"file_paths,omitempty"`
	// DataSourceType 投放数据源类型，枚举值如下: "UID"：用户ID, "DID"：设备ID ,默认值： "UID"
	DataSourceType string `json:"data_source_type,omitempty"`
}

CreateRequest 数据源创建API Request

func (CreateRequest) Encode 

func (r CreateRequest) Encode() []byte

Encode implement PostRequest interface

type CreateResponse 

type CreateResponse struct {
	model.BaseResponse
	// Data json返回值, 其中data_source_id参数包含唯一标识数据源的字符串
	Data *CreateResponseData `json:"data,omitempty"`
}

CreateResponse 数据源创建API Response

type CreateResponseData 

type CreateResponseData struct {
	// DataSourceID 数据源id, 唯一标识数据源的字符串
	DataSourceID string `json:"data_source_id,omitempty"`
}

CreateResponseData json返回值, 其中data_source_id参数包含唯一标识数据源的字符串

type DataSource 

type DataSource struct {
	// Name 数据源名称
	Name string `json:"name,omitempty"`
	// ID 数据源ID
	ID string `json:"data_source_id,omitempty"`
	// Description 数据源描述
	Description string `json:"description,omitempty"`
	// Status 数据源初次创建状态，枚举值："0"：已创建，"1"：解析中暂不可用，"2"：完成
	Status enum.DataSourceStatus `json:"status,omitempty"`
	// CoverNum 人群包覆盖人群数目，基于"upload_num"：上传数据源包含的人群数目与uid对应后，再与头条系产品MAU交集后的数量（存在一个设备号/手机号对应多个uid的情况）
	// 实际数量可能多于/少于"upload_num"：上传数据源包含的人群数目
	CoverNum int64 `json:"cover_num,omitempty"`
	// UploadNum 上传数据源包含的人群数目
	UploadNum int64 `json:"upload_num,omitempty"`
	// CreateTime 数据源创建时间
	CreateTime string `json:"create_time,omitempty"`
	// ModifyTime 数据源修改时间
	ModifyTime string `json:"modify_time,omitempty"`
	// LatestPublishedChangeLogID 数据源最近一次更新对应的日志id，若未完成更新，返回“-1
	LatestPublishedChangeLogID int64 `json:"latest_published_changelog_id,omitempty"`
	// LatestPublishedTime 数据源最近一次发布完成时间
	LatestPublishedTime string `json:"latest_published_time,omitempty"`
	// DataSourceType 数据源类型，枚举值："UID"：用户ID，"DID" ：设备ID
	DataSourceType string `json:"data_source_type,omitempty"`
	// ChangeLogs 每一次更新，会记录一次日志id
	ChangeLogs []ChangeLog `json:"change_logs,omitempty"`
	// DefaultAudience 数据源对应的人群包，如果还未生成将不会返回
	DefaultAudience *Audience `json:"default_audience,omitempty"`
}

DataSource 数据源信息

type DmpData 

type DmpData struct {
	IdList []*IdItem `protobuf:"bytes,1,rep,name=idList" json:"idList,omitempty"` // 每行数据包含的idList大小不能超过10000
	// contains filtered or unexported fields
}

func (*DmpData) Descriptor deprecated 

func (*DmpData) Descriptor() ([]byte, []int)

Deprecated: Use DmpData.ProtoReflect.Descriptor instead.

func (*DmpData) GetIdList 

func (x *DmpData) GetIdList() []*IdItem

func (*DmpData) ProtoMessage 

func (*DmpData) ProtoMessage()

func (*DmpData) ProtoReflect 

func (x *DmpData) ProtoReflect() protoreflect.Message

func (*DmpData) Reset 

func (x *DmpData) Reset()

func (*DmpData) String 

func (x *DmpData) String() string

type FileUploadRequest 

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

FileUploadRequest 数据源文件上传 API Request

func (FileUploadRequest) Encode 

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

Encode implement UploadReqeust interface

type FileUploadResponse 

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

FileUploadResponse 数据文件上传API Response

type FileUploadResponseData 

type FileUploadResponseData struct {
	// FilePath 文件路径，包含作为文件唯一标识的字符串(14天后文件路径过期)
	FilePath string `json:"file_path,omitempty"`
}

FileUploadResponseData json返回值

type IdItem 

type IdItem struct {
	Timestamp *uint32          `protobuf:"varint,1,opt,name=timestamp" json:"timestamp,omitempty"`                                //若不设置，默认以上传文件的创建时间为此条记录的创建时间
	DataType  *IdItem_DataType `protobuf:"varint,2,req,name=dataType,enum=toutiao.dmp.IdItem_DataType" json:"dataType,omitempty"` //指定此id的类型，如IMEI、IDFA等
	Id        *string          `protobuf:"bytes,3,req,name=id" json:"id,omitempty"`                                               //根据dataType字段的类型，放置对应类型的id的字符串，需要小写
	Tags      []string         `protobuf:"bytes,4,rep,name=tags" json:"tags,omitempty"`                                           //标识此id的业务标签字符串
	// contains filtered or unexported fields
}

func (*IdItem) Descriptor deprecated 

func (*IdItem) Descriptor() ([]byte, []int)

Deprecated: Use IdItem.ProtoReflect.Descriptor instead.

func (*IdItem) GetDataType 

func (x *IdItem) GetDataType() IdItem_DataType

func (*IdItem) GetId 

func (x *IdItem) GetId() string

func (*IdItem) GetTags 

func (x *IdItem) GetTags() []string

func (*IdItem) GetTimestamp 

func (x *IdItem) GetTimestamp() uint32

func (*IdItem) ProtoMessage 

func (*IdItem) ProtoMessage()

func (*IdItem) ProtoReflect 

func (x *IdItem) ProtoReflect() protoreflect.Message

func (*IdItem) Reset 

func (x *IdItem) Reset()

func (*IdItem) String 

func (x *IdItem) String() string

type IdItem_DataType 

type IdItem_DataType int32
const (
	IdItem_IMEI               IdItem_DataType = 0
	IdItem_IDFA               IdItem_DataType = 1
	IdItem_UID                IdItem_DataType = 2
	IdItem_IMEI_MD5           IdItem_DataType = 4
	IdItem_IDFA_MD5           IdItem_DataType = 5
	IdItem_MOBILE_HASH_SHA256 IdItem_DataType = 6
	IdItem_OAID               IdItem_DataType = 7
	IdItem_OAID_MD5           IdItem_DataType = 8
)

func (IdItem_DataType) Descriptor 

func (IdItem_DataType) Descriptor() protoreflect.EnumDescriptor

func (IdItem_DataType) Enum 

func (x IdItem_DataType) Enum() *IdItem_DataType

func (IdItem_DataType) EnumDescriptor deprecated 

func (IdItem_DataType) EnumDescriptor() ([]byte, []int)

Deprecated: Use IdItem_DataType.Descriptor instead.

func (IdItem_DataType) Number 

func (x IdItem_DataType) Number() protoreflect.EnumNumber

func (IdItem_DataType) String 

func (x IdItem_DataType) String() string

func (IdItem_DataType) Type 

func (IdItem_DataType) Type() protoreflect.EnumType

func (*IdItem_DataType) UnmarshalJSON deprecated 

func (x *IdItem_DataType) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type ReadRequest 

type ReadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DataSourceIDList 数据源ID列表
	// 一次最多传400个数据源id
	DataSourceIDList []string `json:"data_source_id_list,omitempty"`
}

ReadRequest 数据源详细信息 API Request

func (ReadRequest) Encode 

func (r ReadRequest) Encode() string

Encode implement GetRequest interface

type ReadResponse 

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

ReadResponse 数据源详细信息 API Response

type ReadResponseData 

type ReadResponseData struct {
	// DataList 数据信息列表
	DataList []DataSource `json:"data_list,omitempty"`
}

ReadResponseData json返回值

type UpdateRequest 

type UpdateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// DataSourceID 数据源ID
	DataSourceID string `json:"data_source_id,omitempty"`
	// OperationType 更新操作类型, 枚举值："1" ：添加,"2"：删除, "3"：重置
	OperationType enum.DmpDatasourceOperationType `json:"operation_type,omitempty"`
	// DataFormat 数据格式, 枚举值:"0"：ProtocolBuffer
	DataFormat int `json:"data_format"`
	// FileStorageType 数据存储类型, 枚举值:"0"：API
	FileStorageType int `json:"file_storage_type"`
	// FilePaths 通过【数据源文件上传】接口得到的文件路径，注意：一次上传最多1000个
	FilePaths []string `json:"file_paths,omitempty"`
}

UpdateRequest 数据源更新API Request

func (UpdateRequest) Encode 

func (r UpdateRequest) Encode() []byte

Encode implement PostRequest interface

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.