Release Notes

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.

• Latest version: v202102
• Previous versions: v202011, v202008, v202005, v202002

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

1. ≠ ActivityGroupService (0 new, 2 changed, 0 removed)
   1. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   2. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
2. ≠ ActivityService (0 new, 2 changed, 0 removed)
   1. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   2. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
3. ≠ AdExclusionRuleService (0 new, 2 changed, 0 removed)
   1. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   2. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
4. ≠ AdRuleService (2 new, 3 changed, 0 removed)
   1. + type GeoTargetingError
   2. + enum GeoTargetingError.Reason
   3. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   4. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
   5. ≠ type GeoTargetingError
      1. + field reason
5. ≠ AdjustmentService (0 new, 3 changed, 0 removed)
   1. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   2. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
   3. ≠ enum ForecastAdjustmentError.Reason
      1. + value AD_REQUEST_SOURCE_PLATFORMS_MUST_MATCH_SEGMENT_PLATFORMS
6. ≠ AudienceSegmentService (2 new, 3 changed, 0 removed)
   1. + type CustomTargetingError
   2. + enum CustomTargetingError.Reason
   3. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   4. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
   5. ≠ type CustomTargetingError
      1. + field reason
7. ≠ CdnConfigurationService (0 new, 2 changed, 0 removed)
   1. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   2. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
8. ≠ CmsMetadataService (0 new, 2 changed, 0 removed)
   1. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   2. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
9. ≠ CompanyService (1 new, 3 changed, 0 removed)
   1. + type ReInviteAction
   2. ≠ enum AuthenticationError.Reason
      1. − value NOT_WHITELISTED_FOR_API_ACCESS
   3. ≠ type ChildPublisher
      1. + field proposedRevenueShareMillipercent
   4. ≠ enum CommonError.Reason
      1. + value UNSUPPORTED_OPERATION
10. ≠ ContactService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
11. ≠ ContentBundleService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
12. ≠ ContentService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
13. ≠ CreativeReviewService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
14. ≠ CreativeTemplateService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
15. ≠ CreativeWrapperService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
16. ≠ CustomFieldService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
17. ≠ CustomTargetingService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
18. ≠ DaiAuthenticationKeyService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
19. ≠ DaiEncodingProfileService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
20. ≠ ForecastService (0 new, 7 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum CreativeSizeType
       1. + value IGNORED
    4. ≠ enum LineItemCreativeAssociationError.Reason
       1. + value CANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE
    5. ≠ enum LineItemError.Reason
       1. + value INVALID_MAX_VIDEO_CREATIVE_DURATION
    6. ≠ type LineItemSummary
       1. − field adExchangeAuctionOpeningPriority
       2. − field isPrioritizedPreferredDealsEnabled
    7. ≠ type ThirdPartyMeasurementSettings
       1. + field brandLiftClientId
       2. + field brandLiftPartner
       3. + field brandLiftReportingId
       4. + field publisherViewabilityClientId
       5. + field publisherViewabilityPartner
       6. + field publisherViewabilityReportingId
21. ≠ InventoryService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
22. ≠ LabelService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
23. ≠ LineItemService (0 new, 7 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum CreativeSizeType
       1. + value IGNORED
    4. ≠ enum LineItemCreativeAssociationError.Reason
       1. + value CANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE
    5. ≠ enum LineItemError.Reason
       1. + value INVALID_MAX_VIDEO_CREATIVE_DURATION
    6. ≠ type LineItemSummary
       1. − field adExchangeAuctionOpeningPriority
       2. − field isPrioritizedPreferredDealsEnabled
    7. ≠ type ThirdPartyMeasurementSettings
       1. + field brandLiftClientId
       2. + field brandLiftPartner
       3. + field brandLiftReportingId
       4. + field publisherViewabilityClientId
       5. + field publisherViewabilityPartner
       6. + field publisherViewabilityReportingId
24. ≠ LineItemTemplateService (0 new, 4 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum LineItemCreativeAssociationError.Reason
       1. + value CANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE
    4. ≠ enum LineItemError.Reason
       1. + value INVALID_MAX_VIDEO_CREATIVE_DURATION
25. ≠ LiveStreamEventService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
26. ≠ MobileApplicationService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
27. ≠ NativeStyleService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
28. ≠ NetworkService (0 new, 3 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ type ChildPublisher
       1. + field proposedRevenueShareMillipercent
    3. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
29. ≠ OrderService (0 new, 4 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum LineItemCreativeAssociationError.Reason
       1. + value CANNOT_ACTIVATE_ASSOCIATION_WITH_INACTIVE_CREATIVE
    4. ≠ enum LineItemError.Reason
       1. + value INVALID_MAX_VIDEO_CREATIVE_DURATION
30. ≠ PlacementService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
31. ≠ ProposalLineItemService (0 new, 5 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum CreativeSizeType
       1. + value IGNORED
    4. ≠ enum LineItemError.Reason
       1. + value INVALID_MAX_VIDEO_CREATIVE_DURATION
    5. ≠ type ThirdPartyMeasurementSettings
       1. + field brandLiftClientId
       2. + field brandLiftPartner
       3. + field brandLiftReportingId
       4. + field publisherViewabilityClientId
       5. + field publisherViewabilityPartner
       6. + field publisherViewabilityReportingId
32. ≠ ProposalService (0 new, 3 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum CreativeSizeType
       1. + value IGNORED
33. ≠ PublisherQueryLanguageService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
34. ≠ ReportService (0 new, 3 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    3. ≠ enum Dimension
       1. + value BROWSER_NAME
       2. + value VIDEO_PLACEMENT_NAME
       3. + value AD_EXCHANGE_DFP_MOBILE_APP_NAME
       4. + value AD_EXCHANGE_MOBILE_APP_RESOLVED_ID
       5. + value EXCHANGE_THIRD_PARTY_COMPANY_NAME
       6. + value DOMAIN
       7. − value AD_EXCHANGE_MOBILE_APP_NAME
35. ≠ SiteService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
36. ≠ StreamActivityMonitorService (1 new, 4 changed, 0 removed)
    1. + enum ReportingType
    2. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    3. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
    4. ≠ type LinearStreamCreateRequest
       1. + field prefetchEnabled
    5. ≠ type StreamCreateRequest
       1. + field reportingType
37. ≠ SuggestedAdUnitService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
38. ≠ TargetingPresetService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
39. ≠ TargetingService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
40. ≠ TeamService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
41. ≠ UserService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION
42. ≠ UserTeamAssociationService (0 new, 2 changed, 0 removed)
    1. ≠ enum AuthenticationError.Reason
       1. − value NOT_WHITELISTED_FOR_API_ACCESS
    2. ≠ enum CommonError.Reason
       1. + value UNSUPPORTED_OPERATION

v202011

What's New

Administrative

• Added getDefaultThirdPartyDataDeclaration method to NetworkService to fetch the ad technology providers declared on your Network.

Forecasts

• Added getTrafficData method to ForecastService which returns forecasted and historical traffic data for segments of traffic.
• Added FORECASTED_CREATIVE_RESTRICTION to TargetingCriteriaBreakdown.targetingDimension in order to see the impact of creative restrictions

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 and UNIFIED_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 the Dimension documentation to see which existing dimensions are compatible.

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 video LineItem.
• Added GrpSettings.pacingDeviceCategorizationType for specifying whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.

Error Handling

• Added BUYER_NOT_FOUND to ProposalService and ProposalLineItemService to be thrown if a given buyer is deactivated or otherwise not found.
• Added KEY_STATUS_NOT_ACTIVE and VALUE_STATUS_NOT_ACTIVE to be thrown if custom targeting has any non-active keys or values in it.

API Changes

1. = ActivityGroupService (no changes)
2. = ActivityService (no changes)
3. = AdExclusionRuleService (no changes)
4. ≠ AdRuleService (0 new, 1 changed, 0 removed)
   1. ≠ enum CustomTargetingError.Reason
      1. + value KEY_STATUS_NOT_ACTIVE
      2. + value VALUE_STATUS_NOT_ACTIVE
      3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
5. ≠ AdjustmentService (0 new, 1 changed, 1 removed)
   1. ≠ enum CustomTargetingError.Reason
      1. + value KEY_STATUS_NOT_ACTIVE
      2. + value VALUE_STATUS_NOT_ACTIVE
      3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
   2. − type VolumeTimeSeriesRequestError
6. ≠ AudienceSegmentService (0 new, 1 changed, 0 removed)
   1. ≠ enum CustomTargetingError.Reason
      1. + value KEY_STATUS_NOT_ACTIVE
      2. + value VALUE_STATUS_NOT_ACTIVE
      3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
7. = CdnConfigurationService (no changes)
8. = CmsMetadataService (no changes)
9. = CompanyService (no changes)
10. = ContactService (no changes)
11. = ContentBundleService (no changes)
12. = ContentService (no changes)
13. = CreativeReviewService (no changes)
14. = CreativeService (no changes)
15. = CreativeSetService (no changes)
16. = CreativeTemplateService (no changes)
17. = CreativeWrapperService (no changes)
18. = CustomFieldService (no changes)
19. ≠ CustomTargetingService (1 new, 2 changed, 0 removed)
    1. + enum ValueDeclarationType
    2. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    3. ≠ type CustomTargetingKey
       1. + field valueDeclarationType
20. = DaiAuthenticationKeyService (no changes)
21. = DaiEncodingProfileService (no changes)
22. ≠ ForecastService (1 new, 5 changed, 0 removed)
    1. + operation getTrafficData
    2. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    3. ≠ type GrpSettings
       1. + field applyTrueCoview
       2. + field pacingDeviceCategorizationType
    4. ≠ enum LineItemError.Reason
       1. + value CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED
    5. ≠ enum TargetingDimension
       1. + value FORECASTED_CREATIVE_RESTRICTION
    6. ≠ operation getTrafficData
       1. + response rval
       2. + parameter trafficDataRequest
23. = InventoryService (no changes)
24. = LabelService (no changes)
25. ≠ LineItemCreativeAssociationService (0 new, 1 changed, 0 removed)
    1. ≠ enum LineItemError.Reason
       1. + value CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED
26. ≠ LineItemService (0 new, 3 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    2. ≠ type GrpSettings
       1. + field applyTrueCoview
       2. + field pacingDeviceCategorizationType
    3. ≠ enum LineItemError.Reason
       1. + value CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED
27. ≠ LineItemTemplateService (0 new, 2 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    2. ≠ enum LineItemError.Reason
       1. + value CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED
28. ≠ LiveStreamEventService (2 new, 1 changed, 0 removed)
    1. + type AdBreakMarkupError
    2. + enum AdServingFormat
    3. ≠ type LiveStreamEvent
       1. + field adServingFormat
29. = MobileApplicationService (no changes)
30. ≠ NativeStyleService (0 new, 2 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    2. ≠ enum NativeStyleError.Reason
       1. + value INVALID_STATUS
31. ≠ NetworkService (1 new, 1 changed, 0 removed)
    1. + operation getDefaultThirdPartyDataDeclaration
    2. ≠ operation getDefaultThirdPartyDataDeclaration
       1. + response rval
32. ≠ OrderService (0 new, 2 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    2. ≠ enum LineItemError.Reason
       1. + value CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED
33. = PlacementService (no changes)
34. ≠ ProposalLineItemService (0 new, 3 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
    2. ≠ enum LineItemError.Reason
       1. + value CMS_METADATA_LINE_ITEM_ENVIRONMENT_TYPE_NOT_SUPPORTED
    3. ≠ enum ProposalLineItemProgrammaticError.Reason
       1. + value BUYER_NOT_FOUND
35. ≠ ProposalService (0 new, 1 changed, 0 removed)
    1. ≠ enum ProposalLineItemProgrammaticError.Reason
       1. + value BUYER_NOT_FOUND
36. = PublisherQueryLanguageService (no changes)
37. ≠ ReportService (0 new, 3 changed, 0 removed)
    1. ≠ enum Column
       1. + value CREATIVE_LOAD_TIME_0_500_MS_PERCENT
       2. + value CREATIVE_LOAD_TIME_500_1000_MS_PERCENT
       3. + value CREATIVE_LOAD_TIME_1_2_S_PERCENT
       4. + value CREATIVE_LOAD_TIME_2_4_S_PERCENT
       5. + value CREATIVE_LOAD_TIME_4_8_S_PERCENT
       6. + value CREATIVE_LOAD_TIME_GREATER_THAN_8_S_PERCENT
       7. + value UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT
       8. + value UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT
       9. + value UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT
       10. + value UNVIEWED_REASON_USER_SCROLLED_BEFORE_1_S_PERCENT
       11. + value UNVIEWED_REASON_OTHER_PERCENT
       12. + value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_0_500_MS_PERCENT
       13. + value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_500_1000_MS_PERCENT
       14. + value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_1_2_S_PERCENT
       15. + value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_2_4_S_PERCENT
       16. + value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_4_8_S_PERCENT
       17. + value PAGE_NAVIGATION_TO_TAG_LOADED_TIME_GREATER_THAN_8_S_PERCENT
       18. + value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT
       19. + value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT
       20. + value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT
       21. + value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT
       22. + value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT
       23. + value PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT
       24. + value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT
       25. + value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT
       26. + value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT
       27. + value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT
       28. + value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT
       29. + value TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT
       30. − value DYNAMIC_ALLOCATION_INVENTORY_LEVEL_WITH_CPD_PERCENT_REVENUE
    2. ≠ enum Dimension
       1. + value MOBILE_APP_RESOLVED_ID
       2. + value UNIFIED_PRICING_RULE_ID
       3. + value UNIFIED_PRICING_RULE_NAME
    3. ≠ enum DimensionAttribute
       1. + value LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS
38. ≠ SiteService (1 new, 1 changed, 0 removed)
    1. + operation updateSites
    2. ≠ operation updateSites
       1. + response rval
       2. + parameter sites
39. = StreamActivityMonitorService (no changes)
40. = SuggestedAdUnitService (no changes)
41. ≠ TargetingPresetService (0 new, 1 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
42. ≠ TargetingService (0 new, 1 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value KEY_STATUS_NOT_ACTIVE
       2. + value VALUE_STATUS_NOT_ACTIVE
       3. + value CANNOT_TARGET_THIRD_PARTY_AUDIENCE_SEGMENT
43. = TeamService (no changes)
44. = UserService (no changes)
45. = UserTeamAssociationService (no changes)

v202008

What's New

Creatives

• Added isAudio for specifying audio ads in VastRedirectCreatives.

Forecasts

• Added calculateDailyAdOpportunityCounts method to AdjustmentService which takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.

LineItems

• Replaced singular viewabilityProviderCompanyId with viewabilityProviderCompanyIds for specifying a list of IDs.
• Removed deprecated userConsentEligibility from LineItem.

Multiple Customer Management

• Added SiteService for MCM publishers to manage the websites of child networks.

Video

• Added DaiEncodingProfileService for managing publisher's encoding profiles, which can be added to LiveStreamEvent.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 on LiveStreamEvents for DAI.
• Added new CreativeTranscode.IdTypes in StreamActivityMonitorService.
• Added NielsenCtvPacingType for specifying the pacing computation method for impressions on connected devices for a Nielsen measured LineItem.
• Added performCmsMetadataKeyAction method to CmsMetadataService for updating CmsMetadataKey statuses. (Not to be confused with the performCmsMetadataValueAction method added in v202005.)
• Removed deprecated isSetTopBoxEnabled and setTopBoxDisplayInfo from LineItem.

API Changes

1. + DaiEncodingProfileService
2. + SiteService
3. = ActivityGroupService (no changes)
4. = ActivityService (no changes)
5. ≠ AdExclusionRuleService (0 new, 1 changed, 0 removed)
   1. ≠ enum EntityLimitReachedError.Reason
      1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
      2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
      3. + value SITES_LIMIT_REACHED
6. = AdRuleService (no changes)
7. ≠ AdjustmentService (1 new, 7 changed, 0 removed)
   1. + operation calculateDailyAdOpportunityCounts
   2. ≠ type AdUnitSize
      1. + field isAudio
   3. ≠ enum EntityLimitReachedError.Reason
      1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
      2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
      3. + value SITES_LIMIT_REACHED
   4. ≠ enum ForecastAdjustmentError.Reason
      1. + value ADJUSTED_VALUE_ABOVE_RECOMMENDED_RELATIVE_LIMIT
      2. + value END_DATE_AFTER_FURTHEST_AVAILABLE_FORECAST_DATE
      3. + value HISTORICAL_BASIS_DATE_RANGE_TOO_SHORT
      4. + value PARENT_SEGMENT_TARGETING_INCOMPATIBLE_WITH_HISTORICAL_BASIS_AD_REQUEST_SOURCE_SETTINGS
   5. ≠ enum ForecastError.Reason
      1. + value OUTSIDE_AVAILABLE_DATE_RANGE
   6. ≠ type TimeSeries
      1. − field timeSeriesValues
      2. − field valuePeriodType
   7. ≠ enum VolumeTimeSeriesRequestError.Reason
      1. + value HISTORICAL_BASIS_DATE_RANGE_TOO_SHORT
   8. ≠ operation calculateDailyAdOpportunityCounts
      1. + parameter forecastAdjustment
      2. + response rval
8. ≠ AudienceSegmentService (0 new, 2 changed, 0 removed)
   1. ≠ enum AudienceSegmentError.Reason
      1. + value SEGMENT_VIOLATED_POLICY
   2. ≠ enum EntityLimitReachedError.Reason
      1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
      2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
      3. + value SITES_LIMIT_REACHED
9. = CdnConfigurationService (no changes)
10. ≠ CmsMetadataService (3 new, 1 changed, 0 removed)
    1. + type ActivateCmsMetadataKeys
    2. + type DeactivateCmsMetadataKeys
    3. + operation performCmsMetadataKeyAction
    4. ≠ operation performCmsMetadataKeyAction
       1. + parameter filterStatement
       2. + parameter keyAction
       3. + response rval
11. = CompanyService (no changes)
12. = ContactService (no changes)
13. = ContentBundleService (no changes)
14. ≠ ContentService (0 new, 1 changed, 0 removed)
    1. ≠ enum VodIngestError
       1. + value CLOSED_CAPTION_LANGUAGE_VALUE_INVALID
       2. + value CLOSED_CAPTION_NAME_VALUE_INVALID
       3. + value CLOSED_CAPTION_CHARACTERISTICS_VALUE_UNEXPECTED
       4. + value CLOSED_CAPTIONS_WITH_DUPLICATE_KEYS
15. = CreativeReviewService (no changes)
16. ≠ CreativeService (0 new, 3 changed, 0 removed)
    1. ≠ type Creative
       1. − field policyViolations
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    3. ≠ type VastRedirectCreative
       1. + field isAudio
17. ≠ CreativeSetService (0 new, 1 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
18. = CreativeTemplateService (no changes)
19. = CreativeWrapperService (no changes)
20. ≠ CustomFieldService (0 new, 1 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
21. ≠ CustomTargetingService (0 new, 1 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
22. = DaiAuthenticationKeyService (no changes)
23. ≠ ForecastService (1 new, 7 changed, 1 removed)
    1. + type MobileApplicationTargetingError
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
    3. ≠ enum CreativeSizeType
       1. + value AUDIO
    4. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    5. ≠ enum ForecastError.Reason
       1. + value OUTSIDE_AVAILABLE_DATE_RANGE
    6. ≠ type GrpSettings
       1. + field nielsenCtvPacingType
       2. − field enableNielsenCoViewingSupport
    7. ≠ enum LineItemError.Reason
       1. + value INVALID_COST_PER_UNIT_FOR_BACKFILL
    8. ≠ type LineItemSummary
       1. + field viewabilityProviderCompanyIds
       2. − field isSetTopBoxEnabled
       3. − field setTopBoxDisplayInfo
       4. − field userConsentEligibility
       5. − field viewabilityProviderCompanyId
    9. − type SetTopBoxInfo
24. ≠ InventoryService (0 new, 2 changed, 0 removed)
    1. ≠ type AdUnitSize
       1. + field isAudio
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
25. = LabelService (no changes)
26. ≠ LineItemCreativeAssociationService (0 new, 2 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    2. ≠ enum LineItemError.Reason
       1. + value INVALID_COST_PER_UNIT_FOR_BACKFILL
27. ≠ LineItemService (1 new, 8 changed, 2 removed)
    1. + type MobileApplicationTargetingError
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
    3. ≠ enum CreativeSizeType
       1. + value AUDIO
    4. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    5. ≠ enum ForecastError.Reason
       1. + value OUTSIDE_AVAILABLE_DATE_RANGE
    6. ≠ type GrpSettings
       1. + field nielsenCtvPacingType
       2. − field enableNielsenCoViewingSupport
    7. ≠ enum LineItemError.Reason
       1. + value INVALID_COST_PER_UNIT_FOR_BACKFILL
    8. ≠ type LineItemSummary
       1. + field viewabilityProviderCompanyIds
       2. − field isSetTopBoxEnabled
       3. − field setTopBoxDisplayInfo
       4. − field userConsentEligibility
       5. − field viewabilityProviderCompanyId
    9. ≠ operation hasCustomPacingCurve
       1. − parameter lineItemId
       2. − response rval
    10. − type SetTopBoxInfo
    11. − operation hasCustomPacingCurve
28. ≠ LineItemTemplateService (1 new, 4 changed, 0 removed)
    1. + type MobileApplicationTargetingError
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    4. ≠ enum ForecastError.Reason
       1. + value OUTSIDE_AVAILABLE_DATE_RANGE
    5. ≠ enum LineItemError.Reason
       1. + value INVALID_COST_PER_UNIT_FOR_BACKFILL
29. ≠ LiveStreamEventService (1 new, 2 changed, 0 removed)
    1. + type LiveStreamEventCustomAssetKeyError
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    3. ≠ type LiveStreamEvent
       1. + field adBreakMarkupTypesEnabled
       2. + field adBreakMarkups
       3. + field customAssetKey
       4. + field daiEncodingProfileIds
       5. + field segmentUrlAuthenticationKeyIds
30. ≠ MobileApplicationService (0 new, 2 changed, 0 removed)
    1. ≠ type MobileApplication
       1. + field appStores
    2. ≠ enum MobileApplicationStore
       1. + value AMAZON
31. ≠ NativeStyleService (2 new, 1 changed, 0 removed)
    1. + type ActivateNativeStyles
    2. + type DeactivateNativeStyles
    3. ≠ enum NativeStyleStatus
       1. + value INACTIVE
32. ≠ NetworkService (1 new, 0 changed, 0 removed)
    1. + type UrlError
33. ≠ OrderService (1 new, 4 changed, 0 removed)
    1. + type MobileApplicationTargetingError
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    4. ≠ enum ForecastError.Reason
       1. + value OUTSIDE_AVAILABLE_DATE_RANGE
    5. ≠ enum LineItemError.Reason
       1. + value INVALID_COST_PER_UNIT_FOR_BACKFILL
34. ≠ PlacementService (0 new, 1 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
35. ≠ ProposalLineItemService (1 new, 5 changed, 0 removed)
    1. + type MobileApplicationTargetingError
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
    3. ≠ enum CreativeSizeType
       1. + value AUDIO
    4. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    5. ≠ enum ForecastError.Reason
       1. + value OUTSIDE_AVAILABLE_DATE_RANGE
    6. ≠ enum LineItemError.Reason
       1. + value INVALID_COST_PER_UNIT_FOR_BACKFILL
36. ≠ ProposalService (0 new, 4 changed, 0 removed)
    1. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
    2. ≠ enum CreativeSizeType
       1. + value AUDIO
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value DAI_ENCODING_PROFILES_LIMIT_REACHED
       2. + value ACTIVE_EXPERIMENTS_LIMIT_REACHED
       3. + value SITES_LIMIT_REACHED
    4. ≠ enum ForecastError.Reason
       1. + value OUTSIDE_AVAILABLE_DATE_RANGE
37. ≠ PublisherQueryLanguageService (0 new, 1 changed, 0 removed)
    1. ≠ enum AudienceSegmentError.Reason
       1. + value SEGMENT_VIOLATED_POLICY
38. ≠ ReportService (0 new, 1 changed, 0 removed)
    1. ≠ enum Column
       1. − value GRP_POPULATION
       2. − value GRP_UNIQUE_AUDIENCE
       3. − value GRP_UNIQUE_AUDIENCE_SHARE
       4. − value GRP_AUDIENCE_IMPRESSIONS
       5. − value GRP_AUDIENCE_IMPRESSIONS_SHARE
       6. − value GRP_AUDIENCE_REACH
       7. − value GRP_AUDIENCE_AVERAGE_FREQUENCY
       8. − value GRP_GROSS_RATING_POINTS
39. ≠ StreamActivityMonitorService (0 new, 2 changed, 0 removed)
    1. ≠ enum CreativeTranscode.IdType
       1. + value MEDIA_URI_PATH
       2. + value CREATIVE_ADID_WITH_FALLBACK
       3. + value CANONICALIZED_MEDIA_URI
       4. + value GV_REGISTRY_ID
       5. + value UNKNOWN_ID_TYPE
       6. + value MEDIA_URI_HASH
    2. ≠ enum SamErrorType
       1. + value AD_POD_DROPPED_UNSUPPORTED_TYPE
40. ≠ SuggestedAdUnitService (0 new, 1 changed, 0 removed)
    1. ≠ type AdUnitSize
       1. + field isAudio
41. ≠ TargetingPresetService (1 new, 0 changed, 0 removed)
    1. + type MobileApplicationTargetingError
42. ≠ TargetingService (1 new, 0 changed, 0 removed)
    1. + type MobileApplicationTargetingError
43. = TeamService (no changes)
44. = UserService (no changes)
45. = UserTeamAssociationService (no changes)

v202005

What's New

General

• ActivityGroup's id field has been changed from an int to a long. The identifiers of existing ActivityGroups have not been changed.
• Activity's id field has been changed from an int to a long. The identifiers of existing Activities have not been changed.
• Added support for Multiple Customer Management to Companies.

Programmatic

• Added support for creating makegoods for proposal line items.

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 to Content.
• Added competitiveConstraintScope setting to line items.
• Added thirdPartyMeasurementSettings to line items.
• Removed deprecated description field from LiveStreamEvents.
• Added support for prefetch settings to LiveStreamEvents.

API Changes

1. ≠ ActivityGroupService (2 new, 2 changed, 0 removed)
   1. + type RequiredNumberError
   2. + enum RequiredNumberError.Reason
   3. ≠ type ActivityGroup
      1. + field idAsLong
      2. − field id
   4. ≠ type RequiredNumberError
      1. + field reason
2. ≠ ActivityService (0 new, 1 changed, 0 removed)
   1. ≠ type Activity
      1. + field activityGroupIdAsLong
      2. + field idAsLong
      3. − field activityGroupId
      4. − field id
3. ≠ AdExclusionRuleService (0 new, 2 changed, 0 removed)
   1. ≠ enum EntityChildrenLimitReachedError.Reason
      1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
   2. ≠ enum EntityLimitReachedError.Reason
      1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
      2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
4. ≠ AdRuleService (0 new, 1 changed, 0 removed)
   1. ≠ enum CustomTargetingError.Reason
      1. + value CANNOT_TARGET_MAPPED_METADATA
5. ≠ AdjustmentService (23 new, 18 changed, 2 removed)
   1. + type ActivateForecastAdjustments
   2. + type DailyVolumeSettings
   3. + type DeactivateForecastAdjustments
   4. + type ForecastAdjustment
   5. + type ForecastAdjustmentError
   6. + enum ForecastAdjustmentError.Reason
   7. + enum ForecastAdjustmentStatus
   8. + enum ForecastAdjustmentVolumeType
   9. + type ForecastError
   10. + enum ForecastError.Reason
   11. + type HistoricalBasisVolumeSettings
   12. + type TotalVolumeSettings
   13. + type TrafficForecastSegment
   14. + type TrafficForecastSegmentError
   15. + type VolumeTimeSeriesRequestError
   16. + enum VolumeTimeSeriesRequestError.Reason
   17. + operation createForecastAdjustments
   18. + operation createTrafficForecastSegments
   19. + operation getForecastAdjustmentsByStatement
   20. + operation getTrafficForecastSegmentsByStatement
   21. + operation performForecastAdjustmentAction
   22. + operation updateForecastAdjustments
   23. + operation updateTrafficForecastSegments
   24. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
   25. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
   26. ≠ type ForecastAdjustment
       1. + field dailyVolumeSettings
       2. + field historicalBasisVolumeSettings
       3. + field status
       4. + field totalVolumeSettings
       5. + field volumeType
   27. ≠ type ForecastAdjustmentError
       1. + field reason
   28. ≠ type ForecastAdjustmentPage
       1. + field results
   29. ≠ type ForecastError
       1. + field reason
   30. ≠ type TimeSeries
       1. + field values
   31. ≠ type TrafficForecastSegmentPage
       1. + field results
   32. ≠ type VolumeTimeSeriesRequestError
       1. + field reason
   33. ≠ operation createForecastAdjustments
       1. + parameter forecastAdjustments
       2. + response rval
   34. ≠ operation createTrafficForecastSegments
       1. + response rval
       2. + parameter trafficForecastSegments
   35. ≠ operation getForecastAdjustmentsByStatement
       1. + parameter filterStatement
       2. + response rval
   36. ≠ operation getTrafficAdjustmentsByStatement
       1. − parameter filterStatement
       2. − response rval
   37. ≠ operation getTrafficForecastSegmentsByStatement
       1. + parameter filterStatement
       2. + response rval
   38. ≠ operation performForecastAdjustmentAction
       1. + parameter filterStatement
       2. + parameter forecastAdjustmentAction
       3. + response rval
   39. ≠ operation updateForecastAdjustments
       1. + parameter forecastAdjustments
       2. + response rval
   40. ≠ operation updateTrafficAdjustments
       1. − parameter adjustments
       2. − response rval
   41. ≠ operation updateTrafficForecastSegments
       1. + response rval
       2. + parameter trafficForecastSegments
   42. − operation getTrafficAdjustmentsByStatement
   43. − operation updateTrafficAdjustments
6. ≠ AudienceSegmentService (0 new, 3 changed, 0 removed)
   1. ≠ enum CustomTargetingError.Reason
      1. + value CANNOT_TARGET_MAPPED_METADATA
   2. ≠ enum EntityChildrenLimitReachedError.Reason
      1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
   3. ≠ enum EntityLimitReachedError.Reason
      1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
      2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
7. = CdnConfigurationService (no changes)
8. ≠ CmsMetadataService (3 new, 3 changed, 0 removed)
   1. + type ActivateCmsMetadataValues
   2. + type DeactivateCmsMetadataValues
   3. + operation performCmsMetadataValueAction
   4. ≠ type CmsMetadataKey
      1. + field status
   5. ≠ type CmsMetadataValue
      1. + field status
   6. ≠ operation performCmsMetadataValueAction
      1. + parameter filterStatement
      2. + response rval
      3. + parameter valueAction
9. ≠ CompanyService (3 new, 5 changed, 0 removed)
   1. + type CompanyAction
   2. + type EndAgreementAction
   3. + operation performCompanyAction
   4. ≠ type ChildPublisher
      1. + field accountStatus
   5. ≠ type Company
      1. + field childPublisher
   6. ≠ enum DelegationStatus
      1. + value WITHDRAWN
   7. ≠ enum NetworkError.Reason
      1. + value MAX_PENDING_DELEGATION_CHILD_NETWORKS_EXCEEDED
   8. ≠ operation performCompanyAction
      1. + parameter companyAction
      2. + response rval
      3. + parameter statement
10. = ContactService (no changes)
11. = ContentBundleService (no changes)
12. ≠ ContentService (0 new, 2 changed, 0 removed)
    1. ≠ type Content
       1. + field duration
    2. ≠ enum VodIngestError
       1. + value CUE_POINT_COUNT_DOES_NOT_MATCH_PTS_COUNT
13. = CreativeReviewService (no changes)
14. ≠ CreativeService (1 new, 3 changed, 0 removed)
    1. + type ThirdPartyDataDeclaration
    2. ≠ type Creative
       1. + field thirdPartyDataDeclaration
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    4. ≠ enum HtmlBundleProcessorError.Reason
       1. + value CANNOT_DECODE_BUNDLE
15. ≠ CreativeSetService (0 new, 2 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    2. ≠ enum HtmlBundleProcessorError.Reason
       1. + value CANNOT_DECODE_BUNDLE
16. = CreativeTemplateService (no changes)
17. ≠ CreativeWrapperService (1 new, 1 changed, 0 removed)
    1. + type ThirdPartyDataDeclaration
    2. ≠ type CreativeWrapper
       1. + field thirdPartyDataDeclaration
18. ≠ CustomFieldService (0 new, 1 changed, 0 removed)
    1. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
19. ≠ CustomTargetingService (0 new, 3 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    2. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
20. = DaiAuthenticationKeyService (no changes)
21. ≠ ForecastService (3 new, 6 changed, 0 removed)
    1. + enum CompetitiveConstraintScope
    2. + type ProposalLineItemMakegoodInfo
    3. + type ThirdPartyMeasurementSettings
    4. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    5. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    6. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    7. ≠ enum LineItemError.Reason
       1. + value GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS
    8. ≠ type LineItemSummary
       1. + field competitiveConstraintScope
       2. + field thirdPartyMeasurementSettings
    9. ≠ type ProposalLineItem
       1. + field canCreateMakegood
       2. + field hasMakegood
       3. + field makegoodInfo
       4. + field thirdPartyMeasurementSettings
22. ≠ InventoryService (0 new, 2 changed, 0 removed)
    1. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
23. = LabelService (no changes)
24. ≠ LineItemCreativeAssociationService (0 new, 4 changed, 0 removed)
    1. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    3. ≠ enum HtmlBundleProcessorError.Reason
       1. + value CANNOT_DECODE_BUNDLE
    4. ≠ enum LineItemError.Reason
       1. + value GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS
25. ≠ LineItemService (2 new, 5 changed, 0 removed)
    1. + enum CompetitiveConstraintScope
    2. + type ThirdPartyMeasurementSettings
    3. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    4. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    5. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    6. ≠ enum LineItemError.Reason
       1. + value GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS
    7. ≠ type LineItemSummary
       1. + field competitiveConstraintScope
       2. + field thirdPartyMeasurementSettings
26. ≠ LineItemTemplateService (0 new, 4 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    2. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    4. ≠ enum LineItemError.Reason
       1. + value GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS
27. ≠ LiveStreamEventService (1 new, 3 changed, 1 removed)
    1. + type PrefetchSettings
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    3. ≠ type LiveStreamEvent
       1. + field enableForceCloseAdBreaks
       2. + field enableMaxFillerDuration
       3. + field enableRelativePlaylistDelivery
       4. + field enableShortSegmentDropping
       5. + field enableWhitelistedIps
       6. + field maxFillerDuration
       7. + field prefetchEnabled
       8. + field prefetchSettings
       9. + field underfillAdBreakFillType
       10. − field description
    4. ≠ operation registerSessionsForMonitoring
       1. − response rval
       2. − parameter sessionIds
    5. − operation registerSessionsForMonitoring
28. = MobileApplicationService (no changes)
29. ≠ NativeStyleService (0 new, 2 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    2. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
30. ≠ NetworkService (0 new, 3 changed, 0 removed)
    1. ≠ type ChildPublisher
       1. + field accountStatus
    2. ≠ enum DelegationStatus
       1. + value WITHDRAWN
    3. ≠ enum NetworkError.Reason
       1. + value MAX_PENDING_DELEGATION_CHILD_NETWORKS_EXCEEDED
31. ≠ OrderService (0 new, 4 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    2. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    3. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    4. ≠ enum LineItemError.Reason
       1. + value GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS
32. ≠ PlacementService (0 new, 2 changed, 0 removed)
    1. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
33. ≠ ProposalLineItemService (4 new, 6 changed, 0 removed)
    1. + type ProposalLineItemMakegoodError
    2. + type ProposalLineItemMakegoodInfo
    3. + type ThirdPartyMeasurementSettings
    4. + operation createMakegoods
    5. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    6. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    7. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    8. ≠ enum LineItemError.Reason
       1. + value GRP_PACED_LINE_ITEM_CANNOT_HAVE_ABSOLUTE_CUSTOM_PACING_CURVE_GOALS
    9. ≠ type ProposalLineItem
       1. + field canCreateMakegood
       2. + field hasMakegood
       3. + field makegoodInfo
       4. + field thirdPartyMeasurementSettings
    10. ≠ operation createMakegoods
        1. + parameter makegoodInfos
        2. + response rval
34. ≠ ProposalService (0 new, 3 changed, 0 removed)
    1. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
    2. ≠ enum EntityLimitReachedError.Reason
       1. + value TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
       2. + value FORECAST_ADJUSTMENTS_LIMIT_REACHED
    3. ≠ type ProposalMarketplaceInfo
       1. + field partnerClientId
35. = PublisherQueryLanguageService (no changes)
36. ≠ ReportService (0 new, 1 changed, 0 removed)
    1. ≠ enum Dimension
       1. + value CUSTOM_SPOT_ID
       2. + value CUSTOM_SPOT_NAME
       3. + value NIELSEN_DEVICE_ID
       4. + value NIELSEN_DEVICE_NAME
37. ≠ StreamActivityMonitorService (0 new, 2 changed, 0 removed)
    1. ≠ type AdBreak
       1. + field rootAdResponses
       2. − field rootAdResponse
    2. ≠ enum SamErrorType
       1. + value AD_REQUEST_TIMEOUT
38. = SuggestedAdUnitService (no changes)
39. ≠ TargetingPresetService (0 new, 2 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    2. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
40. ≠ TargetingService (0 new, 2 changed, 0 removed)
    1. ≠ enum CustomTargetingError.Reason
       1. + value CANNOT_TARGET_MAPPED_METADATA
    2. ≠ enum EntityChildrenLimitReachedError.Reason
       1. + value TARGETING_EXPRESSION_SIZE_LIMIT_REACHED
41. = TeamService (no changes)
42. = UserService (no changes)
43. = UserTeamAssociationService (no changes)

v202002

What's New

LineItems

• Added customPacingCurve to LineItem objects for finer control of their delivery rate.

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
  See all of the new metrics which start with "AD_EXCHANGE_VIDEO_" in the Column documentation page.

Video

• Added the StreamActivityMonitorService which returns the logging information for a Dynamic Ad Insertion sessions.
• Added contentBundleIds, cmsMetadataValueIds, and lastModifiedDateTime to video metadata Content objects.
• Added adId and adIdType 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 and mappingRuleDefinedCustomTargetingValueIds from video metadata Content objects.

API Changes

1. + CreativeReviewService
2. + StreamActivityMonitorService
3. = ActivityGroupService (no changes)
4. = ActivityService (no changes)
5. = AdExclusionRuleService (no changes)
6. ≠ AdRuleService (10 new, 11 changed, 0 removed)
   1. + type AdRuleError
   2. + enum AdSpotFillType
   3. + enum AdSpotTargetingType
   4. + type BreakTemplate
   5. + type BreakTemplate.BreakTemplateMember
   6. + operation createAdSpots
   7. + operation createBreakTemplates
   8. + operation getBreakTemplatesByStatement
   9. + operation updateAdSpots
   10. + operation updateBreakTemplates
   11. ≠ enum AdRuleTargetingError.Reason
       1. + value EXACT_CUSTOM_VALUE_TARGETING_REQUIRED
   12. ≠ type AdSpot
       1. + field allowedLineItemTypes
       2. + field backfillBlocked
       3. + field flexible
       4. + field inventorySharingBlocked
       5. + field maxDurationMillis
       6. + field maxNumberOfAds
       7. + field targetingType
   13. ≠ type BaseAdRuleSlot
       1. + field breakTemplateId
       2. − field minPodDuration
       3. − field minVideoAdDuration
   14. ≠ type BreakTemplate
       1. + field breakTemplateMembers
       2. + field customTemplate
       3. + field displayName
       4. + field id
   15. ≠ type BreakTemplate.BreakTemplateMember
       1. + field adSpotFillType
       2. + field adSpotId
   16. ≠ type BreakTemplatePage
       1. + field results
   17. ≠ operation createAdSpots
       1. + parameter adSpots
       2. + response rval
   18. ≠ operation createBreakTemplates
       1. + parameter breakTemplate
       2. + response rval
   19. ≠ operation getBreakTemplatesByStatement
       1. + parameter filterStatement
       2. + response rval
   20. ≠ operation updateAdSpots
       1. + parameter adSpots
       2. + response rval
   21. ≠ operation updateBreakTemplates
       1. + parameter breakTemplate
       2. + response rval
7. = AdjustmentService (no changes)
8. = AudienceSegmentService (no changes)
9. = CdnConfigurationService (no changes)
10. = CmsMetadataService (no changes)
11. ≠ CompanyService (1 new, 2 changed, 0 removed)
    1. + type ChildPublisher
    2. ≠ enum Company.Type
       1. + value CHILD_PUBLISHER
    3. ≠ enum NetworkError.Reason
       1. + value DELEGATION_CHILD_NETWORK_CANNOT_BECOME_A_PARENT
       2. + value DELEGATION_PARENT_NETWORK_CANNOT_BECOME_A_CHILD
       3. + value CANNOT_ADD_SAME_NETWORK_AS_DELEGATION_CHILD
       4. + value MAX_APPROVED_DELEGATION_CHILD_NETWORKS_EXCEEDED
       5. + value CHILD_NETWORK_ALREADY_EXISTS
       6. + value IN_PARENT_DELEGATION_UNSUPPORTED_FOR_NETWORK
12. = ContactService (no changes)
13. ≠ ContentBundleService (0 new, 1 changed, 0 removed)
    1. ≠ type ContentBundle
       1. + field lastModifiedDateTime
14. ≠ ContentService (0 new, 2 changed, 1 removed)
    1. ≠ type Content
       1. + field cmsMetadataValueIds
       2. + field contentBundleIds
       3. − field mappingRuleDefinedCustomTargetingValueIds
       4. − field userDefinedCustomTargetingValueIds
    2. ≠ operation getContentByStatementAndCustomTargetingValue
       1. − parameter customTargetingValueId
       2. − parameter filterStatement
       3. − response rval
    3. − operation getContentByStatementAndCustomTargetingValue
15. ≠ CreativeService (1 new, 4 changed, 0 removed)
    1. + enum AdIdType
    2. ≠ type BaseVideoCreative
       1. + field adId
       2. + field adIdType
    3. ≠ enum CreativePolicyViolation
       1. + value TRICK_TO_CLICK
       2. + value USE_OF_NON_WHITELISTED_OMID_VERIFICATION_SCRIPT
       3. + value MISUSE_OF_OMID_API
       4. + value UNACCEPTABLE_HTML_AD
    4. ≠ enum CreativeSetError.Reason
       1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
    5. ≠ enum SkippableAdType
       1. + value ANY
16. ≠ CreativeSetService (0 new, 1 changed, 0 removed)
    1. ≠ enum CreativeSetError.Reason
       1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
17. = CreativeTemplateService (no changes)
18. = CreativeWrapperService (no changes)
19. = CustomFieldService (no chan