Last update: 2023-10-31
Migrate your application
Migrating from v2 to v3 requires updating your endpoint URLs to call v3 and updating your application to account for breaking changes.
Update your API calls from v2 to v3
To use v3 instead of v2, you need to update your requests to use new v3 endpoints.
For example, to call the
advertisers.get method with v2, you would
use the following URL:
For v3, update the URL to the following:
If you are using a client library to make requests to the API, use the most recent version of the client library and update your configuration to use v3.
Make required changes
We're introducing a number of breaking changes in v3. Review the following instructions and make the required changes relevant to your existing use of the Display & Video 360 API.
Update calls retrieving YouTube resources and their related targeting
YoutubeAdGroupAdresources have been replaced by
AdGroupAdresources. These new resources provide nearly identical information as the v2 resources but may use updated field names or enum types. In your integration, replace your uses of
AdGroupAdresources and update calls to the following v2 services to the corresponding v3 service:
- References to
YoutubeAndPartnersBiddingStrategyobjects have been moved to a new
youtubeAndPartnersBidfield within the general
biddingStrategyfield has been removed from the
YoutubeAndPartnersSettingsobject. Update your integration to retrieve the bidding strategy for YouTube line items or ad groups from the
BiddingStrategyobject in the
bidStrategyfield in the
thirdPartyMeasurementSettingsfield has been renamed to
YoutubeAndPartnersSettingsobject and the
YoutubeAndPartnersThirdPartyMeasurementSettingsobject has been renamed to
ThirdPartyMeasurementConfigs. Update your integration to retrieve third-party measurement configuration information using the new field and object.
Include required billing configurations when creating advertisers
billingConfig is now a required field in the
Advertiser resource. Update your
requests to verify that this field is set. The default billing information can
be retrieved for the parent partner through the new
Use new field to control optimized targeting
Update insertion order integration to use new KPI field
Remove references to deprecated services and fields
Various entities have been removed in v3 to align with past feature deprecations:
advertisers.manualTriggersservice has been removed as manual triggers have been deprecated.
billableOutcomefield has been removed from the
InsertionOrderresource as outcome based buying has been deprecated.
In addition to the breaking changes listed above, v3 also introduces new features.
Features added to v3 after the initial launch can be found in our release notes.
Proximity location list management
In v3 you can fully manage proximity location lists, allowing you to
advertisers.locationLists.assignedLocations service to
create and delete locations assigned to
LocationList resources. Locations are identified using the ID of
TargetingOption resources. These can be
Ability to build rule-based custom bidding algorithms
This feature is in beta and only available to allowlisted partners. If your partner is not allowlisted, your request will return an error.