Method: exchanges.auctionPackages.patch

  • The PATCH request updates an auction package using the provided URL and path parameters.

  • The request body defines the properties of the auction package to be updated, including required fields like display name, status, description, format, external deal ID, floor price, start time, end time, and medium type.

  • The updateMask field is required in the request body to specify which fields of the auction package are being updated.

  • A successful response will return an instance of the updated AuctionPackage.

  • The request requires authorization using the https://www.googleapis.com/auth/doubleclickbidmanager OAuth scope.

Updates an auction package.

HTTP request

PATCH https://dv360seller.googleapis.com/v1beta1/{auctionPackage.name=exchanges/*/auctionPackages/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
auctionPackage.name

string

Relative route name for this auction package. Should be of the form: "exchanges/{seller_id}/auctionpackages/{auction_package_id} Example: "exchanges/1234/auctionPackage/5678". Output only.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "auctionPackage": {
    "name": string,
    "displayName": string,
    "status": enum (DiscoveryObjectStatus),
    "description": string,
    "format": enum (Format),
    "forecast": {
      "weeklyImpressions": string,
      "weeklyUniques": string,
      "breakdowns": [
        {
          object (TargetingDimensionBreakdown)
        }
      ],
      "appsBreakdown": [
        {
          object (MobileAppSlice)
        }
      ]
    },
    "externalDealId": string,
    "logoUrl": string,
    "floorPrice": {
      "currencyCode": string,
      "units": string,
      "nanos": integer
    },
    "startTime": string,
    "endTime": string,
    "mediumType": enum (MediumType),
    "urgOwners": [
      enum (UnderRepresentedGroup)
    ],
    "dv3MarketplaceUri": string
  },
  "updateMask": string
}
Fields
auctionPackage.displayName

string

The display name of this auction package. Must be UTF-8 encoded with a maximum size of 240 characters. Required.
auctionPackage.status

enum (DiscoveryObjectStatus)

The status of this auction package. Packages with status PAUSED or REMOVED are not shown to DV3 advertisers. Required.
auctionPackage.description

string

The description text for this package. Must be UTF-8 encoded with a maximum size of 2000 characters. Required.
auctionPackage.format

enum (Format)

The underlying ad format type. Required. Updates not allowed after creation.
auctionPackage.forecast

object (SellerProvidedInventoryAvailabilityEstimate)

Forecasting breakdown for this auction package’s inventory. DV3 advertisers can see and filter on these breakdowns. Optional.
auctionPackage.externalDealId

string

The exchange deal id used in bid requests. Max 100 characters. Allowed characters are alphanumeric, underscore, dash, and dot. Required. Required. Not allow updates after creation.
auctionPackage.logoUrl

string

Output only. The url for the logo of this auction package.

Output only.
auctionPackage.floorPrice

object (Money)

The floor price of this auction package. Required.
auctionPackage.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".
auctionPackage.endTime

string (Timestamp format)

Time when this product becomes inactive. 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".
auctionPackage.mediumType

enum (MediumType)

Required. Medium type of the auction package.
auctionPackage.urgOwners[]

enum (UnderRepresentedGroup)

Optional. Under represented groups the owner is a member of, if any.
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".
auctionPackage.dv3MarketplaceUri

string

Output only. Dv360 link for auction package in marketplace.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.