Release Notes

This page provides release notes for the DCM/DFA Reporting and Trafficking API.

Version 3.1

New features

• The following resources have been added:

  Resource
  MobileApps

• The following fields have been added:

  Resource	Field(s)
  AdvertiserLandingPages	deepLinks[]

• The following enumeration values have been added for all versions of the API:

  Resource	Field	New Value(s)
  Ads Creatives InventoryItems Placements	compatibility compatibility adSlots[].compatibility compatibility	IN_STREAM_AUDIO
  Conversions	encryptionInfo.encryptionEntityType	DFP_NETWORK_CODE
  CreativeAssets Creatives	assetIdentifier.type creativeAssets[].assetIdentifier.type	AUDIO
  Creatives	creativeAssets[].role	PARENT_AUDIO TRANSCODED_AUDIO
  Creatives	type	INSTREAM_AUDIO

Sunsets

• The following fields have been removed or replaced:

  Resource	Field	Replacement
  Creatives	creativeAssets[].videoDuration videoDescription videoDuration	creativeAssets[].mediaDuration mediaDescription mediaDuration

Known Issues

• None

Version 3.0

New features

• The following resource has been added:

  Resource
  AdvertiserLandingPages

• The following fields have been added:

  Resource	Field(s)
  Campaigns	defaultLandingPageId
  CreativeAssets	clickTag.clickThroughUrl
  Creatives	backupImageExit.exitClickThroughUrl counterCustomEvents[].exitClickThroughUrl creativeAssets[].orientation exitCustomEvents[].exitClickThroughUrl politeLoadAssetId timerCustomEvents[].exitClickThroughUrl
  FloodlightActivities	floodlightTagType globalSiteTagGlobalSnippet
  Placements	videoSettings.orientation

Sunsets

• The following resource has been removed or replaced:

  Resource	Replacement
  LandingPages	AdvertiserLandingPages

• The following fields have been removed or replaced:

  Resource	Field	Replacement
  CreativeAssets	clickTag.value	clickTag.clickThroughUrl
  Creatives	backupImageExit.exitUrl counterCustomEvents[].exitUrl exitCustomEvents[].exitUrl timerCustomEvents[].exitUrl	backupImageExit.exitClickThroughUrl counterCustomEvents[].exitClickThroughUrl exitCustomEvents[].exitClickThroughUrl timerCustomEvents[].exitClickThroughUrl
  FloodlightActivities	imageTagEnabled	floodlightTagType
  LandingPages	default id name url	Campaigns.defaultLandingPageId AdvertiserLandingPages.id AdvertiserLandingPages.name AdvertiserLandingPages.url

• The following method parameters have been removed or replaced:

  Resource	Method	Parameter	Replacement
  Campaigns	insert	defaultLandingPageName defaultLandingPageUrl	Campaigns.defaultLandingPageId

Known Issues

1. Landing pages in DCM are now managed at the advertiser level. Learn more about advertiser landing pages in the DCM help center.

   • New advertiser landing pages may be created via AdvertiserLandingPages.insert. These landing pages are shared across all of the advertiser's campaigns, ads, and creatives.
   • When inserting a new campaign, a defaultLandingPageId is now required. This value must be the ID of a landing page associated with the parent advertiser.
   • Advertiser landing pages cannot be deleted. To hide a landing page that's no longer in use, set it's archived field to true.
2. The data type of Creatives.backupImageClickThroughUrl has changed from string to CreativeClickThroughUrl.
3. The new FloodlightActivities.floodlightTagType field is required for insert and update requests.

Version 2.8

New features

• The following methods have been added:

  Resource	Method(s)
  Conversions	batchupdate

• The following fields have been added:

  Resource	Field(s)
  Campaigns	adBlockingConfiguration
  Creatives	universalAdId
  Placements	adBlockingOptOut

• The following enumeration values have been added for all versions of the API:

  Resource	Field	New Value(s)
  AccountActiveAdSummaries Accounts	activeAdsLimitTier activeAdsLimitTier	ACTIVE_ADS_TIER_1M
  Placements	tagFormats	PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4

Sunsets

• The following fields have been removed or replaced:

  Resource	Field	Replacement
  Creatives	auto_advance_images	autoAdvanceImages
  DirectorySites	dfp_settings dfp_settings.dfp_network_code dfp_settings.dfp_network_name instream_video_placement_accepted	dfpSettings dfpSettings.dfpNetworkCode dfpSettings.dfpNetworkName instreamVideoPlacementAccepted
  FloodlightConfigurations	standardVariableTypes
  Sites	siteSettings.disableBrandSafeAds	siteSettings.adBlockingOptOut

• The following method parameter has been replaced:

  Resource	Method	Parameter	Replacement
  DirectorySites	list	dfp_network_code	dfpNetworkCode

Known Issues

• None

Version 2.7

New features

• The following resource has been added:

  Resource
  VideoFormats

• The following fields have been added:

  Resource	Field(s)
  Creatives	progressOffset skipOffset
  Placements	videoActiveViewOptOut videoSettings vpaidAdapterChoice
  Sites	siteSettings.videoActiveViewOptOutTemplate siteSettings.vpaidAdapterChoiceTemplate

• The following enumeration values have been added for all versions of the API:

  Resource	Field	New Value(s)
  AccountActiveAdSummaries Accounts	activeAdsLimitTier activeAdsLimitTier	ACTIVE_ADS_TIER_750K
  ChangeLogs	objectType	OBJECT_SEARCH_LIFT_STUDY

Sunsets

• The following field has been replaced:

  Resource	Field	Replacement
  Sites	siteSettings.videoActiveViewOptOut	siteSettings.videoActiveViewOptOutTemplate

• The following method parameter has been removed:

  Resource	Method	Parameter
  Ads	list	creativeType

Known Issues

• None