Skip to end of metadata
Go to start of metadata

Package Buyer Access Service

This read-only service lets buyers view information about sellers' packages. A package is a deal that a seller is prepared to offer to any buyer. Buyers browse through available packages and then use the Deal From Package Service to generate deals for themselves.

On This Page

REST API

View all available packages:

View all packages offered by a specific seller:

View a specific package:

 View multiple packages by ID using a comma-separated list: 

View all packages including specific sizes:

Search for a package by name or ID:

Find out which fields you can filter and sort by: 

JSON Fields

Name

Type

Description

id

int

The ID of the package.

name

string

The name of the package.

description

string

The description of the package. Sellers generally use this to provide buyers greater insight into the deal.

active

Boolean

If true, the package is active. If false, you cannot generate deals from the package and all associated deals will stop serving.  

default_ask_price

double

The ask price that will be applied to all deals generated from the package. When you generate a deal, the Deal Buyer Access Service will automatically calculate the suggested_min_bid_price by adding the auction service charge specified in your AppNexus contract to the value in this field. For more information on the suggested_min_bid_price, see the Deal Buyer Access Service.

This field is relevant only if default_use_deal_floor is true.

default_currency

string

The ask price currency that will be applied to all deals generated from the package.

default_use_deal_floor

Boolean

If true, the default_ask_price  will be applied to deals generated from the package.

When  default_use_deal_floor  is true, the deal's ask price overrides any other floors the seller may have, i.e., in placements or yield management profiles.

last_modified

timestamp

The day and time when the package was last modified.

data_protectedBooleanNot yet supported.
allow_creative_add_on_viewBooleanNot yet supported.
allow_creative_add_on_clicktrueNot yet supported.
visibility_profile_idintNot yet supported.
seller_rankintThe seller's ranking for the package. This controls where the package will appear in the seller's full list of packages in the Console UI. Allowed range: 1 - 65355, where 1 is the highest ranking.
size_preferencestring

Specifies how this package handles private sizes. Private sizes are placement sizes that the seller can allow to serve in a package. There are two options:

  • standard: Private sizes are not available for this package.
  • append: Private sizes can be used in addition to the specified placement size.
technical_attribute_restrictBoolean

Specifies whether the package is restricted only to the technical attributes listed in the Technical Attributes object.

  • true: Package is restricted only to the listed technical attributes.
  • false: Other technical attributes are also allowed to serve.

seller

object

The name and ID of the seller who is offering the package. For more details, see Seller below.

default_deal_type

object

The deal type that will be applied to all deals generated from the package. For more details, see Default Deal Type below.

settingobjectThe type of content included in the package. For more details, see Setting below.
technical_attributesarray of objects

The technical attributes of creatives that are eligible for the package. For more details, see Technical Attributes below.

sizesarray of objectsThe creative sizes included in the package. For more details, see Sizes below.

Seller

The seller object contains the following fields.

Field

Type

Description

id intThe member ID of the seller.
namestringThe member name of the seller.

Default Deal Type

The default_deal_type object contains the following fields. By default, all packages will generate deals with an open auction deal type.

Field

Type

Description

id intThe ID representing the type of deal. Possible values: 1 (Open Auction) or 2 (Private Auction). For more information about open and private auctions, see the Deal Service
namestringRead-only. The name of the type of deal. Possible values: "Open Auction" or "Private Auction".

Setting

This information is used to give buyers a general understanding of the inventory included in the package. The setting object contains the following fields. 

Field

Type

Description

has_inventoryBooleanIf true, the package includes publisher, placement, site, or content category targets.
inventory_descriptionstring

If has_inventory is set to true, this field provides a description of the inventory included in the package.

has_segmentsBoolean

If true, the package includes segment targets.

segments_descriptionstring

If has_segments is set to true, this field provides a description of the segments included in the package.

has_sizesBooleanIf true, the package includes size targets. For the specific sizes included, see the sizes array.

Technical Attributes

Each technical_attribute object contains the following fields:

Field

Type

Description

id intThe ID of the technical attribute that is eligible for the package. You can use the Technical Attribute Service to retrieve technical attribute IDs.
namestringThe name of the technical attribute that is eligible for the package.
overrideBoolean

 If set to true, a technical attribute can serve for a package even if the ad quality profile would have blocked it.

Sizes

Each object in the sizes array contains the following fields.

Field

Type

Description

widthstringThe width of the creative.
heightstringThe height of the creative.

Examples

 View all available packages
 View all packages offered by a specific seller
 View a specific package
  • No labels