Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Package Service

Sellers use this service to create and manage their packages. A package is a deal you are prepared to offer to multiple buyers. Your package can be configured to display different pricing for different buyers. Create multiple packages to provide buyers with different deal options. 

If you would like to create a custom deal for one buyer rather than offering the deal to any buyer, see the Deal Service.

Buyers use the Package Buyer Access Service to browse through a seller's catalog of packages and generate deals for themselves.

On This Page

REST API

Add a new package: 
POST http://api.appnexus.com/package
(add_package JSON)

Update a package: 
PUT http://api.appnexus.com/package?id=PACKAGE_ID
(modify_package JSON)

View all of your packages: 
GET http://api.appnexus.com/package

View a specific package: 
GET http://api.appnexus.com/package?id=PACKAGE_ID

Delete a package: 
DELETE http://api.appnexus.com/package?id=PACKAGE_ID

Deleting a package deletes all of its associated deals as well. Campaigns targeting these associated deals will stop serving. The deletions are permanent and cannot be reverted. Although deleted deals continue to be available in reporting, you will no longer have visibility into their specific settings.

Find out which fields you can filter and sort by: 
GET http://api.appnexus.com/package/meta

JSON Fields

Name

Type (Length)

Description

Default

Required on

id

int

The ID of the package.

Auto-generated number

PUT, DELETE

name

string (255) 

The name of the package.

 

 

description

string (65535)

The description of the package. You can use this field to provide buyers additional insight and details about the package.

 

 

active

boolean

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

true

 

profile_id

int

The ID of the profile associated to the package. You can use a profile to specify publishers, placements, sites, content categories, segments, segment groups, or sizes that need to be involved in the auction in order for the deal to be available to the buyer. For more details, see publisher_targets , placement_targets , site_targets, content_category_targets , segment_targets , segment_group_targets, and  size_targets  in the Profile Service .

 

POST

default_ask_price

double

The ask price that will be applied to all deals generated from the package. When a buyer generates a deal, the Deal Service will automatically calculate the floor_price  by subtracting the seller revenue share specified in your AppNexus contract from the value in this field. This is the price shown to the buyer. It is the minimum they must bid in order to compete for the inventory.

You must use the member_ask_price field to set pricing when visibility_type is set to 2. When visibility_type is set to 1, you can use the member_ask_price field to set different pricing for select buyers.

 

POST

default_currency

enum

The ask price currency that will be applied to all deals generated from the package. For a full list of available currencies, use the read-only   Currency Service .

"USD"

 

default_use_deal_floor

boolean

If true, the default_ask_price will be applied to deals generated from the package. The deal's floor price will override any other floors you may have, i.e., in placements or yield management profiles.

If default_use_deal_floor is false, default_ask_price must be set to 0. In this case, note that although the ask price is shown as 0, no deal floor is actually applied; if you have any other floors (in placements or yield management profiles), they will be applied, or if you do not have any other floors, the standard second-price auction mechanics will apply.

true

 

last_modified

timestamp

The day and time when the package was last modified.

 

 

data_protectedbooleanNot yet supported.false 
allow_creative_add_on_viewbooleanNot yet supported.
false 
allow_creative_add_on_clicktrueNot yet supported.true 
visibility_profile_idintNot yet supported.null 
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.100 
seller

object

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

 

POST

default_deal_type 

object

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

 

 

visibility_typeobject

Defines if the package is visible to all buyers or select buyers. For more details, see Visibility Type below.

  
membersarray of objects

If visibility_type is set to "private", only the members listed in this field will be able to view the package. You can also use this field to define special pricing for select buyers. For more details, see Members below.

  
settingobjectThe type of content included in the package. For more details, see Setting below.   
sizesarray of objectsIf the profile associated with the package has size targets set, you can use this field to expose the specific sizes to buyers. For more details, see Sizes below.  

Seller

The seller object contains the following fields.

Field

Type

Description

Default

Required On
id intRead-only. The member ID of the seller.Seller's member IDPOST
namestringRead-only. The member name of the seller.Seller's member name 

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

Default

Required On
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 Service1 
namestringRead-only.  The name of the type of deal. Possible values: "Open Auction" or "Private Auction"."Open Auction" 

Visibility Type

The visibility_type object contains the following fields.

Field

Type

Description

Default

Required On
id int

The ID of the visibility level for your package. Possible values:

  • 1 = console
    A "console" package is visible to all buyers. Any buyer can create a deal from the package. Use the members array to define special pricing for select buyers. For more information, see Members below.
  • 2 = private
    A "private" package is only visible to the buyers specified in the members array. Only those buyers can create a deal from the package. Use the members array to define unique pricing for each of these buyers. For more information, see Members below.
  • 3 = hidden
    A "hidden" package is not visible to any buyers. 

    Hiding a package with associated deals will not affect the associated deals; however buyers can not generate any new deals from the package.

1 
namestring

Read-only. The name of the visibility level for your package. Possible values: "console", "private", or "hidden".

  

Members

If visibility_type is set to "private", only the buyers listed in this array can view the package. If visibility_type is set to "console", all buyers can view the package but you can define a different ask price for each of the buyers listed in this array. Each member object in this array contains the following fields. 

Field

Type

Description

Default

Required On
id intThe member ID of the buyer.  
namestring

Read-only. The member name of the buyer.

Buyer's member name 
member_use_deal_floorboolean

If true, the member_ask_price will be applied to deals that the buyer generates from the package. T his value will override any other floors you may have, i.e., in placements or yield management profiles.

The default_ask_price value will never apply to buyers in the members array. You must use the member_ask_price field to define an ask price for buyers listed in the members array.

true 
member_ask_priceint

The ask price that will be applied to deals the buyer generates from the package. When the buyer generates a deal, the Deal From Package Service will automatically calculate the floor_price by subtracting the seller revenue share specified in your AppNexus contract from the value in this field. This is the price shown to the buyer. It is the minimum they must bid in order to compete for the inventory.

If member_use_deal_floor is false, this field must be set to 0. In this case, note that although 0 is shown as the floor price, no deal floor is actually applied; if you have any other floors (in placements or yield management profiles), they will be applied, or if you do not have any other floors, the standard second-price auction mechanics will apply.

  

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

Default

Required On
has_inventorybooleanSet this field to true if the profile associated with the package has publisher, placement, site, or content category targets set. For more information, see the profile_id field. false 
inventory_descriptionstring

If has_inventory is set to true, use this field to provide a description of the inventory included in the package. Buyers cannot see the specific targets you have set so it is important to provide them with additional insight into the package contents.

  
has_segmentsboolean

Set this field to true if the profile associated with the package has segment or segment group targets set. For more information, see the profile_id field.

false   
segments_descriptionstring

If has_segments is set to true, use this field to provide a description of the segments included in the package. Buyers cannot see the specific targets you have set so it is important to provide them with additional insight into the package contents.

  
has_sizesbooleanSet this field to true if the profile associated with the package has size targets set. For more information, see the profile_id field. If you want buyers to see the specific sizes you have included, use the sizes field. false   

Sizes

Each object in the sizes array contains the following fields.

FieldTypeDescription
widthstringThe width of the creative.
heightstringThe size of the creative.

Examples

Create a new package for any buyer
Create a new package with custom pricing for selected buyers
Create a new package only visible to selected buyers
Modify a package
View all of your packages
 View a specific package
 Delete a package
  • No labels