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: v202208
• Previous versions: v202205, v202202, v202111, v202108, v202105

v202208

What's New

Creatives

• Added support for AMP URLs on ThirdPartyCreative.

Forecasting

• Added support for InventorySizeTargeting in traffic forecasts.

Reporting

• Added support for Real-time video reports.
• Added support for CHILD_PARTNER_NAME dimension attribute.
• Added EXCHANGE_BIDDING_DEAL_TYPE and EXCHANGE_BIDDING_DEAL_ID dimensions.
• Added AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS and AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS metrics.

API Changes

1. = ActivityGroupService (no changes)
2. = ActivityService (no changes)
3. ≠ AdRuleService (1 new, 1 changed, 0 removed)
   1. + type InventorySizeTargeting
   2. ≠ type Targeting
      1. + field inventorySizeTargeting
4. ≠ AdjustmentService (1 new, 1 changed, 0 removed)
   1. + type InventorySizeTargeting
   2. ≠ type Targeting
      1. + field inventorySizeTargeting
5. ≠ AudienceSegmentService (0 new, 2 changed, 0 removed)
   1. ≠ enum AudienceSegment.Status
      1. + value UNKNOWN
   2. ≠ enum AudienceSegmentError.Reason
      1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
6. = CdnConfigurationService (no changes)
7. = CmsMetadataService (no changes)
8. = CompanyService (no changes)
9. = ContactService (no changes)
10. = ContentBundleService (no changes)
11. = ContentService (no changes)
12. = CreativeReviewService (no changes)
13. ≠ CreativeService (0 new, 2 changed, 0 removed)
    1. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
    2. ≠ type ThirdPartyCreative
       1. + field ampRedirectUrl
14. ≠ CreativeSetService (0 new, 1 changed, 0 removed)
    1. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
15. = CreativeTemplateService (no changes)
16. = CreativeWrapperService (no changes)
17. = CustomFieldService (no changes)
18. ≠ CustomTargetingService (0 new, 1 changed, 1 removed)
    1. ≠ type CustomTargetingKey
       1. − field valueDeclarationType
    2. − enum ValueDeclarationType
19. = DaiAuthenticationKeyService (no changes)
20. = DaiEncodingProfileService (no changes)
21. ≠ ForecastService (1 new, 6 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    3. ≠ enum GrpSettingsError.Reason
       1. + value UNDER_18_MIN_AGE_REQUIRES_ALL_AGES
    4. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
    5. ≠ type LineItemSummary
       1. + field youtubeKidsRestricted
    6. ≠ type Targeting
       1. + field inventorySizeTargeting
    7. ≠ enum ThirdPartyReachIntegrationPartner
       1. + value VIDEO_RESEARCH
       2. + value GEMIUS
22. = InventoryService (no changes)
23. = LabelService (no changes)
24. ≠ LineItemCreativeAssociationService (0 new, 1 changed, 0 removed)
    1. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
25. ≠ LineItemService (1 new, 6 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    3. ≠ enum GrpSettingsError.Reason
       1. + value UNDER_18_MIN_AGE_REQUIRES_ALL_AGES
    4. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
    5. ≠ type LineItemSummary
       1. + field youtubeKidsRestricted
    6. ≠ type Targeting
       1. + field inventorySizeTargeting
    7. ≠ enum ThirdPartyReachIntegrationPartner
       1. + value VIDEO_RESEARCH
       2. + value GEMIUS
26. ≠ LineItemTemplateService (0 new, 3 changed, 0 removed)
    1. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    2. ≠ enum GrpSettingsError.Reason
       1. + value UNDER_18_MIN_AGE_REQUIRES_ALL_AGES
    3. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
27. = LiveStreamEventService (no changes)
28. = MobileApplicationService (no changes)
29. ≠ NativeStyleService (1 new, 2 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
    3. ≠ type Targeting
       1. + field inventorySizeTargeting
30. = NetworkService (no changes)
31. ≠ OrderService (0 new, 3 changed, 0 removed)
    1. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    2. ≠ enum GrpSettingsError.Reason
       1. + value UNDER_18_MIN_AGE_REQUIRES_ALL_AGES
    3. ≠ enum ImageError.Reason
       1. + value PREVERIFIED_MIMETYPE_NOT_ALLOWED
32. = PlacementService (no changes)
33. ≠ ProposalLineItemService (1 new, 5 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    3. ≠ enum GrpSettingsError.Reason
       1. + value UNDER_18_MIN_AGE_REQUIRES_ALL_AGES
    4. ≠ enum ProposalLineItemActionError.Reason
       1. + value CANNOT_ARCHIVE_ONGOING_PROPOSAL_LINE_ITEM
    5. ≠ type Targeting
       1. + field inventorySizeTargeting
    6. ≠ enum ThirdPartyReachIntegrationPartner
       1. + value VIDEO_RESEARCH
       2. + value GEMIUS
34. ≠ ProposalService (1 new, 2 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    3. ≠ type Targeting
       1. + field inventorySizeTargeting
35. ≠ PublisherQueryLanguageService (1 new, 2 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ enum AudienceSegmentError.Reason
       1. + value SHARED_SELLING_PARTNER_ROOT_CANNOT_BE_INCLUDED
    3. ≠ type Targeting
       1. + field inventorySizeTargeting
36. ≠ ReportService (0 new, 3 changed, 0 removed)
    1. ≠ enum Column
       1. + value AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS
       2. + value AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS
       3. + value PARTNER_SALES_PARTNER_IMPRESSIONS
       4. + value PARTNER_SALES_PARTNER_CODE_SERVED
       5. + value PARTNER_SALES_GOOGLE_IMPRESSIONS
       6. + value PARTNER_SALES_GOOGLE_RESERVATION_IMPRESSIONS
       7. + value PARTNER_SALES_GOOGLE_AUCTION_IMPRESSIONS
       8. + value PARTNER_SALES_QUERIES
       9. + value PARTNER_SALES_FILLED_QUERIES
       10. + value PARTNER_SALES_SELL_THROUGH_RATE
       11. + value VIDEO_IMPRESSIONS_REAL_TIME
       12. + value VIDEO_MATCHED_QUERIES_REAL_TIME
       13. + value VIDEO_UNMATCHED_QUERIES_REAL_TIME
       14. + value VIDEO_TOTAL_QUERIES_REAL_TIME
       15. + value VIDEO_CREATIVE_SERVE_REAL_TIME
       16. + value VIDEO_VAST3_ERROR_100_COUNT_REAL_TIME
       17. + value VIDEO_VAST3_ERROR_101_COUNT_REAL_TIME
       18. + value VIDEO_VAST3_ERROR_102_COUNT_REAL_TIME
       19. + value VIDEO_VAST3_ERROR_200_COUNT_REAL_TIME
       20. + value VIDEO_VAST3_ERROR_201_COUNT_REAL_TIME
       21. + value VIDEO_VAST3_ERROR_202_COUNT_REAL_TIME
       22. + value VIDEO_VAST3_ERROR_203_COUNT_REAL_TIME
       23. + value VIDEO_VAST3_ERROR_300_COUNT_REAL_TIME
       24. + value VIDEO_VAST3_ERROR_301_COUNT_REAL_TIME
       25. + value VIDEO_VAST3_ERROR_302_COUNT_REAL_TIME
       26. + value VIDEO_VAST3_ERROR_303_COUNT_REAL_TIME
       27. + value VIDEO_VAST3_ERROR_400_COUNT_REAL_TIME
       28. + value VIDEO_VAST3_ERROR_401_COUNT_REAL_TIME
       29. + value VIDEO_VAST3_ERROR_402_COUNT_REAL_TIME
       30. + value VIDEO_VAST3_ERROR_403_COUNT_REAL_TIME
       31. + value VIDEO_VAST3_ERROR_405_COUNT_REAL_TIME
       32. + value VIDEO_VAST3_ERROR_500_COUNT_REAL_TIME
       33. + value VIDEO_VAST3_ERROR_501_COUNT_REAL_TIME
       34. + value VIDEO_VAST3_ERROR_502_COUNT_REAL_TIME
       35. + value VIDEO_VAST3_ERROR_503_COUNT_REAL_TIME
       36. + value VIDEO_VAST3_ERROR_600_COUNT_REAL_TIME
       37. + value VIDEO_VAST3_ERROR_601_COUNT_REAL_TIME
       38. + value VIDEO_VAST3_ERROR_602_COUNT_REAL_TIME
       39. + value VIDEO_VAST3_ERROR_603_COUNT_REAL_TIME
       40. + value VIDEO_VAST3_ERROR_604_COUNT_REAL_TIME
       41. + value VIDEO_VAST3_ERROR_900_COUNT_REAL_TIME
       42. + value VIDEO_VAST3_ERROR_901_COUNT_REAL_TIME
       43. + value VIDEO_VAST4_ERROR_406_COUNT_REAL_TIME
       44. + value VIDEO_VAST4_ERROR_407_COUNT_REAL_TIME
       45. + value VIDEO_VAST4_ERROR_408_COUNT_REAL_TIME
       46. + value VIDEO_VAST4_ERROR_409_COUNT_REAL_TIME
       47. + value VIDEO_VAST4_ERROR_410_COUNT_REAL_TIME
       48. + value VIDEO_VAST_TOTAL_ERROR_COUNT_REAL_TIME
    2. ≠ enum Dimension
       1. + value EXCHANGE_BIDDING_DEAL_ID
       2. + value EXCHANGE_BIDDING_DEAL_TYPE
    3. ≠ enum DimensionAttribute
       1. + value CHILD_PARTNER_NAME
37. = SiteService (no changes)
38. ≠ StreamActivityMonitorService (0 new, 1 changed, 0 removed)
    1. ≠ enum SamErrorType
       1. + value AD_POD_DROPPED_INCOMPATIBLE_TIMEOFFSET
39. = SuggestedAdUnitService (no changes)
40. ≠ TargetingPresetService (1 new, 1 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ type Targeting
       1. + field inventorySizeTargeting
41. = TeamService (no changes)
42. = UserService (no changes)
43. = UserTeamAssociationService (no changes)
44. ≠ YieldGroupService (1 new, 3 changed, 0 removed)
    1. + type InventorySizeTargeting
    2. ≠ type Targeting
       1. + field inventorySizeTargeting
    3. ≠ enum YieldEntityStatus
       1. + value EXPERIMENTING
    4. ≠ enum YieldError.Reason
       1. + value UNSUPPORTED_COMPANY_INTEGRATION_TYPE
       2. + value DUPLICATE_HEADER_BIDDER
       3. + value INVALID_AD_SOURCE_STATUS
       4. + value INVALID_SDK_ADAPTER_KEY_NAME

v202205

What's New

Programmatic

• Added support for impression limits on Sponsorship CPM campaigns.

Reporting

• Updated Dimensions and Columns for the "Ad Exchange Historical" to "Historical" report type conversion. Ad Exchange Historical dimensions and metrics are now available for Historical reports. To migrate, please refer to the migration guide.

API Changes

1. = ActivityGroupService (no changes)
2. = ActivityService (no changes)
3. = AdRuleService (no changes)
4. = AdjustmentService (no changes)
5. ≠ AudienceSegmentService (0 new, 1 changed, 0 removed)
   1. ≠ enum AudienceSegment.Status
      1. + value UNUSED
6. = CdnConfigurationService (no changes)
7. = CmsMetadataService (no changes)
8. ≠ CompanyService (4 new, 2 changed, 0 removed)
   1. + type ExchangeSignupApiError
   2. + enum ExchangeSignupApiError.Reason
   3. + type InventoryClientApiError
   4. + enum InventoryClientApiError.Reason
   5. ≠ type ExchangeSignupApiError
      1. + field reason
   6. ≠ type InventoryClientApiError
      1. + field reason
9. = ContactService (no changes)
10. = ContentBundleService (no changes)
11. = ContentService (no changes)
12. = CreativeReviewService (no changes)
13. ≠ CreativeService (2 new, 1 changed, 0 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ type TranscodingError
       1. + field reason
14. ≠ CreativeSetService (2 new, 1 changed, 0 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ type TranscodingError
       1. + field reason
15. = CreativeTemplateService (no changes)
16. = CreativeWrapperService (no changes)
17. = CustomFieldService (no changes)
18. = CustomTargetingService (no changes)
19. = DaiAuthenticationKeyService (no changes)
20. = DaiEncodingProfileService (no changes)
21. ≠ ForecastService (2 new, 3 changed, 1 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ enum GrpSettingsError.Reason
       1. + value NIELSEN_REGISTRATION_FAILED
       2. + value LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT
    4. ≠ type ProposalLineItem
       1. + field secondaryGoals
       2. − field marketplaceInfo
    5. ≠ type TranscodingError
       1. + field reason
    6. − type ProposalLineItemMarketplaceInfo
22. = InventoryService (no changes)
23. = LabelService (no changes)
24. ≠ LineItemCreativeAssociationService (2 new, 1 changed, 0 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ type TranscodingError
       1. + field reason
25. ≠ LineItemService (2 new, 2 changed, 0 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ enum GrpSettingsError.Reason
       1. + value NIELSEN_REGISTRATION_FAILED
       2. + value LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT
    4. ≠ type TranscodingError
       1. + field reason
26. ≠ LineItemTemplateService (2 new, 2 changed, 0 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ enum GrpSettingsError.Reason
       1. + value NIELSEN_REGISTRATION_FAILED
       2. + value LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT
    4. ≠ type TranscodingError
       1. + field reason
27. = LiveStreamEventService (no changes)
28. = MobileApplicationService (no changes)
29. = NativeStyleService (no changes)
30. ≠ NetworkService (4 new, 2 changed, 0 removed)
    1. + type ExchangeSignupApiError
    2. + enum ExchangeSignupApiError.Reason
    3. + type InventoryClientApiError
    4. + enum InventoryClientApiError.Reason
    5. ≠ type ExchangeSignupApiError
       1. + field reason
    6. ≠ type InventoryClientApiError
       1. + field reason
31. ≠ OrderService (2 new, 2 changed, 0 removed)
    1. + type TranscodingError
    2. + enum TranscodingError.Reason
    3. ≠ enum GrpSettingsError.Reason
       1. + value NIELSEN_REGISTRATION_FAILED
       2. + value LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT
    4. ≠ type TranscodingError
       1. + field reason
32. = PlacementService (no changes)
33. ≠ ProposalLineItemService (0 new, 3 changed, 1 removed)
    1. ≠ enum GrpSettingsError.Reason
       1. + value NIELSEN_REGISTRATION_FAILED
       2. + value LEGACY_NIELSEN_CAMPAIGN_REGISTRATION_ATTEMPT
    2. ≠ type ProposalLineItem
       1. + field secondaryGoals
       2. − field marketplaceInfo
    3. ≠ enum ProposalLineItemProgrammaticError.Reason
       1. + value INVALID_ENVIRONMENT_PLATFORM_TYPE_PAIR
    4. − type ProposalLineItemMarketplaceInfo
34. ≠ ProposalService (0 new, 2 changed, 0 removed)
    1. ≠ enum ProposalLineItemProgrammaticError.Reason
       1. + value INVALID_ENVIRONMENT_PLATFORM_TYPE_PAIR
    2. ≠ type SalespersonSplit
       1. − field split
35. = PublisherQueryLanguageService (no changes)
36. ≠ ReportService (0 new, 3 changed, 1 removed)
    1. ≠ enum Column
       1. + value DROPOFF_RATE
       2. + value VIDEO_TRUEVIEW_VIEWS
       3. + value VIDEO_TRUEVIEW_SKIP_RATE
       4. + value VIDEO_TRUEVIEW_VTR
       5. + value AD_EXCHANGE_TOTAL_REQUESTS
       6. + value AD_EXCHANGE_MATCH_RATE
       7. + value AD_EXCHANGE_COST_PER_CLICK
       8. + value AD_EXCHANGE_TOTAL_REQUEST_CTR
       9. + value AD_EXCHANGE_MATCHED_REQUEST_CTR
       10. + value AD_EXCHANGE_TOTAL_REQUEST_ECPM
       11. + value AD_EXCHANGE_MATCHED_REQUEST_ECPM
       12. + value AD_EXCHANGE_LIFT_EARNINGS
       13. − value AD_SERVER_CPM_AND_CPC_REVENUE_GROSS
       14. − value AD_SERVER_ALL_REVENUE_GROSS
       15. − value AD_EXCHANGE_AD_IMPRESSIONS_ADJUSTED
       16. − value AD_EXCHANGE_MATCHED_QUERIES
       17. − value AD_EXCHANGE_AD_ECPM
       18. − value AD_EXCHANGE_CLICKS
       19. − value AD_EXCHANGE_ESTIMATED_REVENUE
       20. − value AD_EXCHANGE_COVERAGE
       21. − value AD_EXCHANGE_MATCHED_QUERIES_CTR
       22. − value AD_EXCHANGE_LIFT
       23. − value AD_EXCHANGE_CPC_REVENUE
       24. − value AD_EXCHANGE_REQUESTS
       25. − value AD_EXCHANGE_REQUEST_ECPM
       26. − value AD_EXCHANGE_REQUEST_CTR
       27. − value AD_EXCHANGE_CTR
       28. − value AD_EXCHANGE_VIDEO_DROPOFF_RATE_ADX_QT
       29. − value AD_EXCHANGE_VIDEO_ABANDONMENT_RATE_ADX_QT
       30. − value AD_EXCHANGE_ECPM
       31. − value AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE
       32. − value AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE
       33. − value AD_EXCHANGE_AVERAGE_VIEWABLE_TIME
       34. − value AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS
       35. − value AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS
       36. − value AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS
       37. − value AD_EXCHANGE_DEALS_BID_RESPONSES
       38. − value AD_EXCHANGE_DEALS_MATCHED_REQUESTS
       39. − value AD_EXCHANGE_DEALS_AD_REQUESTS
       40. − value AD_EXCHANGE_DEALS_MATCH_RATE
       41. − value AD_EXCHANGE_VIDEO_AUTO_PLAY
       42. − value AD_EXCHANGE_VIDEO_CLICK_TO_PLAY
       43. − value AD_EXCHANGE_VIDEO_START
       44. − value AD_EXCHANGE_VIDEO_QUARTILE_1
       45. − value AD_EXCHANGE_VIDEO_MIDPOINT
       46. − value AD_EXCHANGE_VIDEO_QUARTILE_3
       47. − value AD_EXCHANGE_VIDEO_COMPLETE
       48. − value AD_EXCHANGE_VIDEO_COMPLETION_RATE
       49. − value AD_EXCHANGE_VIDEO_COLLAPSE
       50. − value AD_EXCHANGE_VIDEO_EXPAND
       51. − value AD_EXCHANGE_VIDEO_FULL_SCREEN
       52. − value AD_EXCHANGE_VIDEO_MUTE
       53. − value AD_EXCHANGE_VIDEO_PAUSE
       54. − value AD_EXCHANGE_VIDEO_RESUME
       55. − value AD_EXCHANGE_VIDEO_REWIND
       56. − value AD_EXCHANGE_VIDEO_SKIPPED
       57. − value AD_EXCHANGE_VIDEO_UNMUTE
       58. − value AD_EXCHANGE_VIDEO_VAST2_ERROR_COUNT
       59. − value AD_EXCHANGE_VIDEO_VAST_ERROR_100_COUNT
       60. − value AD_EXCHANGE_VIDEO_VAST_ERROR_101_COUNT
       61. − value AD_EXCHANGE_VIDEO_VAST_ERROR_102_COUNT
       62. − value AD_EXCHANGE_VIDEO_VAST_ERROR_200_COUNT
       63. − value AD_EXCHANGE_VIDEO_VAST_ERROR_201_COUNT
       64. − value AD_EXCHANGE_VIDEO_VAST_ERROR_202_COUNT
       65. − value AD_EXCHANGE_VIDEO_VAST_ERROR_203_COUNT
       66. − value AD_EXCHANGE_VIDEO_VAST_ERROR_300_COUNT
       67. − value AD_EXCHANGE_VIDEO_VAST_ERROR_301_COUNT
       68. − value AD_EXCHANGE_VIDEO_VAST_ERROR_302_COUNT
       69. − value AD_EXCHANGE_VIDEO_VAST_ERROR_303_COUNT
       70. − value AD_EXCHANGE_VIDEO_VAST_ERROR_400_COUNT
       71. − value AD_EXCHANGE_VIDEO_VAST_ERROR_401_COUNT
       72. − value AD_EXCHANGE_VIDEO_VAST_ERROR_402_COUNT
       73. − value AD_EXCHANGE_VIDEO_VAST_ERROR_403_COUNT
       74. − value AD_EXCHANGE_VIDEO_VAST_ERROR_405_COUNT
       75. − value AD_EXCHANGE_VIDEO_VAST_ERROR_500_COUNT
       76. − value AD_EXCHANGE_VIDEO_VAST_ERROR_501_COUNT
       77. − value AD_EXCHANGE_VIDEO_VAST_ERROR_502_COUNT
       78. − value AD_EXCHANGE_VIDEO_VAST_ERROR_503_COUNT
       79. − value AD_EXCHANGE_VIDEO_VAST_ERROR_600_COUNT
       80. − value AD_EXCHANGE_VIDEO_VAST_ERROR_601_COUNT
       81. − value AD_EXCHANGE_VIDEO_VAST_ERROR_602_COUNT
       82. − value AD_EXCHANGE_VIDEO_VAST_ERROR_603_COUNT
       83. − value AD_EXCHANGE_VIDEO_VAST_ERROR_604_COUNT
       84. − value AD_EXCHANGE_VIDEO_VAST_ERROR_900_COUNT
       85. − value AD_EXCHANGE_VIDEO_VAST_ERROR_901_COUNT
       86. − value AD_EXCHANGE_VIDEO_TOTAL_VAST_ERROR_COUNT
       87. − value AD_EXCHANGE_VIDEO_TOTAL_ERROR_RATE
       88. − value AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE
       89. − value AD_EXCHANGE_VIDEO_TRUEVIEWS
       90. − value AD_EXCHANGE_VIDEO_VTR
    2. ≠ enum Dimension
       1. + value COUNTRY_CODE
       2. + value OPERATING_SYSTEM_VERSION_ID
       3. + value OPERATING_SYSTEM_VERSION_NAME
       4. + value WEB_PROPERTY_CODE
       5. + value BUYING_AGENCY_NAME
       6. + value BUYER_NETWORK_ID
       7. + value BUYER_NETWORK_NAME
       8. + value BIDDER_ID
       9. + value BIDDER_NAME
       10. + value ADVERTISER_DOMAIN_NAME
       11. + value ADVERTISER_VERTICAL_NAME
       12. + value FIRST_LOOK_PRICING_RULE_ID
       13. + value FIRST_LOOK_PRICING_RULE_NAME
       14. + value DEAL_ID
       15. + value DEAL_NAME
       16. + value SITE_NAME
       17. + value CHANNEL_NAME
       18. + value URL_ID
       19. + value URL_NAME
       20. + value VIDEO_AD_DURATION
       21. + value VIDEO_AD_TYPE_ID
       22. + value VIDEO_AD_TYPE_NAME
       23. + value ADX_PRODUCT_CODE
       24. + value ADX_PRODUCT_NAME
       25. + value DYNAMIC_ALLOCATION_ID
       26. + value DYNAMIC_ALLOCATION_NAME
       27. + value AD_TYPE_ID
       28. + value AD_TYPE_NAME
       29. + value AD_LOCATION_ID
       30. + value AD_LOCATION_NAME
       31. + value TARGETING_TYPE_CODE
       32. + value TARGETING_TYPE_NAME
       33. + value BRANDING_TYPE_CODE
       34. + value BRANDING_TYPE_NAME
       35. + value INVENTORY_OWNERSHIP_CODE
       36. + value INVENTORY_OWNERSHIP_NAME
       37. + value NETWORK_PARTNER_ID
       38. + value NETWORK_PARTNER_NAME
       39. + value BANDWIDTH_ID
       40. + value BANDWIDTH_NAME
       41. + value CARRIER_ID
       42. + value CARRIER_NAME
       43. − value AD_EXCHANGE_AD_SIZE_NAME
       44. − value AD_EXCHANGE_INVENTORY_SIZE_CODE
       45. − value AD_EXCHANGE_PLATFORM_TYPE_NAME
       46. − value AD_EXCHANGE_PRICING_RULE_ID
       47. − value AD_EXCHANGE_PRICING_RULE_NAME
       48. − value AD_EXCHANGE_TAG_NAME
       49. − value AD_EXCHANGE_URL_CHANNEL_NAME
       50. − value AD_EXCHANGE_AD_CLIENT_ID
       51. − value AD_EXCHANGE_CREATIVE_SIZES
       52. − value AD_EXCHANGE_AD_FORMAT_NAME
       53. − value AD_EXCHANGE_CHANNEL_NAME
       54. − value AD_EXCHANGE_PRODUCT_NAME
       55. − value AD_EXCHANGE_PRODUCT_CODE
       56. − value AD_EXCHANGE_SITE_NAME
       57. − value AD_EXCHANGE_REQUEST_SOURCES
       58. − value AD_EXCHANGE_ADVERTISER_NAME
       59. − value AD_EXCHANGE_BRAND_NAME
       60. − value AD_EXCHANGE_AGENCY
       61. − value AD_EXCHANGE_BID_TYPE_CODE
       62. − value AD_EXCHANGE_BRANDING_TYPE
       63. − value AD_EXCHANGE_BRANDING_TYPE_LOCAL
       64. − value AD_EXCHANGE_BUYER_NETWORK_NAME
       65. − value AD_EXCHANGE_BUYER_NETWORK_ID
       66. − value AD_EXCHANGE_CUSTOM_CHANNEL_CODE
       67. − value AD_EXCHANGE_CUSTOM_CHANNEL_ID
       68. − value AD_EXCHANGE_DATE
       69. − value AD_EXCHANGE_DEAL_ID
       70. − value AD_EXCHANGE_DEAL_NAME
       71. − value AD_EXCHANGE_DEAL_TYPE
       72. − value AD_EXCHANGE_DSP_BUYER_NETWORK_NAME
       73. − value AD_EXCHANGE_EXPANSION_TYPE
       74. − value AD_EXCHANGE_COUNTRY_CODE
       75. − value AD_EXCHANGE_COUNTRY_NAME
       76. − value AD_EXCHANGE_DFP_AD_UNIT_ID
       77. − value AD_EXCHANGE_DFP_AD_UNIT
       78. − value AD_EXCHANGE_INVENTORY_OWNERSHIP
       79. − value AD_EXCHANGE_LANDING_PAGE_DOMAIN
       80. − value AD_EXCHANGE_DFP_MOBILE_APP_NAME
       81. − value AD_EXCHANGE_MOBILE_APP_RESOLVED_ID
       82. − value AD_EXCHANGE_MOBILE_CARRIER_NAME
       83. − value AD_EXCHANGE_MOBILE_DEVICE_NAME
       84. − value AD_EXCHANGE_MOBILE_INVENTORY_TYPE
       85. − value AD_EXCHANGE_MONTH
       86. − value AD_EXCHANGE_NETWORK_PARTNER_NAME
       87. − value AD_EXCHANGE_OS_VERSION_NAME
       88. − value AD_EXCHANGE_TAG_CODE
       89. − value AD_EXCHANGE_TARGETING_TYPE
       90. − value AD_EXCHANGE_TARGETING_TYPE_LOCAL
       91. − value AD_EXCHANGE_TRANSACTION_TYPE_CODE
       92. − value AD_EXCHANGE_URL_CHANNEL_ID
       93. − value AD_EXCHANGE_USER_BANDWIDTH_NAME
       94. − value AD_EXCHANGE_VIDEO_AD_DURATION
       95. − value AD_EXCHANGE_VIDEO_AD_DURATION_RAW
       96. − value AD_EXCHANGE_VIDEO_AD_FORMAT
       97. − value AD_EXCHANGE_WEEK
       98. − value AD_EXCHANGE_AD_LOCATION
       99. − value AD_EXCHANGE_ADVERTISER_VERTICAL
    3. ≠ type ReportQuery
       1. − field timeZoneType
    4. − enum TimeZoneSelection
37. = SiteService (no changes)
38. = StreamActivityMonitorService (no changes)
39. = SuggestedAdUnitService (no changes)
40. = TargetingPresetService (no changes)
41. = TeamService (no changes)
42. = UserService (no changes)
43. = UserTeamAssociationService (no changes)
44. = YieldGroupService (no changes)

v202202

What's New

Video

• Added support for creating VideoCreative objects.
• Removed ExcludeContentInContentBundle action.

Multiple Customer Management

• Added support for sellers.json sellerId field in both CompanyService.ChildPublisher and the child_publisher PQL table.
• Added support for ChildPublisher onboarding tasks.

Proposals

• Removed deprecated pauseRole and pauseReason fields.
• Removed deprecated exchangeRate and refreshExchangeRate fields.

Protections

• Removed the deprecated AdExclusionRuleService.

Reporting

• Added support for SERVING_RESTRICTION_* dimensions.

  API Changes

  1. + YieldGroupService
  2. = ActivityGroupService (no changes)
  3. = ActivityService (no changes)
  4. ≠ AdExclusionRuleService (0 new, 36 changed, 71 removed)
     1. ≠ type AdExclusionRule
        1. − field inventoryTargeting
        2. − field type
     2. ≠ type AdExclusionRuleError
        1. − field reason
     3. ≠ type AdExclusionRulePage
        1. − field results
     4. ≠ type ApiError
        1. − field fieldPathElements
     5. ≠ type ApiException
        1. − field errors
     6. ≠ type ApiVersionError
        1. − field reason
     7. ≠ type AuthenticationError
        1. − field reason
     8. ≠ type CollectionSizeError
        1. − field reason
     9. ≠ type CommonError
        1. − field reason
     10. ≠ type DateTime
         1. − field date
     11. ≠ type DateTimeValue
         1. − field value
     12. ≠ type DateValue
         1. − field value
     13. ≠ type EntityChildrenLimitReachedError
         1. − field reason
     14. ≠ type EntityLimitReachedError
         1. − field reason
     15. ≠ type FeatureError
         1. − field reason
     16. ≠ type InternalApiError
         1. − field reason
     17. ≠ type InventoryTargeting
         1. − field excludedAdUnits
         2. − field targetedAdUnits
     18. ≠ type LocalizedErrorWrapper
         1. − field wrapped
     19. ≠ type NotNullError
         1. − field reason
     20. ≠ type ParseError
         1. − field reason
     21. ≠ type PermissionError
         1. − field reason
     22. ≠ type PublisherQueryLanguageContextError
         1. − field reason
     23. ≠ type PublisherQueryLanguageSyntaxError
         1. − field reason
     24. ≠ type QuotaError
         1. − field reason
     25. ≠ type RequiredCollectionError
         1. − field reason
     26. ≠ type RequiredError
         1. − field reason
     27. ≠ type ServerError
         1. − field reason
     28. ≠ type SetValue
         1. − field values
     29. ≠ type StatementError
         1. − field reason
     30. ≠ type StringFormatError
         1. − field reason
     31. ≠ type StringLengthError
         1. − field reason
     32. ≠ type String_ValueMapEntry
         1. − field value
     33. ≠ operation createAdExclusionRules
         1. − parameter adExclusionRules
         2. − response rval
     34. ≠ operation getAdExclusionRulesByStatement
         1. − parameter filterStatement
         2. − response rval
     35. ≠ operation performAdExclusionRuleAction
         1. − parameter adExclusionRuleAction
         2. − parameter filterStatement
         3. − response rval
     36. ≠ operation updateAdExclusionRules
         1. − parameter adExclusionRules
         2. − response rval
     37. − type ActivateAdExclusionRules
     38. − type AdExclusionRule
     39. − type AdExclusionRuleAction
     40. − type AdExclusionRuleError
     41. − enum AdExclusionRuleError.Reason
     42. − type AdExclusionRulePage
     43. − enum AdExclusionRuleType
     44. − type AdUnitTargeting
     45. − type ApiError
     46. − type ApiException
     47. − type ApiVersionError
     48. − enum ApiVersionError.Reason
     49. − type ApplicationException
     50. − type AuthenticationError
     51. − enum AuthenticationError.Reason
     52. − type BooleanValue
     53. − type CollectionSizeError
     54. − enum CollectionSizeError.Reason
     55. − type CommonError
     56. − enum CommonError.Reason
     57. − type Date
     58. − type DateTime
     59. − type DateTimeValue
     60. − type DateValue
     61. − type DeactivateAdExclusionRules
     62. − type EntityChildrenLimitReachedError
     63. − enum EntityChildrenLimitReachedError.Reason
     64. − type EntityLimitReachedError
     65. − enum EntityLimitReachedError.Reason
     66. − type FeatureError
     67. − enum FeatureError.Reason
     68. − type FieldPathElement
     69. − type InternalApiError
     70. − enum InternalApiError.Reason
     71. − type InventoryTargeting
     72. − type NotNullError
     73. − enum NotNullError.Reason
     74. − type NumberValue
     75. − type ObjectValue
     76. − type ParseError
     77. − enum ParseError.Reason
     78. − type PermissionError
     79. − enum PermissionError.Reason
     80. − type PublisherQueryLanguageContextError
     81. − enum PublisherQueryLanguageContextError.Reason
     82. − type PublisherQueryLanguageSyntaxError
     83. − enum PublisherQueryLanguageSyntaxError.Reason
     84. − type QuotaError
     85. − enum QuotaError.Reason
     86. − type RequiredCollectionError
     87. − enum RequiredCollectionError.Reason
     88. − type RequiredError
     89. − enum RequiredError.Reason
     90. − type ServerError
     91. − enum ServerError.Reason
     92. − type SetValue
     93. − type Statement
     94. − type StatementError
     95. − enum StatementError.Reason
     96. − type StringFormatError
     97. − enum StringFormatError.Reason
     98. − type StringLengthError
     99. − enum StringLengthError.Reason
     100. − type TextValue
     101. − type UniqueError
     102. − type UpdateResult
     103. − type Value
     104. − operation createAdExclusionRules
     105. − operation getAdExclusionRulesByStatement
     106. − operation performAdExclusionRuleAction
     107. − operation updateAdExclusionRules
  5. ≠ AdRuleService (0 new, 1 changed, 0 removed)
     1. ≠ type Targeting
        1. + field inventoryUrlTargeting
  6. ≠ AdjustmentService (0 new, 1 changed, 0 removed)
     1. ≠ type Targeting
        1. + field inventoryUrlTargeting
  7. = AudienceSegmentService (no changes)
  8. = CdnConfigurationService (no changes)
  9. = CmsMetadataService (no changes)
  10. ≠ CompanyService (1 new, 3 changed, 0 removed)
      1. + enum OnboardingTask
      2. ≠ type ChildPublisher
         1. + field onboardingTasks
         2. + field sellerId
      3. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      4. ≠ type ReInviteAction
         1. + field proposedEmail
  11. = ContactService (no changes)
  12. ≠ ContentBundleService (0 new, 0 changed, 1 removed)
      1. − type ExcludeContentFromContentBundle
  13. = ContentService (no changes)
  14. = CreativeReviewService (no changes)
  15. ≠ CreativeService (0 new, 3 changed, 0 removed)
      1. ≠ type AudioCreative
         1. + field audioSourceUrl
      2. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      3. ≠ type VideoCreative
         1. + field videoSourceUrl
  16. ≠ CreativeSetService (0 new, 1 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
  17. = CreativeTemplateService (no changes)
  18. = CreativeWrapperService (no changes)
  19. = CustomFieldService (no changes)
  20. = CustomTargetingService (no changes)
  21. = DaiAuthenticationKeyService (no changes)
  22. = DaiEncodingProfileService (no changes)
  23. ≠ ForecastService (0 new, 3 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      2. ≠ enum LineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
         2. + value INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE
      3. ≠ type Targeting
         1. + field inventoryUrlTargeting
  24. ≠ InventoryService (0 new, 1 changed, 0 removed)
      1. ≠ type AdUnit
         1. + field applicationId
  25. = LabelService (no changes)
  26. ≠ LineItemCreativeAssociationService (0 new, 2 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      2. ≠ enum LineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
         2. + value INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE
  27. ≠ LineItemService (0 new, 3 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      2. ≠ enum LineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
         2. + value INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE
      3. ≠ type Targeting
         1. + field inventoryUrlTargeting
  28. ≠ LineItemTemplateService (0 new, 2 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      2. ≠ enum LineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
         2. + value INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE
  29. = LiveStreamEventService (no changes)
  30. = MobileApplicationService (no changes)
  31. ≠ NativeStyleService (0 new, 1 changed, 0 removed)
      1. ≠ type Targeting
         1. + field inventoryUrlTargeting
  32. ≠ NetworkService (1 new, 1 changed, 0 removed)
      1. + enum OnboardingTask
      2. ≠ type ChildPublisher
         1. + field onboardingTasks
         2. + field sellerId
  33. ≠ OrderService (0 new, 2 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      2. ≠ enum LineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
         2. + value INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE
  34. = PlacementService (no changes)
  35. ≠ ProposalLineItemService (2 new, 5 changed, 0 removed)
      1. + type GrpSettingsError
      2. + enum GrpSettingsError.Reason
      3. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      4. ≠ type GrpSettingsError
         1. + field reason
      5. ≠ enum LineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
         2. + value INVALID_TARGETED_REQUEST_PLATFORM_FOR_WEB_PROPERTY_CODE
      6. ≠ enum ProposalLineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
      7. ≠ type Targeting
         1. + field inventoryUrlTargeting
  36. ≠ ProposalService (0 new, 5 changed, 2 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
      2. ≠ type Proposal
         1. − field exchangeRate
         2. − field refreshExchangeRate
      3. ≠ enum ProposalLineItemError.Reason
         1. + value ALL_COMPANION_DELIVERY_NOT_ALLOWED
      4. ≠ type ProposalMarketplaceInfo
         1. − field pauseReason
         2. − field pausedBy
      5. ≠ type Targeting
         1. + field inventoryUrlTargeting
      6. − type RetractProposals
      7. − type SubmitProposalsForApproval
  37. ≠ PublisherQueryLanguageService (0 new, 1 changed, 0 removed)
      1. ≠ type Targeting
         1. + field inventoryUrlTargeting
  38. ≠ ReportService (0 new, 1 changed, 0 removed)
      1. ≠ enum Dimension
         1. + value SERVING_RESTRICTION_ID
         2. + value SERVING_RESTRICTION_NAME
  39. = SiteService (no changes)
  40. = StreamActivityMonitorService (no changes)
  41. = SuggestedAdUnitService (no changes)
  42. ≠ TargetingPresetService (0 new, 1 changed, 0 removed)
      1. ≠ type Targeting
         1. + field inventoryUrlTargeting
  43. = TeamService (no changes)
  44. ≠ UserService (0 new, 1 changed, 0 removed)
      1. ≠ enum CustomFieldValueError.Reason
         1. + value INVALID_ENTITY_TYPE
  45. = UserTeamAssociationService (no changes)

  v202111

  What's New

  Creative Wrappers

  • Added the creativeWrapperType field to enable managing new VIDEO_TRACKING_URL CreativeWrapper type. Existing CreativeWrapper objects will have a type of HTML.
  • Added videoTrackingUrls for tracking video interaction with third-party URLs. This field is required if the creativeWrapperType is VIDEO_TRACKING_URL, otherwise it's ignored.

  Multiple Customer Management

  • Added ResendInvitationAction which can be sent through the performCompanyAction method. For altering revenue share or re-inviting an inactive child publisher, continue to use the ReInviteAction.

  Proposal Line Items

  • Added grpSettings for specifying gross rating point (GRP) demographic information for a video line item that will have a target demographic when serving.

  Reporting

  • Added new video opportunity Column enum values:
    • TOTAL_VIDEO_MATCHED_OPPORTUNITIES
    • TOTAL_VIDEO_MATCHED_DURATION
    • TOTAL_VIDEO_DURATION
    • TOTAL_VIDEO_BREAK_START
    • TOTAL_VIDEO_BREAK_END

  Stream Activity Monitoring

  • Added googleVideoId to AdDecisionCreative.

  API Changes

  1. = ActivityGroupService (no changes)
  2. = ActivityService (no changes)
  3. = AdExclusionRuleService (no changes)
  4. = AdRuleService (no changes)
  5. ≠ AdjustmentService (0 new, 1 changed, 0 removed)
     1. ≠ enum DateTimeRangeTargetingError.Reason
        1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
        2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
  6. = AudienceSegmentService (no changes)
  7. = CdnConfigurationService (no changes)
  8. = CmsMetadataService (no changes)
  9. ≠ CompanyService (3 new, 3 changed, 0 removed)
     1. + type ResendInvitationAction
     2. + type SiteError
     3. + enum SiteError.Reason
     4. ≠ enum AccountStatus
        1. + value CLOSED_POLICY_VIOLATION
        2. + value CLOSED_INVALID_ACTIVITY
        3. + value CLOSED_BY_PUBLISHER
        4. + value DISAPPROVED_INELIGIBLE
        5. − value DISAPPROVED_POLICY_VIOLATION
     5. ≠ type SiteError
        1. + field reason
     6. ≠ enum SiteError.Reason
        1. + value CANNOT_ARCHIVE_SITE_WITH_SUBSITES
  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 (0 new, 2 changed, 0 removed)
      1. ≠ type CreativeWrapper
         1. + field creativeWrapperType
         2. + field videoTrackingUrls
      2. ≠ enum CreativeWrapperError.Reason
         1. + value NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED
         2. + value CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES
  18. = CustomFieldService (no changes)
  19. = CustomTargetingService (no changes)
  20. = DaiAuthenticationKeyService (no changes)
  21. = DaiEncodingProfileService (no changes)
  22. ≠ ForecastService (0 new, 4 changed, 0 removed)
      1. ≠ enum DateTimeRangeTargetingError.Reason
         1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
         2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
      2. ≠ enum GrpSettingsError.Reason
         1. + value NIELSEN_DAR_REQUIRES_INSTREAM_VIDEO
      3. ≠ enum LineItemError.Reason
         1. + value INVALID_NATIVE_SIZE
      4. ≠ type ProposalLineItem
         1. + field grpSettings
  23. ≠ InventoryService (0 new, 1 changed, 0 removed)
      1. ≠ enum CreativeWrapperError.Reason
         1. + value NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED
         2. + value CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES
  24. ≠ LabelService (0 new, 1 changed, 0 removed)
      1. ≠ enum CreativeWrapperError.Reason
         1. + value NEITHER_HEADER_NOR_FOOTER_NOR_VIDEO_TRACKING_URLS_SPECIFIED
         2. + value CANNOT_APPLY_TO_AD_UNIT_WITHOUT_VIDEO_SIZES
  25. ≠ LineItemCreativeAssociationService (0 new, 1 changed, 0 removed)
      1. ≠ enum LineItemError.Reason
         1. + value INVALID_NATIVE_SIZE
  26. ≠ LineItemService (0 new, 3 changed, 0 removed)
      1. ≠ enum DateTimeRangeTargetingError.Reason
         1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
         2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
      2. ≠ enum GrpSettingsError.Reason
         1. + value NIELSEN_DAR_REQUIRES_INSTREAM_VIDEO
      3. ≠ enum LineItemError.Reason
         1. + value INVALID_NATIVE_SIZE
  27. ≠ LineItemTemplateService (0 new, 3 changed, 0 removed)
      1. ≠ enum DateTimeRangeTargetingError.Reason
         1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
         2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
      2. ≠ enum GrpSettingsError.Reason
         1. + value NIELSEN_DAR_REQUIRES_INSTREAM_VIDEO
      3. ≠ enum LineItemError.Reason
         1. + value INVALID_NATIVE_SIZE
  28. = LiveStreamEventService (no changes)
  29. = MobileApplicationService (no changes)
  30. = NativeStyleService (no changes)
  31. ≠ NetworkService (0 new, 1 changed, 0 removed)
      1. ≠ enum AccountStatus
         1. + value CLOSED_POLICY_VIOLATION
         2. + value CLOSED_INVALID_ACTIVITY
         3. + value CLOSED_BY_PUBLISHER
         4. + value DISAPPROVED_INELIGIBLE
         5. − value DISAPPROVED_POLICY_VIOLATION
  32. ≠ OrderService (0 new, 3 changed, 0 removed)
      1. ≠ enum DateTimeRangeTargetingError.Reason
         1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
         2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
      2. ≠ enum GrpSettingsError.Reason
         1. + value NIELSEN_DAR_REQUIRES_INSTREAM_VIDEO
      3. ≠ enum LineItemError.Reason
         1. + value INVALID_NATIVE_SIZE
  33. = PlacementService (no changes)
  34. ≠ ProposalLineItemService (0 new, 4 changed, 0 removed)
      1. ≠ enum DateTimeRangeTargetingError.Reason
         1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
         2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
      2. ≠ enum LineItemError.Reason
         1. + value INVALID_NATIVE_SIZE
      3. ≠ type ProposalLineItem
         1. + field grpSettings
      4. ≠ enum ProposalLineItemError.Reason
         1. + value NO_WEB_PROPERTY_FOR_TARGETED_REQUEST_PLATFORM
  35. ≠ ProposalService (0 new, 1 changed, 0 removed)
      1. ≠ enum ProposalLineItemError.Reason
         1. + value NO_WEB_PROPERTY_FOR_TARGETED_REQUEST_PLATFORM
  36. = PublisherQueryLanguageService (no changes)
  37. ≠ ReportService (0 new, 1 changed, 0 removed)
      1. ≠ enum Column
         1. + value TOTAL_VIDEO_MATCHED_OPPORTUNITIES
         2. + value TOTAL_VIDEO_MATCHED_DURATION
         3. + value TOTAL_VIDEO_DURATION
         4. + value TOTAL_VIDEO_BREAK_START
         5. + value TOTAL_VIDEO_BREAK_END
         6. − value AD_SERVER_INVENTORY_LEVEL_WITH_CPD_PERCENT_REVENUE
         7. − value TOTAL_INVENTORY_LEVEL_ALL_REVENUE
         8. − value TOTAL_INVENTORY_LEVEL_WITH_CPD_AVERAGE_ECPM
  38. ≠ SiteService (0 new, 1 changed, 0 removed)
      1. ≠ enum SiteError.Reason
         1. + value CANNOT_ARCHIVE_SITE_WITH_SUBSITES
  39. ≠ StreamActivityMonitorService (0 new, 1 changed, 0 removed)
      1. ≠ type AdDecisionCreative
         1. + field googleVideoId
  40. = SuggestedAdUnitService (no changes)
  41. ≠ TargetingPresetService (0 new, 1 changed, 0 removed)
      1. ≠ enum DateTimeRangeTargetingError.Reason
         1. + value NOT_SPONSORSHIP_OR_STANDARD_LINEITEM
         2. + value UNSUPPORTED_LINEITEM_RESERVATION_TYPE
  42. = TeamService (no changes)
  43. = UserService (no changes)
  44. = UserTeamAssociationService (no changes)

  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.
  • Removed ProposalLineItemMarketplaceInfo.adExchangeEnvironment. Use RequestPlatformTargeting instead.

  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