REST Resource: exchanges.auctionPackages

    Resource: AuctionPackage

    Encapsulates a single auction package. Advertisers in DV3 can browse all auction packages in DV3 via the marketplace discovery UI and opt in to use these packages without seller action.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "status" 
 : 
 enum (  DiscoveryObjectStatus 
 
) 
 , 
 "description" 
 : 
 string 
 , 
 "format" 
 : 
 enum (  Format 
 
) 
 , 
 "forecast" 
 : 
 { 
 object (  SellerProvidedInventoryAvailabilityEstimate 
 
) 
 } 
 , 
 "externalDealId" 
 : 
 string 
 , 
 "logoUrl" 
 : 
 string 
 , 
 "floorPrice" 
 : 
 { 
 object (  Money 
 
) 
 } 
 , 
 "startTime" 
 : 
 string 
 , 
 "endTime" 
 : 
 string 
 , 
 "mediumType" 
 : 
 enum (  MediumType 
 
) 
 , 
 "urgOwners" 
 : 
 [ 
 enum (  UnderRepresentedGroup 
 
) 
 ] 
 , 
 "dv3MarketplaceUri" 
 : 
 string 
 }
    Fields
    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.
    displayName

    string

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

    enum ( DiscoveryObjectStatus )

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

    string

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

    enum ( Format )

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

    object ( SellerProvidedInventoryAvailabilityEstimate )

    Forecasting breakdown for this auction package’s inventory. DV3 advertisers can see and filter on these breakdowns. Optional.
    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.
    logoUrl

    string

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

    Output only.
    floorPrice

    object ( Money )

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

    enum ( MediumType )

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

    enum ( UnderRepresentedGroup )

    Optional. Under represented groups the owner is a member of, if any.
    dv3MarketplaceUri

    string

    Output only. Dv360 link for auction package in marketplace.

    Format

    Ad format for auction package.

    Enums
    DEAL_FORMAT_UNSPECIFIED Deal format unspecified. Not valid for input.
    DEAL_FORMAT_DISPLAY Display format.
    DEAL_FORMAT_VIDEO Video format.
    DEAL_FORMAT_AUDIO Audio format.

    Methods

    create

    		Creates a new auction package.

    get

    		Gets an auction package.

    list

    		Lists auction packages.

    patch

    		Updates an auction package.
    Upload logo for the specified package.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: