This release of the Enterprise Web Services (EWS) Marketing API includes changes and additions to the services that you are currently using.
These release notes summarize the new features in EWS Versions 4.2.0, 4.1.0 and 4.0.0 - and EWS Versions 3.2.0, 3.1.0, and 3.0.0. Please consult the latest version of the EWS documentation for details.
We continue to enhance the EWS documentation, which is available on the Technology Solutions portal. We encourage you to read it thoroughly to make sure you have all of the information you need to understand the inner workings of the Marketing API.
EWS Version 4.2.0 is a minor version release. All new features are backward compatible. To take advantage of the new features in Version 4.2.0 you will need to recompile your client code for Version 4.0.0 if you have not already done so.
EWS Version 4.2.0 will be released to the EWS sandbox as well as to production. We suggest that you first experiment with the new version in the EWS sandbox, make any required changes to your client application, and then test your implementation. When you are satisfied with the results, you can move your client application to production.
The new features and changes in EWS Version 4.2.0 are summarized here.
Purging Deleted Objects
Deleted items will be permanently removed after a period of 90 days. Please see Deleting Objects for more details
New Operations
New operations added to services in EWS Version 4.2.0 include:
ForecastService
KeywordResearchService
New Data Objects
New data objects in EWS Version 4.2.0 include:
EWS Version 4.1.0 is a minor version release. All new features are backward compatible. To take advantage of the new features in Version 4.1.0 you will need to recompile your client code for Version 4.0.0 if you have not already done so.
EWS Version 4.1.0 will be released to the EWS sandbox as well as to production. We suggest that you first experiment with the new version in the EWS sandbox, make any required changes to your client application, and then test your implementation. When you are satisfied with the results, you can move your client application to production.
The new features and changes in EWS Version 4.1.0 are summarized here.
Reports
The qualityScore XML attribute (Quality Index CSV/TSV column name) has been added to the following reports:
EWS Version 4.0.0 is a major version release. Some features are not backward compatible. You will need to recompile your client code for Version 4.0.0.
EWS Version 4.0.0 will be released to the EWS sandbox and then to production. We suggest that you first experiment with the new version in the EWS sandbox, make any required changes to your client application, and then test your implementation. When you are satisfied with the results, you can move your client application to production.
The new features and changes in EWS Version 4.0.0 are summarized here.
Variable Minimum Bids
Beginning with Version 4.0.0, EWS supports two systems for setting bids:
The EWS documentation provides information about both systems (see Setting Bids). And, most of the new operations and data objects introduced in EWS Version 4.0.0 apply to both systems. If you have any questions, please contact your Technical Account Management Team (see Support). The US market will migrate from Market Minimum Bids to Variable Minimum Bids immediately. Other markets will migrate to Variable Minimum Bids at a later date. Additional information about Variable Minimum Bids is available in these sections of the documentation: Best Coding Practices, Source Code and Sample Data, and Variable Minimum Bids.
New Operations
New operations added to services in EWS Version 4.0.0 include:
AdGroupService
AdService
CampaignService
KeywordService
New Data Objects
New data objects in EWS Version 4.0.0 include:
Changed Data Objects
New elements added to data objects in EWS Version 4.0.0 include:
Account
Ad
AdGroup
BasicResponse (and all other response objects, including AdGroupResponse, AdResponse, CampaignResponse, and so on).
Keyword
The BidInformationService getMinBidForKeywordString operation is deprecated in EWS Version 4.0.0 (refer to the new KeywordService getSponsoredSearchMinBidForKeywordString operation).
EWS Version 4.0.0 does not support mobile accounts. Agencies, resellers, and SEMs who perform work on behalf of other users should not pass mobile-based master account data in any EWS request (see On-Behalf-Of Requests).
EWS Version 3.2.0 is a minor version release. This release does not include changes to the Marketing API. All features are backward compatible.
EWS Version 3.2.0 does not support mobile accounts. Agencies, resellers, and SEMs who perform work on behalf of other users should not pass mobile-based master account data in any EWS request (see On-Behalf-Of Requests).
EWS Version 3.1.0 is a minor version release. All new features are backward compatible. You will need to recompile your client code if you have not done so for Version 3.0.0 or if you want to take advantage of the new features in Version 3.1.0.
EWS Version 3.1.0 will be released to the EWS sandbox as well as to production. We suggest that you first experiment with the new version in the EWS sandbox, make any required changes to your client application, and then test your implementation. When you are satisfied with the results, you can move your client application to production.
The new features and changes in EWS Version 3.1.0 are summarized here.
On-Behalf-Of Authorizations
Optional headers for on-behalf-of authorizations are now contained in the WSDLs. You no longer need to modify a WSDL to include the optional headers.
Account Movements
Occasionally, for issues such as load balancing, we may need to move your master account from one colocation to another. When an account movement is scheduled, we will notify your Technical Account Management Team. During the move, which may take a few hours, certain restrictions will apply to the master account and all accounts under that master account. For more information, see the LocationService Overview.
EWS Version 3.0.0 is a major version release. Some features are not backward compatible. You will need to recompile your client code for Version 3.0.0.
EWS Version 3.0.0 will be released to the EWS sandbox and production at the same time. We suggest that you first experiment with the new version in the EWS sandbox, make any required changes to your client application, and then test your implementation. When you are satisfied with the results, you can move your client application to production.
The new features and changes in EWS Version 3.0.0 are summarized here.
Blocked Domains
Blocked domains enable you to control your participation in the Yahoo! Search Marketing network via specific domain restrictions at the domain, sub-domain, and directory levels. Blocked domains are set at the account level only. Three new operations have been added to the AccountService:
VaultService and Vault Command Group
A new service, VaultService, combines operations that manage sensitive user and account information such as credit cards. Existing operations moved to this service include addNewCustomer, addCreditCard, updateCreditCard, and getPaymentMethods.
The addNewCustomer operation will remain in the CustomerService command group; the addCreditCard, updateCreditCard, and getPaymentMethods operations will move to the new Vault Command Group.
Tax Codes for European Markets
The Account data object includes five new elements (in addition to vatRegistrationNumber):
The Value Added Tax (VAT) registration number is for all European markets, the Fiscal code is for the IT market (Italy) only, and the NIF/CIF is for ES market (Spain) only.
Use these elements to indicate if the tax code is available (for example, hasNifCif) or to enter the tax code itself (for example, NifCif). You can set the values of these elements when you create new accounts using the addAccount and addNewCustomer operations.You can get or update the values of these elements by calling your Account Management Team; however, you cannot get or update the values of these elements using the getAccount, getAccounts, or updateAccount operations.
If you encounter problems with the Marketing API in the EWS sandbox or in production, or if you have questions about product behavior that are not answered by the EWS Documentation or these release notes, please contact your Technical Account Management Team at ews-help@yahoo-inc.com or send us a message through the online Support Form.