资源:GuaranteedOrder
有保证的订单。
有保证订单是有保证广告资源来源的父实体。创建有保证的广告资源来源时,必须为广告资源来源分配有保证的订单 ID。
JSON 表示法 |
---|
{ "name": string, "legacyGuaranteedOrderId": string, "exchange": enum ( |
字段 | |
---|---|
name |
仅供输出。有保证的订单的资源名称。 |
legacyGuaranteedOrderId |
仅供输出。有保证订单的旧 ID。由原始广告交易平台分配。旧 ID 在一个广告交易平台中是唯一的,但不能保证在所有有保证订单中都是唯一的。此 ID 将在 SDF 和界面中使用。 |
exchange |
必需。不可变。发起有保证订单的广告交易平台。 |
guaranteedOrderId |
仅供输出。有保证的订单的唯一标识符。有保证订单 ID 的格式为 |
displayName |
必需。有保证的订单的显示名称。 必须采用 UTF-8 编码,大小上限为 240 个字节。 |
status |
有保证订单的状态设置。 |
updateTime |
仅供输出。上次更新有保证订单时的时间戳。由系统分配。 采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例: |
publisherName |
必需。有保证订单的发布商名称。 必须采用 UTF-8 编码,大小上限为 240 个字节。 |
readAccessInherited |
|
readAdvertiserIds[] |
对有保证的订单具有读取权限的广告客户的 ID。 此字段不得包含分配给 |
defaultAdvertiserId |
仅供输出。有保证订单的默认广告客户的 ID。 默认广告客户为 |
defaultCampaignId |
分配给有保证订单的默认广告系列的 ID。 默认广告系列必须属于默认广告客户。 |
联合字段 对有保证的订单拥有读写权限的合作伙伴或广告客户。 |
|
readWritePartnerId |
对有保证的订单具有读写权限的合作伙伴。 |
readWriteAdvertiserId |
对有保证的订单具有读写权限的广告客户。这也是有保证订单的默认广告客户。 |
GuaranteedOrderStatus
有保证订单的状态设置。
JSON 表示法 |
---|
{ "entityStatus": enum ( |
字段 | |
---|---|
entityStatus |
有保证的订单是否可投放。 可接受的值包括 |
entityPauseReason |
用户提供的暂停此有保证订单的原因。 必须采用 UTF-8 编码,长度上限为 100 字节。 仅在 |
configStatus |
仅供输出。有保证的订单的配置状态。 可接受的值包括 必须先配置有保证订单(填写必填字段、选择广告素材并选择默认广告系列),然后该订单才能投放。目前只能通过界面执行配置操作。 |
GuaranteedOrderConfigStatus
有保证订单的可能配置状态。
枚举 | |
---|---|
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED |
该版本中未指定审批状态或审批状态未知。 |
PENDING |
有保证订单的起始状态。处于此状态的有保证订单需要先配置,然后才能投放。 |
COMPLETED |
买方配置有保证订单后的状态。 |
方法 |
|
---|---|
|
创建新的有保证订单。 |
|
可以修改有保证订单的广告客户。 |
|
获取有保证的订单。 |
|
列出当前用户访问的有保证订单。 |
|
更新现有的有保证订单。 |