- 资源:有保证的订单
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- GuaranteedOrderStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- GuaranteedOrderConfigStatus
- 方法
资源:有保证的订单
有保证的订单。
有保证的订单是有保证广告资源来源的父级实体。创建有保证的广告资源来源时,必须向该广告资源来源分配一个有保证的订单 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 |
买方配置有保证订单后的状态。 |
方法 |
|
---|---|
|
创建新的有保证订单。 |
|
修改有保证订单的读取广告客户。 |
|
获取有保证的订单。 |
|
列出当前用户可以访问的有保证订单。 |
|
更新现有的有保证订单。 |