customaudience

package
v1.24.4 Latest Latest
Warning

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

Go to latest
Published: Apr 18, 2024 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Overview

Package customaudience 人群包相关API models

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CopyRequest added in v1.8.21

type CopyRequest struct {
	// AdvertiserID 人群包所属广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CustomAudienceID 人群包ID
	CustomAudienceID uint64 `json:"custom_audience_id,omitempty"`
	// ToAdvertiserID 推送广告主ID(云图虚拟广告主ID,即virtual_adv_id),可以通过【获取广告账户关联云图账户信息】接口获取
	ToAdvertiserID []uint64 `json:"to_advertiser_id,omitempty"`
}

CopyRequest 推送dmp人群包到云图账户 API Request

func (CopyRequest) Encode added in v1.8.21

func (r CopyRequest) Encode() []byte

Encode implement PostRequest interface

type CustomAudience

type CustomAudience struct {
	// ID 人群包ID
	ID uint64 `json:"custom_audience_id,omitempty"`
	// Isdel 人群包是否删除,枚举值:"1":已删除,"0":未删除
	Isdel int `json:"isdel,omitempty"`
	// DataSourceID 数据源ID
	DataSourceID string `json:"data_source_id,omitempty"`
	// Name 人群包名称
	Name string `json:"name,omitempty"`
	// Source 人群包来源,详见【附录-DMP相关-人群包来源】
	Source enum.DmpSource `json:"source,omitempty"`
	// Status 人群包状态,详见【附录-DMP相关-人群包状态】
	Status int `json:"status,omitempty"`
	// DeliveryStatus 人群包可投放状态
	DeliveryStatus enum.CustomAudienceDeliveryStatus `json:"delivery_status,omitempty"`
	// CoverNum 人群包覆盖人群数目,基于"upload_num":上传数据源包含的人群数目与uid对应后,再与头条系产品MAU交集后的数量(存在一个设备号/手机号对应多个uid的情况)
	// 实际数量可能多于/少于"upload_num":上传数据源包含的人群数目
	CoverNum int64 `json:"cover_num,omitempty"`
	// UploadNum 上传数据源包含的人群数目
	UploadNum int64 `json:"upload_num,omitempty"`
	// Tag 人群包标签,通过数据源创建的人群包,标签会默认为"API文件数据源"
	Tag string `json:"tag,omitempty"`
	// PushStatus 推送状态,详见【附录-DMP相关-DMP推送状态】
	PushStatus enum.DmpPushStatus `json:"push_status,omitempty"`
	// CreateTime 人群包创建时间
	CreateTime string `json:"create_time,omitempty"`
	// ModifyTime 人群包修改时间
	ModifyTime string `json:"modify_time,omitempty"`
	// ThirdPartyInfo 是否为三方包,均返回“非三方包”
	ThirdPartyInfo string `json:"third_party_info,omitempty"`
	// ExistPullOffTag 人群包是否包含下线标签,0:不包含,1:包含
	ExistPullOffTag int `json:"exist_pull_off_tag,omitempty"`
}

CustomAudience 人群包

type DeleteRequest

type DeleteRequest struct {
	// AdvertiserID 人群包所属广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CustomAudienceID 人群包ID
	CustomAudienceID uint64 `json:"custom_audience_id,omitempty"`
}

DeleteRequest 删除人群包

func (DeleteRequest) Encode

func (r DeleteRequest) Encode() []byte

Encode implement PostRequest interface

type PublishRequest

type PublishRequest struct {
	// AdvertiserID 人群包所属广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CustomAudienceID 人群包ID
	CustomAudienceID uint64 `json:"custom_audience_id,omitempty"`
}

PublishRequest 发布人群包

func (PublishRequest) Encode

func (r PublishRequest) Encode() []byte

Encode implement PostRequest interface

type PushRequest

type PushRequest struct {
	// AdvertiserID 人群包所属广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CustomAudienceID 人群包ID
	CustomAudienceID uint64 `json:"custom_audience_id,omitempty"`
	// TargetAdvertiserIDs 推送广告主ID列表,最多推送100个广告主
	TargetAdvertiserIDs []uint64 `json:"target_advertiser_ids,omitempty"`
}

PushRequest 推送人群包

func (PushRequest) Encode

func (r PushRequest) Encode() []byte

Encode implement PostRequest interface

type ReadRequest

type ReadRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CustomAudienceIDs 人群包ID列表,长度取值范围:1-100
	CustomAudienceIds []uint64 `json:"custom_audience_ids,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 {
	// CustomAudienceList 人群包列表数据
	CustomAudienceList []CustomAudience `json:"custom_audience_list,omitempty"`
}

ReadResponseData json返回值

type SelectRequest

type SelectRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// SelectType 查询类型,枚举值:"0":该广告主创建的人群包和被推送给该广告主的人群包,"1":状态为可投放的人群包
	SelectType int `json:"select_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"`
}

SelectRequest 人群包列表API Request

func (SelectRequest) Encode

func (r SelectRequest) Encode() string

Encode implement GetRequest interface

type SelectResponse

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

SelectResponse 人群包列表API Response

type SelectResponseData

type SelectResponseData struct {
	// CustomAudienceList 人群包列表数据
	CustomAudienceList []CustomAudience `json:"custom_audience_list,omitempty"`
	// Offset 偏移,类似于SQL中offset(起始为0,翻页时new_offset=old_offset+limit)
	Offset int `json:"offset,omitempty"`
	// TotalNum 总的人群包数量
	TotalNum int `json:"total_num,omitempty"`
}

SelectResponseData json返回值

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL