Share your feedback on the Ad Manager API.

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.

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
Reporting
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

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 changes)
  20. = CustomTargetingService (no changes)
  21. = DaiAuthenticationKeyService (no changes)
  22. ForecastService (3 new, 6 changed, 0 removed)
    1. + type CustomPacingCurve
    2. + type CustomPacingGoal
    3. + enum CustomPacingGoalUnit
    4. type CustomPacingCurve
      1. + field customPacingGoalUnit
      2. + field customPacingGoals
    5. enum DeliveryForecastSource
      1. + value CUSTOM_PACING_CURVE
    6. enum LineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
      2. + value CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME
      3. + value CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME
      4. + value INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE
      5. + value INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS
      6. + value COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED
      7. + value LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO
    7. type LineItemSummary
      1. + field customPacingCurve
    8. type ProposalLineItem
      1. + field videoCreativeSkippableAdType
    9. enum SkippableAdType
      1. + value ANY
  23. = InventoryService (no changes)
  24. = LabelService (no changes)
  25. LineItemCreativeAssociationService (0 new, 2 changed, 0 removed)
    1. enum CreativeSetError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
    2. enum LineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
      2. + value CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME
      3. + value CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME
      4. + value INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE
      5. + value INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS
      6. + value COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED
      7. + value LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO
  26. LineItemService (3 new, 5 changed, 0 removed)
    1. + type CustomPacingCurve
    2. + type CustomPacingGoal
    3. + enum CustomPacingGoalUnit
    4. type CustomPacingCurve
      1. + field customPacingGoalUnit
      2. + field customPacingGoals
    5. enum DeliveryForecastSource
      1. + value CUSTOM_PACING_CURVE
    6. enum LineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
      2. + value CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME
      3. + value CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME
      4. + value INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE
      5. + value INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS
      6. + value COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED
      7. + value LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO
    7. type LineItemSummary
      1. + field customPacingCurve
    8. enum SkippableAdType
      1. + value ANY
  27. LineItemTemplateService (0 new, 1 changed, 0 removed)
    1. enum LineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
      2. + value CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME
      3. + value CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME
      4. + value INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE
      5. + value INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS
      6. + value COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED
      7. + value LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO
  28. LiveStreamEventService (1 new, 1 changed, 0 removed)
    1. + type VideoAdTagError
    2. enum SamSessionError.Reason
      1. + value INVALID_SESSION_ID
      2. + value INVALID_DEBUG_KEY
      3. + value REQUEST_EXCEEDS_SESSION_LIMIT
  29. = MobileApplicationService (no changes)
  30. = NativeStyleService (no changes)
  31. NetworkService (1 new, 2 changed, 0 removed)
    1. + type ChildPublisher
    2. type Network
      1. + field childPublishers
    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
  32. OrderService (0 new, 1 changed, 0 removed)
    1. enum LineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
      2. + value CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME
      3. + value CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME
      4. + value INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE
      5. + value INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS
      6. + value COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED
      7. + value LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO
  33. = PlacementService (no changes)
  34. ProposalLineItemService (0 new, 4 changed, 0 removed)
    1. enum LineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
      2. + value CUSTOM_PACING_CURVE_START_TIME_MUST_MATCH_LINE_ITEM_START_TIME
      3. + value CUSTOM_PACING_CURVE_START_TIME_PAST_LINE_ITEM_END_TIME
      4. + value INVALID_LINE_ITEM_TYPE_FOR_DELIVERY_FORECAST_SOURCE
      5. + value INVALID_TOTAL_CUSTOM_PACING_GOAL_AMOUNTS
      6. + value COPY_LINE_ITEM_WITH_CUSTOM_PACING_CURVE_FULLY_IN_PAST_NOT_ALLOWED
      7. + value LAST_CUSTOM_PACING_GOAL_AMOUNT_CANNOT_BE_ZERO
    2. type ProposalLineItem
      1. + field videoCreativeSkippableAdType
    3. enum ProposalLineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
    4. enum SkippableAdType
      1. + value ANY
  35. ProposalService (0 new, 1 changed, 0 removed)
    1. enum ProposalLineItemError.Reason
      1. + value SKIPPABLE_AD_TYPE_NOT_ALLOWED
  36. = PublisherQueryLanguageService (no changes)
  37. ReportService (0 new, 1 changed, 0 removed)
    1. enum Column
      1. + value AD_SERVER_CPM_AND_CPC_REVENUE_GROSS
      2. + value AD_SERVER_ALL_REVENUE_GROSS
      3. + value AD_EXCHANGE_VIDEO_AUTO_PLAY
      4. + value AD_EXCHANGE_VIDEO_CLICK_TO_PLAY
      5. + value AD_EXCHANGE_VIDEO_START
      6. + value AD_EXCHANGE_VIDEO_MIDPOINT
      7. + value AD_EXCHANGE_VIDEO_COMPLETE
      8. + value AD_EXCHANGE_VIDEO_COMPLETION_RATE
      9. + value AD_EXCHANGE_VIDEO_COLLAPSE
      10. + value AD_EXCHANGE_VIDEO_EXPAND
      11. + value AD_EXCHANGE_VIDEO_FULL_SCREEN
      12. + value AD_EXCHANGE_VIDEO_MUTE
      13. + value AD_EXCHANGE_VIDEO_PAUSE
      14. + value AD_EXCHANGE_VIDEO_RESUME
      15. + value AD_EXCHANGE_VIDEO_REWIND
      16. + value AD_EXCHANGE_VIDEO_SKIPPED
      17. + value AD_EXCHANGE_VIDEO_UNMUTE
      18. + value AD_EXCHANGE_VIDEO_VAST2_ERROR_COUNT
      19. + value AD_EXCHANGE_VIDEO_VAST_ERROR_100_COUNT
      20. + value AD_EXCHANGE_VIDEO_VAST_ERROR_101_COUNT
      21. + value AD_EXCHANGE_VIDEO_VAST_ERROR_102_COUNT
      22. + value AD_EXCHANGE_VIDEO_VAST_ERROR_200_COUNT
      23. + value AD_EXCHANGE_VIDEO_VAST_ERROR_201_COUNT
      24. + value AD_EXCHANGE_VIDEO_VAST_ERROR_202_COUNT
      25. + value AD_EXCHANGE_VIDEO_VAST_ERROR_203_COUNT
      26. + value AD_EXCHANGE_VIDEO_VAST_ERROR_300_COUNT
      27. + value AD_EXCHANGE_VIDEO_VAST_ERROR_301_COUNT
      28. + value AD_EXCHANGE_VIDEO_VAST_ERROR_302_COUNT
      29. + value AD_EXCHANGE_VIDEO_VAST_ERROR_303_COUNT
      30. + value AD_EXCHANGE_VIDEO_VAST_ERROR_400_COUNT
      31. + value AD_EXCHANGE_VIDEO_VAST_ERROR_401_COUNT
      32. + value AD_EXCHANGE_VIDEO_VAST_ERROR_402_COUNT
      33. + value AD_EXCHANGE_VIDEO_VAST_ERROR_403_COUNT
      34. + value AD_EXCHANGE_VIDEO_VAST_ERROR_405_COUNT
      35. + value AD_EXCHANGE_VIDEO_VAST_ERROR_500_COUNT
      36. + value AD_EXCHANGE_VIDEO_VAST_ERROR_501_COUNT
      37. + value AD_EXCHANGE_VIDEO_VAST_ERROR_502_COUNT
      38. + value AD_EXCHANGE_VIDEO_VAST_ERROR_503_COUNT
      39. + value AD_EXCHANGE_VIDEO_VAST_ERROR_600_COUNT
      40. + value AD_EXCHANGE_VIDEO_VAST_ERROR_601_COUNT
      41. + value AD_EXCHANGE_VIDEO_VAST_ERROR_602_COUNT
      42. + value AD_EXCHANGE_VIDEO_VAST_ERROR_603_COUNT
      43. + value AD_EXCHANGE_VIDEO_VAST_ERROR_604_COUNT
      44. + value AD_EXCHANGE_VIDEO_VAST_ERROR_900_COUNT
      45. + value AD_EXCHANGE_VIDEO_VAST_ERROR_901_COUNT
      46. + value AD_EXCHANGE_VIDEO_TOTAL_VAST_ERROR_COUNT
      47. + value AD_EXCHANGE_VIDEO_TOTAL_ERROR_RATE
      48. + value TOTAL_VIDEO_OPPORTUNITIES
      49. + value TOTAL_VIDEO_CAPPED_OPPORTUNITIES
      50. + value DP_ECPM
  38. = SuggestedAdUnitService (no changes)
  39. = TargetingPresetService (no changes)
  40. = TargetingService (no changes)
  41. = TeamService (no changes)
  42. = UserService (no changes)
  43. = UserTeamAssociationService (no changes)

v201911

What's New

LiveStreamEvent
  • Renamed liveStreamEventCode to assetKey.
Reporting
  • Added CMS_METADATA dimension and cmsMetadataKeyIds ReportQuery field for breaking down reports on key value pairs ingested from a publisher's CMS.
  • Added better error messages for some ReportQuery configuration issues:
    • DATE_RANGE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
    • TIME_ZONE_TYPE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
    • TEAMS_MODE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
    • CURRENCY_CODE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
  • Removed Sales Manager ReportQuery options:
Video
  • Added LineItem.customVastExtension for specifying custom XML to be rendered in a custom VAST response at serving time.
  • Added mediaPlaylistOriginForwardingType and mediaPlaylistOriginPathPrefix fields to CdnConfigurations for additional configurability of Dynamic Ad Insertion.

API Changes

  1. = ActivityGroupService (no changes)
  2. = ActivityService (no changes)
  3. = AdExclusionRuleService (no changes)
  4. = AdRuleService (no changes)
  5. = AdjustmentService (no changes)
  6. = AudienceSegmentService (no changes)
  7. CdnConfigurationService (0 new, 2 changed, 0 removed)
    1. enum OriginForwardingType
      1. + value NONE
    2. type SecurityPolicySettings
      1. + field mediaPlaylistOriginForwardingType
      2. + field mediaPlaylistOriginPathPrefix
  8. = CmsMetadataService (no changes)
  9. = CompanyService (no changes)
  10. = ContactService (no changes)
  11. = ContentBundleService (no changes)
  12. = ContentService (no changes)
  13. = CreativeService (no changes)
  14. = CreativeSetService (no changes)
  15. = CreativeTemplateService (no changes)
  16. = CreativeWrapperService (no changes)
  17. = CustomFieldService (no changes)
  18. = CustomTargetingService (no changes)
  19. = DaiAuthenticationKeyService (no changes)
  20. ForecastService (0 new, 1 changed, 0 removed)
    1. type LineItemSummary
      1. + field customVastExtension
      2. + field skippableAdType
  21. = InventoryService (no changes)
  22. = LabelService (no changes)
  23. = LineItemCreativeAssociationService (no changes)
  24. LineItemService (0 new, 1 changed, 0 removed)
    1. type LineItemSummary
      1. + field customVastExtension
      2. + field skippableAdType
  25. = LineItemTemplateService (no changes)
  26. LiveStreamEventService (0 new, 2 changed, 0 removed)
    1. enum OriginForwardingType
      1. + value NONE
    2. type SecurityPolicySettings
      1. + field mediaPlaylistOriginForwardingType
      2. + field mediaPlaylistOriginPathPrefix
  27. MobileApplicationService (0 new, 2 changed, 0 removed)
    1. enum MobileApplicationPlatform
      1. + value ROKU
      2. + value AMAZON_FIRETV
      3. + value PLAYSTATION
      4. + value XBOX
      5. + value SAMSUNG_TV
    2. enum MobileApplicationStore
      1. + value ROKU
      2. + value AMAZON_FIRETV
      3. + value PLAYSTATION
      4. + value XBOX
      5. + value SAMSUNG_TV
  28. = NativeStyleService (no changes)
  29. = NetworkService (no changes)
  30. = OrderService (no changes)
  31. = PlacementService (no changes)
  32. = ProposalLineItemService (no changes)
  33. ProposalService (0 new, 1 changed, 0 removed)
    1. type RequestBuyerAcceptance
      1. + field allowOverbook
  34. = PublisherQueryLanguageService (no changes)
  35. ReportService (0 new, 6 changed, 0 removed)
    1. enum Column
      1. + value UNIQUE_REACH_FREQUENCY
      2. + value UNIQUE_REACH_IMPRESSIONS
      3. + value UNIQUE_REACH
      4. + value DP_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS
      5. + value DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS
      6. + value DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS
      7. + value DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE
      8. + value DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE
      9. value REACH_FREQUENCY
      10. value REACH_AVERAGE_REVENUE
      11. value REACH
      12. value CONTRACTED_REVENUE_CONTRACTED_NET_REVENUE
      13. value CONTRACTED_REVENUE_LOCAL_CONTRACTED_NET_REVENUE
      14. value CONTRACTED_REVENUE_CONTRACTED_GROSS_REVENUE
      15. value CONTRACTED_REVENUE_LOCAL_CONTRACTED_GROSS_REVENUE
      16. value CONTRACTED_REVENUE_CONTRACTED_VAT
      17. value CONTRACTED_REVENUE_LOCAL_CONTRACTED_VAT
      18. value CONTRACTED_REVENUE_CONTRACTED_AGENCY_COMMISSION
      19. value CONTRACTED_REVENUE_LOCAL_CONTRACTED_AGENCY_COMMISSION
      20. value SALES_CONTRACT_CONTRACTED_IMPRESSIONS
      21. value SALES_CONTRACT_CONTRACTED_CLICKS
      22. value SALES_CONTRACT_CONTRACTED_VOLUME
      23. value SALES_CONTRACT_BUDGET
      24. value SALES_CONTRACT_REMAINING_BUDGET
      25. value SALES_CONTRACT_BUFFERED_IMPRESSIONS
      26. value SALES_CONTRACT_BUFFERED_CLICKS
      27. value SCHEDULED_SCHEDULED_IMPRESSIONS
      28. value SCHEDULED_SCHEDULED_CLICKS
      29. value SCHEDULED_SCHEDULED_VOLUME
      30. value SCHEDULED_SCHEDULED_NET_REVENUE
      31. value SCHEDULED_LOCAL_SCHEDULED_NET_REVENUE
      32. value SCHEDULED_SCHEDULED_GROSS_REVENUE
      33. value SCHEDULED_LOCAL_SCHEDULED_GROSS_REVENUE
      34. value SALES_TOTAL_TOTAL_BUDGET
      35. value SALES_TOTAL_TOTAL_REMAINING_BUDGET
      36. value SALES_TOTAL_TOTAL_CONTRACTED_VOLUME
      37. value SALES_TOTAL_TOTAL_CONTRACTED_NET_REVENUE
      38. value SALES_TOTAL_LOCAL_TOTAL_CONTRACTED_NET_REVENUE
      39. value SALES_TOTAL_TOTAL_CONTRACTED_GROSS_REVENUE
      40. value SALES_TOTAL_LOCAL_TOTAL_CONTRACTED_GROSS_REVENUE
      41. value SALES_TOTAL_TOTAL_CONTRACTED_AGENCY_COMMISSION
      42. value SALES_TOTAL_LOCAL_TOTAL_CONTRACTED_AGENCY_COMMISSION
      43. value SALES_TOTAL_TOTAL_CONTRACTED_NET_REVENUE_WITH_VAT
      44. value SALES_TOTAL_LOCAL_TOTAL_CONTRACTED_NET_REVENUE_WITH_VAT
      45. value SALES_TOTAL_TOTAL_SCHEDULED_VOLUME
      46. value SALES_TOTAL_TOTAL_SCHEDULED_NET_REVENUE
      47. value SALES_TOTAL_LOCAL_TOTAL_SCHEDULED_NET_REVENUE
      48. value SALES_TOTAL_TOTAL_SCHEDULED_GROSS_REVENUE
      49. value SALES_TOTAL_LOCAL_TOTAL_SCHEDULED_GROSS_REVENUE
      50. value UNIFIED_REVENUE_UNRECONCILED_NET_REVENUE
      51. value UNIFIED_REVENUE_LOCAL_UNRECONCILED_NET_REVENUE
      52. value UNIFIED_REVENUE_UNRECONCILED_GROSS_REVENUE
      53. value UNIFIED_REVENUE_LOCAL_UNRECONCILED_GROSS_REVENUE
      54. value UNIFIED_REVENUE_FORECASTED_NET_REVENUE
      55. value UNIFIED_REVENUE_LOCAL_FORECASTED_NET_REVENUE
      56. value UNIFIED_REVENUE_FORECASTED_GROSS_REVENUE
      57. value UNIFIED_REVENUE_LOCAL_FORECASTED_GROSS_REVENUE
      58. value UNIFIED_REVENUE_UNIFIED_NET_REVENUE
      59. value UNIFIED_REVENUE_LOCAL_UNIFIED_NET_REVENUE
      60. value UNIFIED_REVENUE_UNIFIED_GROSS_REVENUE
      61. value UNIFIED_REVENUE_LOCAL_UNIFIED_GROSS_REVENUE
      62. value UNIFIED_REVENUE_UNIFIED_AGENCY_COMMISSION
      63. value UNIFIED_REVENUE_LOCAL_UNIFIED_AGENCY_COMMISSION
      64. value UNIFIED_REVENUE_UNRECONCILED_VOLUME
      65. value UNIFIED_REVENUE_FORECASTED_VOLUME
      66. value UNIFIED_REVENUE_UNIFIED_VOLUME
      67. value EXPECTED_REVENUE_EXPECTED_NET_REVENUE
      68. value EXPECTED_REVENUE_LOCAL_EXPECTED_NET_REVENUE
      69. value EXPECTED_REVENUE_EXPECTED_GROSS_REVENUE
      70. value EXPECTED_REVENUE_LOCAL_EXPECTED_GROSS_REVENUE
      71. value SALES_PIPELINE_PIPELINE_NET_REVENUE
      72. value SALES_PIPELINE_LOCAL_PIPELINE_NET_REVENUE
      73. value SALES_PIPELINE_PIPELINE_GROSS_REVENUE
      74. value SALES_PIPELINE_LOCAL_PIPELINE_GROSS_REVENUE
      75. value SALES_PIPELINE_PIPELINE_AGENCY_COMMISSION
      76. value SALES_PIPELINE_LOCAL_PIPELINE_AGENCY_COMMISSION
      77. value RECONCILIATION_DFP_VOLUME
      78. value RECONCILIATION_THIRD_PARTY_VOLUME
      79. value RECONCILIATION_RECONCILED_VOLUME
      80. value RECONCILIATION_DISCREPANCY
      81. value RECONCILIATION_RECONCILED_REVENUE
      82. value RECONCILIATION_IMPRESSION_DISCREPANCY
      83. value RECONCILIATION_CLICK_DISCREPANCY
      84. value RECONCILIATION_REVENUE_DISCREPANCY
      85. value BILLING_BILLABLE_NET_REVENUE
      86. value BILLING_LOCAL_BILLABLE_NET_REVENUE
      87. value BILLING_BILLABLE_GROSS_REVENUE
      88. value BILLING_LOCAL_BILLABLE_GROSS_REVENUE
      89. value BILLING_BILLABLE_NET_REVENUE_BEFORE_MANUAL_ADJUSTMENT
      90. value BILLING_LOCAL_BILLABLE_NET_REVENUE_BEFORE_MANUAL_ADJUSTMENT
      91. value BILLING_BILLABLE_GROSS_REVENUE_BEFORE_MANUAL_ADJUSTMENT
      92. value BILLING_LOCAL_BILLABLE_GROSS_REVENUE_BEFORE_MANUAL_ADJUSTMENT
      93. value BILLING_BILLABLE_VAT
      94. value BILLING_LOCAL_BILLABLE_VAT
      95. value BILLING_BILLABLE_AGENCY_COMMISSION
      96. value BILLING_LOCAL_BILLABLE_AGENCY_COMMISSION
      97. value BILLING_CAP_QUANTITY
      98. value BILLING_BILLABLE_VOLUME
      99. value BILLING_DELIVERY_ROLLOVER_FROM_PREVIOUS
      100. value BILLING_REALIZED_CPM
      101. value BILLING_REALIZED_RATE
      102. value DISCOUNTS_BREAKDOWN_CONTRACTED_NET_OVERALL_DISCOUNT
      103. value DISCOUNTS_BREAKDOWN_BILLABLE_NET_OVERALL_DISCOUNT
      104. value DISCOUNTS_BREAKDOWN_CONTRACTED_NET_NON_BILLABLE
    2. enum Dimension
      1. + value CMS_METADATA
      2. + value CHILD_NETWORK_ID
      3. + value CHILD_NETWORK_CODE
      4. value PROPOSAL_LINE_ITEM_ID
      5. value PROPOSAL_LINE_ITEM_NAME
      6. value PROPOSAL_ID
      7. value PROPOSAL_NAME
      8. value ALL_SALESPEOPLE_ID
      9. value ALL_SALESPEOPLE_NAME
      10. value SALES_TEAM_ID
      11. value SALES_TEAM_NAME
      12. value PROPOSAL_AGENCY_ID
      13. value PROPOSAL_AGENCY_NAME
      14. value PRODUCT_ID
      15. value PRODUCT_NAME
      16. value PRODUCT_TEMPLATE_ID
      17. value PRODUCT_TEMPLATE_NAME
      18. value RATE_CARD_ID
      19. value RATE_CARD_NAME
      20. value WORKFLOW_ID
      21. value WORKFLOW_NAME
      22. value PACKAGE_ID
      23. value PACKAGE_NAME
      24. value PRODUCT_PACKAGE_ID
      25. value PRODUCT_PACKAGE_NAME
    3. enum DimensionAttribute
      1. value PROPOSAL_START_DATE_TIME
      2. value PROPOSAL_END_DATE_TIME
      3. value PROPOSAL_CREATION_DATE_TIME
      4. value PROPOSAL_SOLD_DATE_TIME
      5. value PROPOSAL_IS_SOLD
      6. value PROPOSAL_PROBABILITY_TO_CLOSE
      7. value PROPOSAL_STATUS_V2
      8. value PROPOSAL_ARCHIVAL_STATUS
      9. value PROPOSAL_CURRENCY
      10. value PROPOSAL_EXCHANGE_RATE
      11. value PROPOSAL_AGENCY_COMMISSION_RATE
      12. value PROPOSAL_VAT_RATE
      13. value PROPOSAL_DISCOUNT
      14. value PROPOSAL_ADVERTISER_DISCOUNT
      15. value PROPOSAL_ADVERTISER
      16. value PROPOSAL_ADVERTISER_ID
      17. value PROPOSAL_AGENCIES
      18. value PROPOSAL_AGENCY_IDS
      19. value PROPOSAL_PO_NUMBER
      20. value PROPOSAL_PRIMARY_SALESPERSON
      21. value PROPOSAL_SECONDARY_SALESPEOPLE
      22. value PROPOSAL_CREATOR
      23. value PROPOSAL_SALES_PLANNERS
      24. value PROPOSAL_PRICING_MODEL
      25. value PROPOSAL_BILLING_SOURCE
      26. value PROPOSAL_BILLING_CAP
      27. value PROPOSAL_BILLING_SCHEDULE
      28. value PROPOSAL_APPLIED_TEAM_NAMES
      29. value PROPOSAL_APPROVAL_STAGE
      30. value PROPOSAL_INVENTORY_RELEASE_DATE_TIME
      31. value PROPOSAL_LOCAL_BUDGET
      32. value PROPOSAL_LOCAL_REMAINING_BUDGET
      33. value PROPOSAL_FLAT_FEE
      34. value PROPOSAL_IS_PROGRAMMATIC
      35. value PROPOSAL_LINE_ITEM_START_DATE_TIME
      36. value PROPOSAL_LINE_ITEM_END_DATE_TIME
      37. value PROPOSAL_LINE_ITEM_RATE_TYPE
      38. value PROPOSAL_LINE_ITEM_RESERVATION_STATUS
      39. value PROPOSAL_LINE_ITEM_COST_PER_UNIT
      40. value PROPOSAL_LINE_ITEM_LOCAL_COST_PER_UNIT
      41. value PROPOSAL_LINE_ITEM_COST_PER_UNIT_GROSS
      42. value PROPOSAL_LINE_ITEM_LOCAL_COST_PER_UNIT_GROSS
      43. value PROPOSAL_LINE_ITEM_TYPE_AND_PRIORITY
      44. value PROPOSAL_LINE_ITEM_SIZE
      45. value PROPOSAL_LINE_ITEM_ARCHIVAL_STATUS
      46. value PROPOSAL_LINE_ITEM_PRODUCT_ADJUSTMENT
      47. value PROPOSAL_LINE_ITEM_BUFFER
      48. value PROPOSAL_LINE_ITEM_TARGET_RATE_NET
      49. value PROPOSAL_LINE_ITEM_BILLING_SOURCE
      50. value PROPOSAL_LINE_ITEM_BILLING_CAP
      51. value PROPOSAL_LINE_ITEM_BILLING_SCHEDULE
      52. value PROPOSAL_LINE_ITEM_GOAL_PERCENTAGE
      53. value PROPOSAL_LINE_ITEM_COST_ADJUSTMENT
      54. value PROPOSAL_LINE_ITEM_COMMENTS
      55. value PROPOSAL_LINE_ITEM_RECONCILIATION_STATUS
      56. value PROPOSAL_LINE_ITEM_LAST_RECONCILIATION_DATE_TIME
      57. value PROPOSAL_LINE_ITEM_FLAT_FEE
      58. value PRODUCT_PACKAGE_ITEM_ARCHIVAL_STATUS
      59. value PROPOSAL_LINE_ITEM_TYPE
      60. value PRODUCT_TEMPLATE_RATE_TYPE
      61. value PRODUCT_TEMPLATE_STATUS
      62. value PRODUCT_TEMPLATE_TYPE_AND_PRIORITY
      63. value PRODUCT_TEMPLATE_PRODUCT_TYPE
      64. value PRODUCT_TEMPLATE_DESCRIPTION
      65. value PRODUCT_PRODUCT_TEMPLATE_NAME
      66. value PRODUCT_RATE_TYPE
      67. value PRODUCT_STATUS
      68. value PRODUCT_TYPE_AND_PRIORITY
      69. value PRODUCT_PRODUCT_TYPE
      70. value PRODUCT_NOTES
      71. value PRODUCT_INVENTORY_SIZES
      72. value PRODUCT_RATE
      73. value PACKAGED_PRODUCT_RATE
      74. value PROPOSAL_AGENCY_TYPE
      75. value PROPOSAL_AGENCY_CREDIT_STATUS
      76. value PROPOSAL_AGENCY_EXTERNAL_ID
      77. value PROPOSAL_AGENCY_COMMENT
      78. value SALESPEOPLE_PROPOSAL_CONTRIBUTION
      79. value SALESPERSON_PROPOSAL_CONTRIBUTION
      80. value PRODUCT_PACKAGE_NOTES
      81. value PRODUCT_PACKAGE_ITEMS
      82. value PRODUCT_PACKAGE_STATUS
      83. value PACKAGE_COMMENTS
      84. value PACKAGE_START_DATE_TIME
      85. value PACKAGE_END_DATE_TIME
    4. enum ReportError.Reason
      1. + value INVALID_CMS_METADATA_DIMENSIONS
      2. + value DATE_RANGE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
      3. + value TIME_ZONE_TYPE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
      4. + value CURRENCY_CODE_NOT_SUPPORTED_FOR_REQUESTED_REPORT
    5. type ReportQuery
      1. + field cmsMetadataKeyIds
      2. field includeZeroSalesRows
    6. enum TimeZoneSelection
      1. value PROPOSAL_LOCAL
  36. = SuggestedAdUnitService (no changes)
  37. = TargetingPresetService (no changes)
  38. = TargetingService (no changes)
  39. = TeamService (no changes)
  40. = UserService (no changes)
  41. = UserTeamAssociationService (no changes)