Packages functionality is currently in alpha. Products in alpha are experimental; they may be slightly less stable than fully-supported features.
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.
Add a new package:
Update a package:
View all of your packages:
View a specific package:
Delete a package:
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:
The ID of the package.
The name of the package.
The description of the package. You can use this field to provide buyers additional insight and details about the package.
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
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
You must use the
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 .
The day and time when the package was last modified.
|data_protected||boolean||Not yet supported.|
|allow_creative_add_on_view||boolean||Not yet supported.|
|allow_creative_add_on_click||true||Not yet supported.|
|visibility_profile_id||int||Not yet supported.|
|seller_rank||int||The 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.|
The name and ID of the seller who is offering the package. For more details, see Seller below.
The deal type that will be applied to all deals generated from the package. For more details, see Deal Type below.
Defines if the package is visible to all buyers or select buyers. For more details, see Visibility Type below.
|members||array of objects|
|setting||object||The type of content included in the package. For more details, see Setting below.|
|sizes||array of objects||If 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 object contains the following fields.
|id||int||Read-only. The member ID of the seller.||Seller's member ID|
|name||string||Read-only. The member name of the seller.||Seller's member name|
Default Deal Type
default_deal_type object contains the following fields. By default, all packages will generate deals with an open auction deal type.
|id||int||The ID representing the type of deal. Possible values: |
|name||string||Read-only. The name of the type of deal. Possible values: |
visibility_type object contains the following fields.
The ID of the visibility level for your package. Possible values:
Read-only. The name of the visibility level for your package. Possible values: "console", "private", or "hidden".
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.
|id||int||The member ID of the buyer.|
Read-only. The member name of the buyer.
|Buyer's member name|
If true, the
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
This information is used to give buyers a general understanding of the inventory included in the package. The
setting object contains the following fields.
|has_inventory||boolean||Set this field to |
Set this field to
|has_sizes||boolean||Set this field to |
Each object in the
sizes array contains the following fields.
|width||string||The width of the creative.|
|height||string||The size of the creative.|
Create a new package for any buyer
This package is visible to any buyer and has the same pricing for all buyers.
Create a new package with custom pricing for selected buyers
In this example, we create a new package that is visible to all buyers with a price of $3.00. For a few select buyers we set custom pricing below $3.00.
Create a new package only visible to selected buyers
In this example, we create a new package that is only visible to two buyers. We have set a different ask price for each buyer.
Modify a package
In this example, we update the name of the package.