This page contains the release notes for the currently active versions of Google Ad Manager API. Release notes from some previous versions that are no longer available are exposed only for completeness.
v202102
What's New
- Administrative
-
- Renamed AuthenticationError.NOT_WHITELISTED_FOR_API_ACCESS to AuthenticationError.NETWORK_API_ACCESS_DISABLED.
- Creatives
-
- Added support for AudioCreative types.
- Added CreativeSizeType.IGNORED for click tracking creatives.
- Line Items
-
- Removed deprecated field isPrioritizedPreferredDealsEnabled.
- Removed deprecated field adExchangeAuctionOpeningPriority.
- Reporting
-
- Added DOMAIN dimension.
- Added BROWSER_NAME dimension.
- Added VIDEO_PLACEMENT_NAME dimension.
- Added CLASSIFIED_YIELD_PARTNER_NAME dimension.
- Video
-
- LineItem.videoMaxDuration is now a required field when creating Video line items.
- Added additional ThirdPartyMeasurementSettings fields.
API Changes
-
≠
ActivityGroupService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ActivityService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
AdExclusionRuleService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
AdRuleService (2 new, 3 changed, 0 removed)-
+
type GeoTargetingError -
+
enum GeoTargetingError.Reason -
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
type GeoTargetingError-
+
field reason
-
-
-
≠
AdjustmentService (0 new, 3 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum ForecastAdjustmentError.Reason
-
-
≠
AudienceSegmentService (2 new, 3 changed, 0 removed)-
+
type CustomTargetingError -
+
enum CustomTargetingError.Reason -
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
type CustomTargetingError-
+
field reason
-
-
-
≠
CdnConfigurationService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CmsMetadataService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CompanyService (1 new, 3 changed, 0 removed)-
+
type ReInviteAction -
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
type ChildPublisher-
+
field proposedRevenueShareMillipercent
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ContactService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ContentBundleService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ContentService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CreativeReviewService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CreativeTemplateService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CreativeWrapperService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CustomFieldService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
CustomTargetingService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
DaiAuthenticationKeyService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
DaiEncodingProfileService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ForecastService (0 new, 7 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum CreativeSizeType-
+
value IGNORED
-
-
≠
enum LineItemCreativeAssociationError.Reason -
≠
enum LineItemError.Reason -
≠
type LineItemSummary-
−
field adExchangeAuctionOpeningPriority -
−
field isPrioritizedPreferredDealsEnabled
-
-
≠
type ThirdPartyMeasurementSettings-
+
field brandLiftClientId -
+
field brandLiftPartner -
+
field brandLiftReportingId -
+
field publisherViewabilityClientId -
+
field publisherViewabilityPartner -
+
field publisherViewabilityReportingId
-
-
-
≠
InventoryService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
LabelService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
LineItemService (0 new, 7 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum CreativeSizeType-
+
value IGNORED
-
-
≠
enum LineItemCreativeAssociationError.Reason -
≠
enum LineItemError.Reason -
≠
type LineItemSummary-
−
field adExchangeAuctionOpeningPriority -
−
field isPrioritizedPreferredDealsEnabled
-
-
≠
type ThirdPartyMeasurementSettings-
+
field brandLiftClientId -
+
field brandLiftPartner -
+
field brandLiftReportingId -
+
field publisherViewabilityClientId -
+
field publisherViewabilityPartner -
+
field publisherViewabilityReportingId
-
-
-
≠
LineItemTemplateService (0 new, 4 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum LineItemCreativeAssociationError.Reason -
≠
enum LineItemError.Reason
-
-
≠
LiveStreamEventService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
MobileApplicationService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
NativeStyleService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
NetworkService (0 new, 3 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
type ChildPublisher-
+
field proposedRevenueShareMillipercent
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
OrderService (0 new, 4 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum LineItemCreativeAssociationError.Reason -
≠
enum LineItemError.Reason
-
-
≠
PlacementService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ProposalLineItemService (0 new, 5 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum CreativeSizeType-
+
value IGNORED
-
-
≠
enum LineItemError.Reason -
≠
type ThirdPartyMeasurementSettings-
+
field brandLiftClientId -
+
field brandLiftPartner -
+
field brandLiftReportingId -
+
field publisherViewabilityClientId -
+
field publisherViewabilityPartner -
+
field publisherViewabilityReportingId
-
-
-
≠
ProposalService (0 new, 3 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum CreativeSizeType-
+
value IGNORED
-
-
-
≠
PublisherQueryLanguageService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
ReportService (0 new, 3 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
enum Dimension-
+
value BROWSER_NAME -
+
value VIDEO_PLACEMENT_NAME -
+
value AD_EXCHANGE_DFP_MOBILE_APP_NAME -
+
value AD_EXCHANGE_MOBILE_APP_RESOLVED_ID -
+
value EXCHANGE_THIRD_PARTY_COMPANY_NAME -
+
value DOMAIN -
−
value AD_EXCHANGE_MOBILE_APP_NAME
-
-
-
≠
SiteService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
StreamActivityMonitorService (1 new, 4 changed, 0 removed)-
+
enum ReportingType -
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
≠
type LinearStreamCreateRequest-
+
field prefetchEnabled
-
-
≠
type StreamCreateRequest-
+
field reportingType
-
-
-
≠
SuggestedAdUnitService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
TargetingPresetService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
TargetingService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
TeamService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
UserService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
-
≠
UserTeamAssociationService (0 new, 2 changed, 0 removed)-
≠
enum AuthenticationError.Reason-
−
value NOT_WHITELISTED_FOR_API_ACCESS
-
-
≠
enum CommonError.Reason-
+
value UNSUPPORTED_OPERATION
-
-
v202011
What's New
- Administrative
-
- Added
getDefaultThirdPartyDataDeclaration
method toNetworkService
to fetch the ad technology providers declared on your Network.
- Added
- Forecasts
-
- Added
getTrafficData
method toForecastService
which returns forecasted and historical traffic data for segments of traffic. - Added
FORECASTED_CREATIVE_RESTRICTION
toTargetingCriteriaBreakdown.targetingDimension
in order to see the impact of creative restrictions
- Added
- Reporting
-
- Added
MOBILE_APP_RESOLVED_ID
for breaking reports down by mobile app id as assigned by its app store. - Added
UNIFIED_PRICING_RULE_NAME
andUNIFIED_PRICING_RULE_ID
dimensions. - Added support for Ad Speed
reports. Check the
Column
documentation and search “Ad speed” to see all newly added metrics. Similarly, check theDimension
documentation to see which existing dimensions are compatible.
- Added
- Video
-
- Added
LiveStreamEvent.adServingFormat
for specifying whether ads are served by Google Ad Manager DAI or Google Ad Serving. - Added
GrpSettings.applyTrueCoview
to apply Nielsen's "Average number of viewers" data to a videoLineItem
. - Added
GrpSettings.pacingDeviceCategorizationType
for specifying whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
- Added
- Error Handling
-
- Added
BUYER_NOT_FOUND
toProposalService
andProposalLineItemService
to be thrown if a given buyer is deactivated or otherwise not found. - Added
KEY_STATUS_NOT_ACTIVE
andVALUE_STATUS_NOT_ACTIVE
to be thrown if custom targeting has any non-active keys or values in it.
- Added
API Changes
-
=
ActivityGroupService (no changes) -
=
ActivityService (no changes) -
=
AdExclusionRuleService (no changes) -
≠
AdRuleService (0 new, 1 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
-
≠
AdjustmentService (0 new, 1 changed, 1 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
−
type VolumeTimeSeriesRequestError
-
-
≠
AudienceSegmentService (0 new, 1 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
-
=
CdnConfigurationService (no changes) -
=
CmsMetadataService (no changes) -
=
CompanyService (no changes) -
=
ContactService (no changes) -
=
ContentBundleService (no changes) -
=
ContentService (no changes) -
=
CreativeReviewService (no changes) -
=
CreativeService (no changes) -
=
CreativeSetService (no changes) -
=
CreativeTemplateService (no changes) -
=
CreativeWrapperService (no changes) -
=
CustomFieldService (no changes) -
≠
CustomTargetingService (1 new, 2 changed, 0 removed)-
+
enum ValueDeclarationType -
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
type CustomTargetingKey-
+
field valueDeclarationType
-
-
-
=
DaiAuthenticationKeyService (no changes) -
=
DaiEncodingProfileService (no changes) -
≠
ForecastService (1 new, 5 changed, 0 removed)-
+
operation getTrafficData -
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
type GrpSettings-
+
field applyTrueCoview -
+
field pacingDeviceCategorizationType
-
-
≠
enum LineItemError.Reason -
≠
enum TargetingDimension-
+
value FORECASTED_CREATIVE_RESTRICTION
-
-
≠
operation getTrafficData-
+
response rval -
+
parameter trafficDataRequest
-
-
-
=
InventoryService (no changes) -
=
LabelService (no changes) -
≠
LineItemCreativeAssociationService (0 new, 1 changed, 0 removed)-
≠
enum LineItemError.Reason
-
-
≠
LineItemService (0 new, 3 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
type GrpSettings-
+
field applyTrueCoview -
+
field pacingDeviceCategorizationType
-
-
≠
enum LineItemError.Reason
-
-
≠
LineItemTemplateService (0 new, 2 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
enum LineItemError.Reason
-
-
≠
LiveStreamEventService (2 new, 1 changed, 0 removed)-
+
type AdBreakMarkupError -
+
enum AdServingFormat -
≠
type LiveStreamEvent-
+
field adServingFormat
-
-
-
=
MobileApplicationService (no changes) -
≠
NativeStyleService (0 new, 2 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
enum NativeStyleError.Reason-
+
value INVALID_STATUS
-
-
-
≠
NetworkService (1 new, 1 changed, 0 removed)-
+
operation getDefaultThirdPartyDataDeclaration -
≠
operation getDefaultThirdPartyDataDeclaration-
+
response rval
-
-
-
≠
OrderService (0 new, 2 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
enum LineItemError.Reason
-
-
=
PlacementService (no changes) -
≠
ProposalLineItemService (0 new, 3 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
≠
enum LineItemError.Reason -
≠
enum ProposalLineItemProgrammaticError.Reason-
+
value BUYER_NOT_FOUND
-
-
-
≠
ProposalService (0 new, 1 changed, 0 removed)-
≠
enum ProposalLineItemProgrammaticError.Reason-
+
value BUYER_NOT_FOUND
-
-
-
=
PublisherQueryLanguageService (no changes) -
≠
ReportService (0 new, 3 changed, 0 removed)-
≠
enum Column-
+
value CREATIVE_LOAD_TIME_0_500_MS_PERCENT -
+
value CREATIVE_LOAD_TIME_500_1000_MS_PERCENT -
+
value CREATIVE_LOAD_TIME_1_2_S_PERCENT -
+
value CREATIVE_LOAD_TIME_2_4_S_PERCENT -
+
value CREATIVE_LOAD_TIME_4_8_S_PERCENT -
+
value CREATIVE_LOAD_TIME_GREATER_THAN_8_S_PERCENT -
+
value UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT -
+
value UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT -
+
value UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT -
+
value UNVIEWED_REASON_USER_SCROLLED_BEFORE_1_S_PERCENT -
+
value UNVIEWED_REASON_OTHER_PERCENT -
+
value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_0_500_MS_PERCENT -
+
value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_500_1000_MS_PERCENT -
+
value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_1_2_S_PERCENT -
+
value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_2_4_S_PERCENT -
+
value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_4_8_S_PERCENT -
+
value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_GREATER_THAN_8_S_PERCENT -
+
value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT -
+
value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT -
+
value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT -
+
value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT -
+
value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT -
+
value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT -
+
value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT -
+
value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT -
+
value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT -
+
value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT -
+
value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT -
+
value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT -
−
value DYNAMIC_ALLOCATION_INVENTORY_LEVEL_WITH_CPD_PERCENT_REVENUE
-
-
≠
enum Dimension-
+
value MOBILE_APP_RESOLVED_ID -
+
value UNIFIED_PRICING_RULE_ID -
+
value UNIFIED_PRICING_RULE_NAME
-
-
≠
enum DimensionAttribute
-
-
≠
SiteService (1 new, 1 changed, 0 removed)-
+
operation updateSites -
≠
operation updateSites
-
-
=
StreamActivityMonitorService (no changes) -
=
SuggestedAdUnitService (no changes) -
≠
TargetingPresetService (0 new, 1 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
-
≠
TargetingService (0 new, 1 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value KEY_STATUS_NOT_ACTIVE -
+
value VALUE_STATUS_NOT_ACTIVE -
+
value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
-
-
-
=
TeamService (no changes) -
=
UserService (no changes) -
=
UserTeamAssociationService (no changes)
v202008
What's New
- Creatives
-
- Added
isAudio
for specifying audio ads inVastRedirectCreatives
.
- Added
- Forecasts
-
- Added
calculateDailyAdOpportunityCounts
method toAdjustmentService
which takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.
- Added
- LineItems
-
- Replaced singular
viewabilityProviderCompanyId
withviewabilityProviderCompanyIds
for specifying a list of IDs. - Removed deprecated
userConsentEligibility
fromLineItem
.
- Replaced singular
- Multiple Customer Management
-
- Added
SiteService
for MCM publishers to manage the websites of child networks.
- Added
- Video
-
- Added
DaiEncodingProfileService
for managing publisher's encoding profiles, which can be added toLiveStreamEvent.daiEncodingProfileIds
. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video. - Added
adBreakMarkups
to set the ad break type onLiveStreamEvents
for DAI. - Added new
CreativeTranscode.IdTypes
inStreamActivityMonitorService
. - Added
NielsenCtvPacingType
for specifying the pacing computation method for impressions on connected devices for a Nielsen measuredLineItem
. - Added
performCmsMetadataKeyAction
method toCmsMetadataService
for updatingCmsMetadataKey
statuses. (Not to be confused with theperformCmsMetadataValueAction
method added in v202005.) - Removed deprecated
isSetTopBoxEnabled
andsetTopBoxDisplayInfo
fromLineItem
.
- Added
API Changes
-
+
DaiEncodingProfileService -
+
SiteService -
=
ActivityGroupService (no changes) -
=
ActivityService (no changes) -
≠
AdExclusionRuleService (0 new, 1 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
=
AdRuleService (no changes) -
≠
AdjustmentService (1 new, 7 changed, 0 removed)-
+
operation calculateDailyAdOpportunityCounts -
≠
type AdUnitSize-
+
field isAudio
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastAdjustmentError.Reason -
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
≠
type TimeSeries-
−
field timeSeriesValues -
−
field valuePeriodType
-
-
≠
enum VolumeTimeSeriesRequestError.Reason -
≠
operation calculateDailyAdOpportunityCounts-
+
parameter forecastAdjustment -
+
response rval
-
-
-
≠
AudienceSegmentService (0 new, 2 changed, 0 removed)-
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
=
CdnConfigurationService (no changes) -
≠
CmsMetadataService (3 new, 1 changed, 0 removed)-
+
type ActivateCmsMetadataKeys -
+
type DeactivateCmsMetadataKeys -
+
operation performCmsMetadataKeyAction -
≠
operation performCmsMetadataKeyAction-
+
parameter filterStatement -
+
parameter keyAction -
+
response rval
-
-
-
=
CompanyService (no changes) -
=
ContactService (no changes) -
=
ContentBundleService (no changes) -
≠
ContentService (0 new, 1 changed, 0 removed)-
≠
enum VodIngestError
-
-
=
CreativeReviewService (no changes) -
≠
CreativeService (0 new, 3 changed, 0 removed)-
≠
type Creative-
−
field policyViolations
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
type VastRedirectCreative-
+
field isAudio
-
-
-
≠
CreativeSetService (0 new, 1 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
=
CreativeTemplateService (no changes) -
=
CreativeWrapperService (no changes) -
≠
CustomFieldService (0 new, 1 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
≠
CustomTargetingService (0 new, 1 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
=
DaiAuthenticationKeyService (no changes) -
≠
ForecastService (1 new, 7 changed, 1 removed)-
+
type MobileApplicationTargetingError -
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum CreativeSizeType-
+
value AUDIO
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
≠
type GrpSettings-
+
field nielsenCtvPacingType -
−
field enableNielsenCoViewingSupport
-
-
≠
enum LineItemError.Reason -
≠
type LineItemSummary-
+
field viewabilityProviderCompanyIds -
−
field isSetTopBoxEnabled -
−
field setTopBoxDisplayInfo -
−
field userConsentEligibility -
−
field viewabilityProviderCompanyId
-
-
−
type SetTopBoxInfo
-
-
≠
InventoryService (0 new, 2 changed, 0 removed)-
≠
type AdUnitSize-
+
field isAudio
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
=
LabelService (no changes) -
≠
LineItemCreativeAssociationService (0 new, 2 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum LineItemError.Reason
-
-
≠
LineItemService (1 new, 8 changed, 2 removed)-
+
type MobileApplicationTargetingError -
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum CreativeSizeType-
+
value AUDIO
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
≠
type GrpSettings-
+
field nielsenCtvPacingType -
−
field enableNielsenCoViewingSupport
-
-
≠
enum LineItemError.Reason -
≠
type LineItemSummary-
+
field viewabilityProviderCompanyIds -
−
field isSetTopBoxEnabled -
−
field setTopBoxDisplayInfo -
−
field userConsentEligibility -
−
field viewabilityProviderCompanyId
-
-
≠
operation hasCustomPacingCurve-
−
parameter lineItemId -
−
response rval
-
-
−
type SetTopBoxInfo -
−
operation hasCustomPacingCurve
-
-
≠
LineItemTemplateService (1 new, 4 changed, 0 removed)-
+
type MobileApplicationTargetingError -
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
≠
enum LineItemError.Reason
-
-
≠
LiveStreamEventService (1 new, 2 changed, 0 removed)-
+
type LiveStreamEventCustomAssetKeyError -
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
type LiveStreamEvent-
+
field adBreakMarkupTypesEnabled -
+
field adBreakMarkups -
+
field customAssetKey -
+
field daiEncodingProfileIds -
+
field segmentUrlAuthenticationKeyIds
-
-
-
≠
MobileApplicationService (0 new, 2 changed, 0 removed) -
≠
NativeStyleService (2 new, 1 changed, 0 removed)-
+
type ActivateNativeStyles -
+
type DeactivateNativeStyles -
≠
enum NativeStyleStatus-
+
value INACTIVE
-
-
-
≠
NetworkService (1 new, 0 changed, 0 removed)-
+
type UrlError
-
-
≠
OrderService (1 new, 4 changed, 0 removed)-
+
type MobileApplicationTargetingError -
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
≠
enum LineItemError.Reason
-
-
≠
PlacementService (0 new, 1 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
-
≠
ProposalLineItemService (1 new, 5 changed, 0 removed)-
+
type MobileApplicationTargetingError -
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum CreativeSizeType-
+
value AUDIO
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
≠
enum LineItemError.Reason
-
-
≠
ProposalService (0 new, 4 changed, 0 removed)-
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
≠
enum CreativeSizeType-
+
value AUDIO
-
-
≠
enum EntityLimitReachedError.Reason-
+
value DAI_ENCODING_PROFILES_LIMIT_REACHED -
+
value ACTIVE_EXPERIMENTS_LIMIT_REACHED -
+
value SITES_LIMIT_REACHED
-
-
≠
enum ForecastError.Reason-
+
value OUTSIDE_AVAILABLE_DATE_RANGE
-
-
-
≠
PublisherQueryLanguageService (0 new, 1 changed, 0 removed)-
≠
enum AudienceSegmentError.Reason-
+
value SEGMENT_VIOLATED_POLICY
-
-
-
≠
ReportService (0 new, 1 changed, 0 removed)-
≠
enum Column-
−
value GRP_POPULATION -
−
value GRP_UNIQUE_AUDIENCE -
−
value GRP_UNIQUE_AUDIENCE_SHARE -
−
value GRP_AUDIENCE_IMPRESSIONS -
−
value GRP_AUDIENCE_IMPRESSIONS_SHARE -
−
value GRP_AUDIENCE_REACH -
−
value GRP_AUDIENCE_AVERAGE_FREQUENCY -
−
value GRP_GROSS_RATING_POINTS
-
-
-
≠
StreamActivityMonitorService (0 new, 2 changed, 0 removed)-
≠
enum CreativeTranscode.IdType-
+
value MEDIA_URI_PATH -
+
value CREATIVE_ADID_WITH_FALLBACK -
+
value CANONICALIZED_MEDIA_URI -
+
value GV_REGISTRY_ID -
+
value UNKNOWN_ID_TYPE -
+
value MEDIA_URI_HASH
-
-
≠
enum SamErrorType-
+
value AD_POD_DROPPED_UNSUPPORTED_TYPE
-
-
-
≠
SuggestedAdUnitService (0 new, 1 changed, 0 removed)-
≠
type AdUnitSize-
+
field isAudio
-
-
-
≠
TargetingPresetService (1 new, 0 changed, 0 removed) -
≠
TargetingService (1 new, 0 changed, 0 removed) -
=
TeamService (no changes) -
=
UserService (no changes) -
=
UserTeamAssociationService (no changes)
v202005
What's New
- General
-
- ActivityGroup's
id
field has been changed from anint
to along
. The identifiers of existing ActivityGroups have not been changed. - Activity's
id
field has been changed from anint
to along
. The identifiers of existing Activities have not been changed. - Added support for Multiple Customer Management to Companies.
- ActivityGroup's
- Programmatic
- Reporting
-
- Added support for Nielsen Digital Ad Ratings dimensions.
- Added support for Ad Spot dimensions.
- Video
-
- Added a
status
field for CMS metadata keys and values, with corresponding actions for activating and deactivating values. - Added
duration
toContent
. - Added
competitiveConstraintScope
setting to line items. - Added
thirdPartyMeasurementSettings
to line items. - Removed deprecated
description
field fromLiveStreamEvents
. - Added support for prefetch settings to
LiveStreamEvents
.
- Added a
API Changes
-
≠
ActivityGroupService (2 new, 2 changed, 0 removed)-
+
type RequiredNumberError -
+
enum RequiredNumberError.Reason -
≠
type ActivityGroup-
+
field idAsLong -
−
field id
-
-
≠
type RequiredNumberError-
+
field reason
-
-
-
≠
ActivityService (0 new, 1 changed, 0 removed)-
≠
type Activity-
+
field activityGroupIdAsLong -
+
field idAsLong -
−
field activityGroupId -
−
field id
-
-
-
≠
AdExclusionRuleService (0 new, 2 changed, 0 removed)-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason
-
-
≠
AdRuleService (0 new, 1 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
-
≠
AdjustmentService (23 new, 18 changed, 2 removed)-
+
type ActivateForecastAdjustments -
+
type DailyVolumeSettings -
+
type DeactivateForecastAdjustments -
+
type ForecastAdjustment -
+
type ForecastAdjustmentError -
+
enum ForecastAdjustmentError.Reason -
+
enum ForecastAdjustmentStatus -
+
enum ForecastAdjustmentVolumeType -
+
type ForecastError -
+
enum ForecastError.Reason -
+
type HistoricalBasisVolumeSettings -
+
type TotalVolumeSettings -
+
type TrafficForecastSegment -
+
type TrafficForecastSegmentError -
+
type VolumeTimeSeriesRequestError -
+
enum VolumeTimeSeriesRequestError.Reason -
+
operation createForecastAdjustments -
+
operation createTrafficForecastSegments -
+
operation getForecastAdjustmentsByStatement -
+
operation getTrafficForecastSegmentsByStatement -
+
operation performForecastAdjustmentAction -
+
operation updateForecastAdjustments -
+
operation updateTrafficForecastSegments -
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityLimitReachedError.Reason -
≠
type ForecastAdjustment-
+
field dailyVolumeSettings -
+
field historicalBasisVolumeSettings -
+
field status -
+
field totalVolumeSettings -
+
field volumeType
-
-
≠
type ForecastAdjustmentError-
+
field reason
-
-
≠
type ForecastAdjustmentPage-
+
field results
-
-
≠
type ForecastError-
+
field reason
-
-
≠
type TimeSeries-
+
field values
-
-
≠
type TrafficForecastSegmentPage-
+
field results
-
-
≠
type VolumeTimeSeriesRequestError-
+
field reason
-
-
≠
operation createForecastAdjustments-
+
parameter forecastAdjustments -
+
response rval
-
-
≠
operation createTrafficForecastSegments-
+
response rval -
+
parameter trafficForecastSegments
-
-
≠
operation getForecastAdjustmentsByStatement-
+
parameter filterStatement -
+
response rval
-
-
≠
operation getTrafficAdjustmentsByStatement-
−
parameter filterStatement -
−
response rval
-
-
≠
operation getTrafficForecastSegmentsByStatement-
+
parameter filterStatement -
+
response rval
-
-
≠
operation performForecastAdjustmentAction-
+
parameter filterStatement -
+
parameter forecastAdjustmentAction -
+
response rval
-
-
≠
operation updateForecastAdjustments-
+
parameter forecastAdjustments -
+
response rval
-
-
≠
operation updateTrafficAdjustments-
−
parameter adjustments -
−
response rval
-
-
≠
operation updateTrafficForecastSegments-
+
response rval -
+
parameter trafficForecastSegments
-
-
−
operation getTrafficAdjustmentsByStatement -
−
operation updateTrafficAdjustments
-
-
≠
AudienceSegmentService (0 new, 3 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason
-
-
=
CdnConfigurationService (no changes) -
≠
CmsMetadataService (3 new, 3 changed, 0 removed)-
+
type ActivateCmsMetadataValues -
+
type DeactivateCmsMetadataValues -
+
operation performCmsMetadataValueAction -
≠
type CmsMetadataKey-
+
field status
-
-
≠
type CmsMetadataValue-
+
field status
-
-
≠
operation performCmsMetadataValueAction-
+
parameter filterStatement -
+
response rval -
+
parameter valueAction
-
-
-
≠
CompanyService (3 new, 5 changed, 0 removed)-
+
type CompanyAction -
+
type EndAgreementAction -
+
operation performCompanyAction -
≠
type ChildPublisher-
+
field accountStatus
-
-
≠
type Company-
+
field childPublisher
-
-
≠
enum DelegationStatus-
+
value WITHDRAWN
-
-
≠
enum NetworkError.Reason -
≠
operation performCompanyAction-
+
parameter companyAction -
+
response rval -
+
parameter statement
-
-
-
=
ContactService (no changes) -
=
ContentBundleService (no changes) -
≠
ContentService (0 new, 2 changed, 0 removed)-
≠
type Content-
+
field duration
-
-
≠
enum VodIngestError
-
-
=
CreativeReviewService (no changes) -
≠
CreativeService (1 new, 3 changed, 0 removed)-
+
type ThirdPartyDataDeclaration -
≠
type Creative-
+
field thirdPartyDataDeclaration
-
-
≠
enum EntityLimitReachedError.Reason -
≠
enum HtmlBundleProcessorError.Reason-
+
value CANNOT_DECODE_BUNDLE
-
-
-
≠
CreativeSetService (0 new, 2 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason -
≠
enum HtmlBundleProcessorError.Reason-
+
value CANNOT_DECODE_BUNDLE
-
-
-
=
CreativeTemplateService (no changes) -
≠
CreativeWrapperService (1 new, 1 changed, 0 removed)-
+
type ThirdPartyDataDeclaration -
≠
type CreativeWrapper-
+
field thirdPartyDataDeclaration
-
-
-
≠
CustomFieldService (0 new, 1 changed, 0 removed)-
≠
enum EntityLimitReachedError.Reason
-
-
≠
CustomTargetingService (0 new, 3 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason
-
-
=
DaiAuthenticationKeyService (no changes) -
≠
ForecastService (3 new, 6 changed, 0 removed)-
+
enum CompetitiveConstraintScope -
+
type ProposalLineItemMakegoodInfo -
+
type ThirdPartyMeasurementSettings -
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
enum LineItemError.Reason -
≠
type LineItemSummary-
+
field competitiveConstraintScope -
+
field thirdPartyMeasurementSettings
-
-
≠
type ProposalLineItem-
+
field canCreateMakegood -
+
field hasMakegood -
+
field makegoodInfo -
+
field thirdPartyMeasurementSettings
-
-
-
≠
InventoryService (0 new, 2 changed, 0 removed)-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason
-
-
=
LabelService (no changes) -
≠
LineItemCreativeAssociationService (0 new, 4 changed, 0 removed)-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
enum HtmlBundleProcessorError.Reason-
+
value CANNOT_DECODE_BUNDLE
-
-
≠
enum LineItemError.Reason
-
-
≠
LineItemService (2 new, 5 changed, 0 removed)-
+
enum CompetitiveConstraintScope -
+
type ThirdPartyMeasurementSettings -
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
enum LineItemError.Reason -
≠
type LineItemSummary-
+
field competitiveConstraintScope -
+
field thirdPartyMeasurementSettings
-
-
-
≠
LineItemTemplateService (0 new, 4 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
enum LineItemError.Reason
-
-
≠
LiveStreamEventService (1 new, 3 changed, 1 removed)-
+
type PrefetchSettings -
≠
enum EntityLimitReachedError.Reason -
≠
type LiveStreamEvent-
+
field enableForceCloseAdBreaks -
+
field enableMaxFillerDuration -
+
field enableRelativePlaylistDelivery -
+
field enableShortSegmentDropping -
+
field enableWhitelistedIps -
+
field maxFillerDuration -
+
field prefetchEnabled -
+
field prefetchSettings -
+
field underfillAdBreakFillType -
−
field description
-
-
≠
operation registerSessionsForMonitoring-
−
response rval -
−
parameter sessionIds
-
-
−
operation registerSessionsForMonitoring
-
-
=
MobileApplicationService (no changes) -
≠
NativeStyleService (0 new, 2 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason
-
-
≠
NetworkService (0 new, 3 changed, 0 removed)-
≠
type ChildPublisher-
+
field accountStatus
-
-
≠
enum DelegationStatus-
+
value WITHDRAWN
-
-
≠
enum NetworkError.Reason
-
-
≠
OrderService (0 new, 4 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
enum LineItemError.Reason
-
-
≠
PlacementService (0 new, 2 changed, 0 removed)-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason
-
-
≠
ProposalLineItemService (4 new, 6 changed, 0 removed)-
+
type ProposalLineItemMakegoodError -
+
type ProposalLineItemMakegoodInfo -
+
type ThirdPartyMeasurementSettings -
+
operation createMakegoods -
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
enum LineItemError.Reason -
≠
type ProposalLineItem-
+
field canCreateMakegood -
+
field hasMakegood -
+
field makegoodInfo -
+
field thirdPartyMeasurementSettings
-
-
≠
operation createMakegoods-
+
parameter makegoodInfos -
+
response rval
-
-
-
≠
ProposalService (0 new, 3 changed, 0 removed)-
≠
enum EntityChildrenLimitReachedError.Reason -
≠
enum EntityLimitReachedError.Reason -
≠
type ProposalMarketplaceInfo-
+
field partnerClientId
-
-
-
=
PublisherQueryLanguageService (no changes) -
≠
ReportService (0 new, 1 changed, 0 removed)-
≠
enum Dimension-
+
value CUSTOM_SPOT_ID -
+
value CUSTOM_SPOT_NAME -
+
value NIELSEN_DEVICE_ID -
+
value NIELSEN_DEVICE_NAME
-
-
-
≠
StreamActivityMonitorService (0 new, 2 changed, 0 removed)-
≠
type AdBreak-
+
field rootAdResponses -
−
field rootAdResponse
-
-
≠
enum SamErrorType-
+
value AD_REQUEST_TIMEOUT
-
-
-
=
SuggestedAdUnitService (no changes) -
≠
TargetingPresetService (0 new, 2 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason
-
-
≠
TargetingService (0 new, 2 changed, 0 removed)-
≠
enum CustomTargetingError.Reason-
+
value CANNOT_TARGET_MAPPED_METADATA
-
-
≠
enum EntityChildrenLimitReachedError.Reason
-
-
=
TeamService (no changes) -
=
UserService (no changes) -
=
UserTeamAssociationService (no changes)
v202002
What's New
- LineItems
-
- Added
customPacingCurve
toLineItem
objects for finer control of their delivery rate.
- Added
- Reporting
-
- Added several new Ad Exchange video metrics, such as
AD_EXCHANGE_VIDEO_AUTO_PLAY
AD_EXCHANGE_VIDEO_CLICK_TO_PLAY
AD_EXCHANGE_VIDEO_COMPLETION_RATE
AD_EXCHANGE_VIDEO_
" in theColumn
documentation page.
- Added several new Ad Exchange video metrics, such as
- Video
-
- Added the
StreamActivityMonitorService
which returns the logging information for a Dynamic Ad Insertion sessions. - Added
contentBundleIds
,cmsMetadataValueIds
, andlastModifiedDateTime
to video metadataContent
objects. - Added
adId
andadIdType
fields to video creatives in order to associate a video ad with an ad registry, such as Ad-ID or Clearcast. - Added
VideoAdTagError
to surface errors associated with live stream event ad tags. - Removed deprecated fields
userDefinedCustomTargetingValueIds
andmappingRuleDefinedCustomTargetingValueIds
from video metadataContent
objects.
- Added the
API Changes
-
+
CreativeReviewService -
+
StreamActivityMonitorService -
=
ActivityGroupService (no changes) -
=
ActivityService (no changes) -
=
AdExclusionRuleService (no changes) -
≠
AdRuleService (10 new, 11 changed, 0 removed)-
+
type AdRuleError -
+
enum AdSpotFillType -
+
enum AdSpotTargetingType -
+
type BreakTemplate -
+
type BreakTemplate.BreakTemplateMember -
+
operation createAdSpots -
+
operation createBreakTemplates -
+
operation getBreakTemplatesByStatement -
+
operation updateAdSpots -
+
operation updateBreakTemplates -
≠
enum AdRuleTargetingError.Reason -
≠
type AdSpot-
+
field allowedLineItemTypes -
+
field backfillBlocked -
+
field flexible -
+
field inventorySharingBlocked -
+
field maxDurationMillis -
+
field maxNumberOfAds -
+
field targetingType
-
-
≠
type BaseAdRuleSlot-
+
field breakTemplateId -
−
field minPodDuration -
−
field minVideoAdDuration
-
-
≠
type BreakTemplate-
+
field breakTemplateMembers -
+
field customTemplate -
+
field displayName -
+
field id
-
-
≠
type BreakTemplate.BreakTemplateMember-
+
field adSpotFillType -
+
field adSpotId
-
-
≠
type BreakTemplatePage-
+
field results
-
-
≠
operation createAdSpots -
≠
operation createBreakTemplates-
+
parameter breakTemplate -
+
response rval
-
-
≠
operation getBreakTemplatesByStatement-
+
parameter filterStatement -
+
response rval
-
-
≠
operation updateAdSpots -
≠
operation updateBreakTemplates-
+
parameter breakTemplate -
+
response rval
-
-
-
=
AdjustmentService (no changes) -
=
AudienceSegmentService (no changes) -
=
CdnConfigurationService (no changes) -
=
CmsMetadataService (no changes) -
≠
CompanyService (1 new, 2 changed, 0 removed)-
+
type ChildPublisher -
≠
enum Company.Type-
+
value CHILD_PUBLISHER
-
-
≠
enum NetworkError.Reason-
+
value DELEGATION_CHILD_NETWORK_CANNOT_BECOME_A_PARENT -
+
value DELEGATION_PARENT_NETWORK_CANNOT_BECOME_A_CHILD -
+
value CANNOT_ADD_SAME_NETWORK_AS_DELEGATION_CHILD -
+
value MAX_APPROVED_DELEGATION_CHILD_NETWORKS_EXCEEDED -
+
value CHILD_NETWORK_ALREADY_EXISTS -
+
value IN_PARENT_DELEGATION_UNSUPPORTED_FOR_NETWORK
-
-
-
=
ContactService (no changes) -
≠
ContentBundleService (0 new, 1 changed, 0 removed)-
≠
type ContentBundle-
+
field lastModifiedDateTime
-
-
-
≠
ContentService (0 new, 2 changed, 1 removed)-
≠
type Content-
+
field cmsMetadataValueIds -
+
field contentBundleIds -
−
field mappingRuleDefinedCustomTargetingValueIds -
−
field userDefinedCustomTargetingValueIds
-
-
≠
operation getContentByStatementAndCustomTargetingValue-
−
parameter customTargetingValueId -
−
parameter filterStatement -
−
response rval
-
-
−
operation getContentByStatementAndCustomTargetingValue
-
-
≠
CreativeService (1 new, 4 changed, 0 removed)-
+
enum AdIdType -
≠
type BaseVideoCreative -
≠
enum CreativePolicyViolation-
+
value TRICK_TO_CLICK -
+
value USE_OF_NON_WHITELISTED_OMID_VERIFICATION_SCRIPT -
+
value MISUSE_OF_OMID_API -
+
value UNACCEPTABLE_HTML_AD
-
-
≠
enum CreativeSetError.Reason-
+
value SKIPPABLE_AD_TYPE_NOT_ALLOWED
-
-
≠
enum SkippableAdType-
+
value ANY
-
-
-
≠
CreativeSetService (0 new, 1 changed, 0 removed)-
≠
enum CreativeSetError.Reason-
+
value SKIPPABLE_AD_TYPE_NOT_ALLOWED
-
-
-
=
CreativeTemplateService (no changes) -
=
CreativeWrapperService (no changes) -
=
CustomFieldService (no chan