customaudience

Documentation

Overview

Package customaudience 人群包相关API

Index

• func Delete(clt *core.SDKClient, accessToken string, req *customaudience.DeleteRequest) error
• func Publish(clt *core.SDKClient, accessToken string, req *customaudience.PublishRequest) error
• func Push(clt *core.SDKClient, accessToken string, req *customaudience.PushRequest) error
• func Read(clt *core.SDKClient, accessToken string, req *customaudience.ReadRequest) ([]customaudience.CustomAudience, error)
• func Select(clt *core.SDKClient, accessToken string, req *customaudience.SelectRequest) (*customaudience.SelectResponseData, error)

Functions

func Delete

func Delete(clt *core.SDKClient, accessToken string, req *customaudience.DeleteRequest) error

Delete 删除人群包 通过此接口可做人群包删除操作。已经在计划中使用的人群包不能被删除，只有该计划被删除后，人群包才可以删除。

func Publish

func Publish(clt *core.SDKClient, accessToken string, req *customaudience.PublishRequest) error

Publish 发布人群包 使用发布接口可以将人群包进行发布。 发布人群包接口简单的说是一个让人群包在平台生效的操作，存在以下4种场景将用到发布人群包接口： 1.在创建数据源，人群包ID首次生成后，必须先使用发布人群包接口将人群包发布，才可使用； 2.如果更新了数据源，需要使用发布人群包接口才能把数据源的最新的内容发布（更新）到人群包中，发布人群包后数据源的最新内容将在人群包中生效，否则更新内容将无法生效； 3.如果是推送人群包，推送之后同样需要调用发布人群包接口才可将人群包生效; 4.如果是拓展人群包或者运算人群包，人群包ID生成后同样也需要调用发布人群包接口才可将人群包生效；人群包发布是一个异步的过程，将有一段处理的时间，你可以通过【人群包详细信息】查询人群包的状态，其中返回参数delivery_status表征当前人群包可投放状态（包含是否发布完成）；发布频次限制：每个人群包每24小时只可发布一次，发布后需在24小时后才可以再次发布此人群包。

- 每当人群包的内容发生变化，就需要再次发布让变化生效！ - 发布是一个异步的过程，发布中不建议对数据源进行更新操作，这会导致人群包的发布过程推迟！

func Push

func Push(clt *core.SDKClient, accessToken string, req *customaudience.PushRequest) error

Push 推送人群包 每个人群包生成一个人群包id后，都需要经过推送，才可以在被推送的广告主下使用。同时，推送人群包可以将人群包共享给同主体的广告主。 您可以通过【人群包详细信息】查询人群包的状态，其中返回参数delivery_status表征当前人群包可投放状态（包含是否推送完成）；

- 推送的广告主列表的主体需要与人群包所属广告主的主体一致 - 经过拓展/运算的人群包生成了新的id，意味着需要将新的id再次推送一遍! - 和人群包发布不同的是，如果用户基于数据源进行了新增/删除/重置操作，不会导致对应的人群包id变化，所以不需要再次推送!

func Read

func Read(clt *core.SDKClient, accessToken string, req *customaudience.ReadRequest) ([]customaudience.CustomAudience, error)

Read 人群包详细信息 用户可以通过调用此接口，查询广告主下的指定人群包信息。支持查询已删除的人群包信息，具体包含的信息内容请查看应答参数。 人群包创建时间大于6个月，且近6个月没绑定计划以及产生消耗，该人群包会过期。（对应该接口status返回26）对于过期的人群包，只能重新建包，再次推送。

func Select

func Select(clt *core.SDKClient, accessToken string, req *customaudience.SelectRequest) (*customaudience.SelectResponseData, error)

Select 人群包列表 通过此接口你可以查询广告主下存在的的人群包列表和信息。 信息包括人群包的id，可用状态，来源，覆盖人群等； 该接口可以查到广告主id下所有人群包，无论是API创建的还是平台创建的。 当delivery_status:人群包可投放状态为可投放时，才可以在【创建广告计划】和【修改广告计划】的用户定向中使用！