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: v202108
• Previous versions: v202105, v202102, v202011

v202108

What's New

Forecast Adjustments

• Added validation for ad request source duration compared to the adjustment duration.

Line Item Creative Associations

• Added a new error for when getPreviewUrl is called for a ThirdPartyCreative that doesn't have a snippet.

Mobile Applications

• On MobileApplication entity, changed singular appStore to the list field appStores.
• Added MobileApplication.applicationId as the new app ID. The old field, MobileApplication.id, is now deprecated and will be removed in a future version of the API.
• Added MobileApplication.applicationCode, which is the same code used to identify the app in the Google Mobile Ads SDK.

Programmatic

• Added pauseRole and pauseReason fields to ProposalLineItem.
• Added a new error for when a ProposalLineItem has a cost type not supported on Makegoods.
• Added the ability to create ProposalLineItem objects with Nielsen Digital Ad Ratings, including validation and the corresponding errors CROSS_SELL_TARGETING_UNSUPPORTED and START_DATE_TIME_TOO_LATE_IN_MONTH.

Reporting

• Added a new error for when an adUnitView is not supported for a requested report.

Video

• Added validation to check that an AdRule does not have more than 1 mid-roll slot that is set not to show ads.
• Added persistUnmatchedProfiles field to DaiEncodingProfile which, if set to true on a create or update request, will enforce whether to allow the request based on Google's supported encoding profiles. (This works similarly to LineItem's allowOverbook and skipInventoryCheck, in that it isn't persisted on the entity and it only affects the current request.)

API Changes

1. = ActivityGroupService (no changes)
2. = ActivityService (no changes)
3. = AdExclusionRuleService (no changes)
4. ≠ AdRuleService (0 new, 1 changed, 0 removed)
   1. ≠ enum AdRuleSlotError.Reason
      1. + value TOO_MANY_MIDROLL_SLOTS_WITHOUT_ADS
5. ≠ AdjustmentService (0 new, 1 changed, 0 removed)
   1. ≠ enum ForecastAdjustmentError.Reason
      1. + value AD_REQUEST_HISTORICAL_BASIS_DATE_RANGE_TOO_SHORT_RELATIVE_TO_ADJUSTMENT
6. = AudienceSegmentService (no changes)
7. = CdnConfigurationService (no changes)
8. = CmsMetadataService (no changes)
9. ≠ CompanyService (0 new, 1 changed, 0 removed)
   1. ≠ type CompanySettings
      1. − field advertiserDiscount
      2. − field agencyCommission
      3. − field billingCap
      4. − field billingSchedule
      5. − field billingSource
      6. − field valueAddedTax
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 (no changes)
20. = DaiAuthenticationKeyService (no changes)
21. ≠ DaiEncodingProfileService (1 new, 1 changed, 0 removed)
    1. + type DaiEncodingProfileAdMatchingError
    2. ≠ type DaiEncodingProfile
       1. + field persistUnmatchedProfiles
22. ≠ ForecastService (0 new, 2 changed, 0 removed)
    1. ≠ type ProposalLineItem
       1. + field pauseReason
       2. + field pauseRole
    2. ≠ type ProposalLineItemMarketplaceInfo
       1. − field adExchangeEnvironment
23. = InventoryService (no changes)
24. = LabelService (no changes)
25. ≠ LineItemCreativeAssociationService (0 new, 1 changed, 0 removed)
    1. ≠ enum CreativePreviewError.Reason
       1. + value HTML_SNIPPET_REQUIRED_FOR_THIRD_PARTY_CREATIVE
26. = LineItemService (no changes)
27. = LineItemTemplateService (no changes)
28. = LiveStreamEventService (no changes)
29. ≠ MobileApplicationService (0 new, 2 changed, 0 removed)
    1. ≠ type MobileApplication
       1. + field appStores
       2. + field applicationCode
       3. + field applicationId
       4. − field appStore
    2. ≠ enum MobileApplicationStore
       1. + value AMAZON_APP_STORE
       2. + value OPPO_APP_STORE
       3. + value SAMSUNG_APP_STORE
       4. + value VIVO_APP_STORE
       5. + value XIAOMI_APP_STORE
30. = NativeStyleService (no changes)
31. = NetworkService (no changes)
32. = OrderService (no changes)
33. = PlacementService (no changes)
34. ≠ ProposalLineItemService (0 new, 5 changed, 0 removed)
    1. ≠ type PauseProposalLineItems
       1. + field reason
    2. ≠ type ProposalLineItem
       1. + field pauseReason
       2. + field pauseRole
    3. ≠ enum ProposalLineItemError.Reason
       1. + value START_DATE_TIME_TOO_LATE_IN_MONTH
       2. + value CROSS_SELL_TARGETING_UNSUPPORTED
    4. ≠ enum ProposalLineItemMakegoodError.Reason
       1. + value MAKEGOODS_NOT_SUPPORTED_FOR_COST_TYPE
    5. ≠ type ProposalLineItemMarketplaceInfo
       1. − field adExchangeEnvironment
35. ≠ ProposalService (0 new, 1 changed, 0 removed)
    1. ≠ enum ProposalLineItemError.Reason
       1. + value START_DATE_TIME_TOO_LATE_IN_MONTH
       2. + value CROSS_SELL_TARGETING_UNSUPPORTED
36. = PublisherQueryLanguageService (no changes)
37. ≠ ReportService (0 new, 1 changed, 0 removed)
    1. ≠ enum ReportError.Reason
       1. + value AD_UNIT_VIEW_NOT_SUPPORTED_FOR_REQUESTED_REPORT
38. = SiteService (no changes)
39. = StreamActivityMonitorService (no changes)
40. = SuggestedAdUnitService (no changes)
41. = TargetingPresetService (no changes)
42. = TeamService (no changes)
43. = UserService (no changes)
44. = UserTeamAssociationService (no changes)

v202105

What's New

Creatives

• Added support for pushing creative previews to linked devices.

Multiple Customer Management

• Added Site DisapprovalReason to the SiteService.

Programmatic

• Added support for pause controls on Proposals.

Reporting

• Added support for Inventory Share Dimensions.

Video

• Removed support for filtering on field keyValueMemberContent in CmsMetadataService.getCmsMetadataValuesByStatement. Use Content.cmsMetadataValueIds instead.

API Changes

1. = ActivityGroupService (no changes)
2. = ActivityService (no changes)
3. = AdExclusionRuleService (no changes)
4. = AdRuleService (no changes)
5. ≠ AdjustmentService (0 new, 3 changed, 4 removed)
   1. ≠ type TrafficForecastAdjustment
      1. − field filterCriteria
      2. − field forecastAdjustmentSegments
   2. ≠ type TrafficForecastAdjustmentPage
      1. − field results
   3. ≠ type TrafficForecastAdjustmentSegment
      1. − field historicalAdjustment
   4. − type HistoricalAdjustment
   5. − type TrafficForecastAdjustment
   6. − type TrafficForecastAdjustmentSegment
   7. − type TrafficTimeSeriesFilterCriteria
6. = AudienceSegmentService (no changes)
7. = CdnConfigurationService (no changes)
8. = CmsMetadataService (no changes)
9. ≠ CompanyService (0 new, 1 changed, 0 removed)
   1. ≠ enum NetworkError.Reason
      1. + value CHILD_NETWORK_CANNOT_BE_DISAPPROVED
10. = ContactService (no changes)
11. = ContentBundleService (no changes)
12. ≠ ContentService (0 new, 1 changed, 0 removed)
    1. ≠ enum VodIngestError
       1. + value MIXED_AD_BREAK_TAGS
       2. + value AD_BREAK_TAGS_INCONSISTENT_ACROSS_VARIANTS
13. = CreativeReviewService (no changes)
14. ≠ CreativeService (0 new, 2 changed, 0 removed)
    1. ≠ type AdExchangeCreative
       1. + field isAllowsAllRequestedSizes
    2. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
15. ≠ CreativeSetService (0 new, 1 changed, 0 removed)
    1. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
16. = CreativeTemplateService (no changes)
17. = CreativeWrapperService (no changes)
18. = CustomFieldService (no changes)
19. = CustomTargetingService (no changes)
20. = DaiAuthenticationKeyService (no changes)
21. = DaiEncodingProfileService (no changes)
22. ≠ ForecastService (0 new, 8 changed, 0 removed)
    1. ≠ enum CostType
       1. + value CPM_IN_TARGET
    2. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
    3. ≠ type GrpSettings
       1. + field inTargetRatioEstimateMilliPercent
    4. ≠ enum GrpSettingsError.Reason
       1. + value DEMOG_GOAL_EXPECTED
       2. + value UNSUPPORTED_GRP_SETTING
       3. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS
       4. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL
    5. ≠ enum RateType
       1. + value CPM_IN_TARGET
    6. ≠ enum ThirdPartyReachIntegrationPartner
       1. + value KANTAR_MILLWARD_BROWN
    7. ≠ enum ThirdPartyViewabilityIntegrationPartner
       1. + value COMSCORE
       2. + value TELEMETRY
       3. + value MEETRICS
    8. ≠ enum UnitType
       1. + value IN_TARGET_IMPRESSIONS
23. = InventoryService (no changes)
24. = LabelService (no changes)
25. ≠ LineItemCreativeAssociationService (2 new, 2 changed, 0 removed)
    1. + type CreativePushOptions
    2. + operation pushCreativeToDevices
    3. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
    4. ≠ operation pushCreativeToDevices
       1. + parameter filterStatement
       2. + parameter options
       3. + response rval
26. ≠ LineItemService (0 new, 7 changed, 0 removed)
    1. ≠ enum CostType
       1. + value CPM_IN_TARGET
    2. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
    3. ≠ type GrpSettings
       1. + field inTargetRatioEstimateMilliPercent
    4. ≠ enum GrpSettingsError.Reason
       1. + value DEMOG_GOAL_EXPECTED
       2. + value UNSUPPORTED_GRP_SETTING
       3. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS
       4. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL
    5. ≠ enum ThirdPartyReachIntegrationPartner
       1. + value KANTAR_MILLWARD_BROWN
    6. ≠ enum ThirdPartyViewabilityIntegrationPartner
       1. + value COMSCORE
       2. + value TELEMETRY
       3. + value MEETRICS
    7. ≠ enum UnitType
       1. + value IN_TARGET_IMPRESSIONS
27. ≠ LineItemTemplateService (0 new, 2 changed, 0 removed)
    1. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
    2. ≠ enum GrpSettingsError.Reason
       1. + value DEMOG_GOAL_EXPECTED
       2. + value UNSUPPORTED_GRP_SETTING
       3. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS
       4. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL
28. ≠ LiveStreamEventService (7 new, 7 changed, 0 removed)
    1. + type Slate
    2. + enum SlateStatus
    3. + enum TranscodeStatus
    4. + operation createSlates
    5. + operation getSlatesByStatement
    6. + operation performSlateAction
    7. + operation updateSlates
    8. ≠ enum LiveStreamEventSlateError.Reason
       1. + value MISSING_SOURCE_FOR_SLATE
       2. + value INVALID_SLATE_TYPE
       3. + value CANNOT_CHANGE_SLATE_VIDEO_SOURCE_URL
    9. ≠ type Slate
       1. + field status
       2. + field transcodeStatus
    10. ≠ type SlatePage
        1. + field results
    11. ≠ operation createSlates
        1. + response rval
        2. + parameter slates
    12. ≠ operation getSlatesByStatement
        1. + response rval
        2. + parameter statement
    13. ≠ operation performSlateAction
        1. + parameter filterStatement
        2. + response rval
        3. + parameter slateAction
    14. ≠ operation updateSlates
        1. + response rval
        2. + parameter slates
29. = MobileApplicationService (no changes)
30. = NativeStyleService (no changes)
31. ≠ NetworkService (0 new, 2 changed, 0 removed)
    1. ≠ enum LiveStreamEventSlateError.Reason
       1. + value MISSING_SOURCE_FOR_SLATE
       2. + value INVALID_SLATE_TYPE
       3. + value CANNOT_CHANGE_SLATE_VIDEO_SOURCE_URL
    2. ≠ enum NetworkError.Reason
       1. + value CHILD_NETWORK_CANNOT_BE_DISAPPROVED
32. ≠ OrderService (0 new, 2 changed, 0 removed)
    1. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
    2. ≠ enum GrpSettingsError.Reason
       1. + value DEMOG_GOAL_EXPECTED
       2. + value UNSUPPORTED_GRP_SETTING
       3. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_GRP_SETTINGS
       4. + value SHOULD_SET_IN_TARGET_GOAL_THROUGH_PRIMARY_GOAL
33. = PlacementService (no changes)
34. ≠ ProposalLineItemService (0 new, 4 changed, 0 removed)
    1. ≠ enum RateType
       1. + value CPM_IN_TARGET
    2. ≠ enum ThirdPartyReachIntegrationPartner
       1. + value KANTAR_MILLWARD_BROWN
    3. ≠ enum ThirdPartyViewabilityIntegrationPartner
       1. + value COMSCORE
       2. + value TELEMETRY
       3. + value MEETRICS
    4. ≠ enum UnitType
       1. + value IN_TARGET_IMPRESSIONS
35. ≠ ProposalService (0 new, 1 changed, 0 removed)
    1. ≠ type Proposal
       1. + field pausingConsented
36. ≠ PublisherQueryLanguageService (0 new, 1 changed, 0 removed)
    1. ≠ enum CreativeError.Reason
       1. + value HOSTED_VIDEO_CREATIVE_REQUIRES_VIDEO_ASSET
37. ≠ ReportService (0 new, 1 changed, 0 removed)
    1. ≠ enum Dimension
       1. + value INVENTORY_SHARE_ASSIGNMENT_ID
       2. + value INVENTORY_SHARE_ASSIGNMENT_NAME
       3. + value INVENTORY_SHARE_OUTCOME
38. ≠ SiteService (1 new, 2 changed, 0 removed)
    1. + type DisapprovalReason
    2. ≠ type Site
       1. + field disapprovalReasons
    3. ≠ enum SiteError.Reason
       1. + value MULTIPLE_UPDATES_FOR_SAME_SITE
39. ≠ StreamActivityMonitorService (0 new, 1 changed, 0 removed)
    1. ≠ enum SamErrorType
       1. + value DUPLICATE_AD_TAG
       2. + value FOLLOW_REDIRECTS_IS_FALSE
40. = SuggestedAdUnitService (no changes)
41. = TargetingPresetService (no changes)
42. = TargetingService (no changes)
43. = TeamService (no changes)
44. = UserService (no changes)
45. = UserTeamAssociationService (no changes)

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)