Method: exchanges.orders.products.patch

Updates a product.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
product.name

string

Relative route name for product. Generated by server. Example: "exchanges/1234/orders/5678/products/abc". Output only.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "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),
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "etag": string
  },
  "updateMask": string
}
Fields
product.displayName

string

The display name of the product.

Must be UTF-8 encoded with a maximum size of 240 bytes. Required.
product.externalDealId

string

External ID. This is the deal ID on exchange system. Max 100 characters. Allowed characters are alphanumeric, underscore, dash, and dot. Must be unique across all products. Required.
product.transactionType

enum (TransactionType)

Product transaction type. Required.
product.pricingType

enum (PricingType)

Pricing type for product. Required.
product.updateTime
(deprecated)

string (Timestamp format)

The timestamp when the product was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
product.startTime

string (Timestamp format)

Time when this product becomes active. Must be earlier than endTime. Start time cannot be more than 1 year in the future. Required.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
product.endTime

string (Timestamp format)

Time when this product becomes inactive. Currently cannot be later than year 2036. Required.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
product.rateDetails

object (RateDetails)

Rate details. Required.
product.creativeConfig[]

object (CreativeConfig)

The creative requirements for a product. Required for reserved transaction type product.
product.makegood
(deprecated)

boolean

Denotes whether a product is a makegood product.
product.makegoodDetails
(deprecated)

object (MakegoodDetails)

The makegood details for a product. Required when the product is a makegood.
product.creativeSource

enum (CreativeSource)

Creative source for a product. Optional, defaults to CREATIVE_SOURCE_ADVERTISER. Cannot be changed after product creation.
product.mediumType

enum (MediumType)

Medium type for a product. Defaults to DIGITAL if not specified for backwards compatibility. Cannot be changed after product creation.
product.targetingCriteria

object (TargetingCriteria)

Output only. Product targeting criteria references. Only applicable to Instant Deal Scenarios.
product.forecastResult

object (ForecastResult)

Product forecast results. Required when the targeting criteria are not empty and the forecast is not provided. Only applicable to Instant Deal Scenarios.
product.errorDetails

object (ErrorDetails)

Error details must be specified when specific product fields cannot be updated. Required when the forecast result cannot be provided due to a targeting criterion or an update cannot be made to the product. Only applicable to Instant Deal Scenarios.
product.frequencyCap

object (FrequencyCap)

Output only. Frequency cap selected by the buyer. Only applicable to Instant Deal Scenarios.
product.etag

string

An etag that needs to be specified when updating a product. It only needs to be specified for an update if the etag field is not empty. Only applicable to Instant Deal Scenarios.
updateMask

string (FieldMask format)

The mask to control which fields to update. Required.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

If successful, the response body contains an instance of Product.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.