Method: exchanges.orders.patch

更新订单。

HTTP 请求

PATCH https://dv360seller.googleapis.com/v1beta1/{order.name=exchanges/*/orders/*}

网址采用 gRPC 转码语法。

路径参数

参数
order.name

string

订单的相对资源名称。由服务器生成。示例:“exchanges/1234/orders/5678”。仅限输出。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "order": {
    "name": string,
    "displayName": string,
    "partnerId": [
      string
    ],
    "publisherEmail": string,
    "publisherName": string,
    "budget": {
      "budgetType": enum (BudgetType),

      // Union field budget can be only one of the following:
      "impressions": string,
      "money": {
        object (Money)
      }
      // End of list of possible types for union field budget.
    },
    "status": enum (OrderStatus),
    "wseatConfig": {
      "exchangeWseatStatus": enum (WSeatStatus),
      "exchangeWseatIds": [
        string
      ],
      "updateTime": string
    },
    "updateTime": string,
    "buyerInfo": {
      "partner": {
        object (PartnerInfo)
      },
      "advertisers": [
        {
          object (AdvertiserInfo)
        }
      ]
    }
  },
  "updateMask": string
}
字段
order.displayName

string

向买方显示的订单名称。最多 250 个字符。可选。

order.partnerId[]

string (int64 format)

Google Display & Video 360 中的合作伙伴 ID,以前称为 DoubleClick Bid Manager(DBM)。仅允许一个合作伙伴 ID。必需。

order.publisherEmail

string

发布商的电子邮件地址。必须是有效的电子邮件地址格式。最多 250 个字符。可选。

order.publisherName

string

发布商名称。最多 250 个字符。必需。

order.budget

object (Budget)

仅限输出。买方设置的预算。仅适用于即时交易方案。

order.status

enum (OrderStatus)

订单状态。在 DV3 用户接受、取消或归档订单后,状态可能会发生变化。还支持在 API 中创建后更新为“CANCELLED”,以表明相应订单已在 Exchange 中取消。

order.wseatConfig

object (WSeatConfig)

可选。WSeat 配置:指定交换机端的 WSeat 配置。采用多席位交易的交易所应确保此字段已填充且为最新状态。

order.updateTime

string (Timestamp format)

仅限输出。订单或其基础商品更新时的时间戳。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

order.buyerInfo

object (BuyerInfo)

仅限输出。买方信息,包括合作伙伴和广告客户详细信息。仅适用于即时交易方案。

updateMask

string (FieldMask format)

用于控制要更新的字段的掩码。必需。

这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo"

响应正文

如果成功,则响应正文包含一个 Order 实例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/doubleclickbidmanager

如需了解详情,请参阅 OAuth 2.0 Overview