Package

Package identifier (ID).

Used in resources: Packages

Field nameTypeConditionsDescription
banner_format_ididreadable default_field min_value=1 max_value=2147483647ID of the banner format used in the package.
banner_url_get_paramsstringreadableGET parameters to be added to the URL of each ad.
createddatetimereadable default_fieldTime of package creation.
descriptionstringreadable default_fieldPackage description.
ididreadable default_field min_value=1 max_value=2147483647Package ID.
max_price_per_unitpriceperunitreadable default_fieldMaximum price you can specify for a campaign based on the package.
max_uniq_shows_limitintegerreadable default_field max_value=2147483647Maximum number of times the ad is shown to a particular user that you can specify within the package.
namestringreadable default_fieldPackage name.
objectivelist of stringreadable default_fieldPossible objectives for campaigns in this package. Possible values: reach - Reach; traffic - Traffic; appinstalls - App installs; reengagement - Remarketing in app; playersengagement - Social network gamers; videoviews - Video views; storeproductssales - Store products sales; engagement - Conversions; articleviews - Article views; audiolistening - Audio ads; socialengagement - Social network actions; storevisits - Store visits; premium_reach - Premium network reach.
optionsobjectreadableLists of the targetings and settings available for a campaign based on the package. Can contain the "defaults" and "values" fields that specify the default and possible targeting values respectively. For more information about the sites you can target, use the PackagesPads method.
package_requeststringreadableStatus of package availability: - allowed - you can use the package - requested - you have requested the package, but it is not available yet - can_be_requested - you can request the package from the MyTarget support team: support_target@corp.my.com
pads_tree_ididreadable default_field min_value=1 max_value=2147483647ID of the pad tree. If the tree has no branches, the value is 0.
paid_event_typeintegerreadable default_field min_value=-2147483647 max_value=2147483647ID of the event for which you are charged: - 0 - 1000 shows - 1 - 1 click - 7 - convertion rate - 1013 - full video view - 1017 - view of the first 10 seconds of the video
pricepriceperunitreadable default_fieldDefault price of a campaign in the package. Unless you specify a custom price when creating a campaign, the default value will be used.
priced_event_typeintegerreadable default_field min_value=-2147483647 max_value=2147483647ID of the event for which campaign are optimized: - 0 - 1000 shows - 1 - 1 click - 7 - convertion rate - 1013 - full video view - 1017 - view of the first 10 seconds of the video
related_package_idslist of typereadable default_fieldIDs of the packages to which you can switch the existing campaigns based on the current package.
statusstringreadable writable default_field
choices =
  • active - Active package.
  • deleted - Deleted package.
  • blocked - Blocked package.
Package status. You can create campaigns only using active packages.
updateddatetimereadable default_fieldTime of the last package update.
url_typesobjectreadable default_fieldLink types allowed in the package. This is an object where the key is a link role and its value is an array of string arrays. The second-level arrays are lists of link types. In order for the link to have the specified role, it must belong to all the types listed in any of the second-level arrays. For example, if the field has the following value: [[type_1, type_2][type_1, type_3]], the link must belong either to both "type_1" and "type_2" OR to both "type_1" and "type_3".