Method: exchanges.orders.products.patch

更新商品。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
product.name

string

商品的相对路线名称。由服务器生成。示例：“exchanges/1234/orders/5678/products/abc”。仅限输出。

请求正文

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

JSON 表示法 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "etag": string
  },
  "updateMask": string
}
字段
product.displayName

string

商品的显示名称。

必须采用 UTF-8 编码，大小不得超过 240 字节。必填。
product.externalDealId

string

外部 ID。这是广告交易平台系统中的交易 ID。最多 100 个字符。允许的字符包括字母数字、下划线、短划线和英文句点。在所有商品中必须是唯一的。必填。
product.transactionType

enum (TransactionType)

商品交易类型。必填。
product.pricingType

enum (PricingType)

商品的定价类型。必填。
product.updateTime
(deprecated)

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"。
product.startTime

string (Timestamp format)

此商品生效的时间。必须早于 endTime。开始时间不得超过 1 年后。必填。

采用 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"。
product.endTime

string (Timestamp format)

此商品变为非活跃状态的时间。目前不能晚于 2036 年。必填。

采用 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"。
product.rateDetails

object (RateDetails)

费率详情。必填。
product.creativeConfig[]

object (CreativeConfig)

商品的广告素材要求。必须为预留交易类型商品提供此属性。
product.makegood
(deprecated)

boolean

表示商品是否为补偿商品。
product.makegoodDetails
(deprecated)

object (MakegoodDetails)

商品的补偿详情。如果商品是补发商品，则必须填写此属性。
product.creativeSource

enum (CreativeSource)

商品的广告素材来源。可选，默认为 CREATIVE_SOURCE_ADVERTISER。商品创建后无法更改。
product.mediumType

enum (MediumType)

商品的媒体类型。出于向后兼容性考虑，如果未指定，则默认为 DIGITAL。商品创建后无法更改。
product.audienceTargetingConfig

object (AudienceTargetingConfig)

可选。所选的受众群体定位配置会在广告交易平台上应用于交易级。
product.targetingCriteria

object (TargetingCriteria)

仅限输出。商品定位条件参考。仅适用于即时交易场景。
product.forecastResult

object (ForecastResult)

商品预测结果。如果定位条件不为空且未提供预测，则此字段为必填项。仅适用于即时交易场景。
product.errorDetails

object (ErrorDetails)

如果无法更新特定商品字段，则必须指定错误详情。如果因定位条件而无法提供预测结果，或者无法更新产品，则必须提供此属性。仅适用于即时交易场景。
product.frequencyCap

object (FrequencyCap)

仅限输出。买方选择的频次上限。仅适用于即时交易场景。
product.etag

string

更新商品时需要指定的 etag。只有当 etag 字段不为空时，才需要为更新指定该字段。仅适用于即时交易场景。
updateMask

string (FieldMask format)

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

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

响应正文

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

授权范围

需要以下 OAuth 范围：

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

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