Getting Started Guide: UpgradeService Overview

About Account Upgrades

Your Technical Account Management team will oversee and manage the transition of your old accounts to the new Sponsored Search. Before an account is actually upgraded, it is placed in preview mode. While the account is in preview mode, you may use the read-only, get operations, from the Marketing API services to review the campaigns, ad groups, ads, and keywords that were derived from your current listings.

After you review the new account structure, you can activate the upgrade via your old account. Once the account is upgraded, you may use any of the Marketing API service operations to manage the account as well as the campaigns, ad groups, ads, and keywords within that account.

Note: After your accounts are upgraded, use the LocationService rather than the UpgradeService. See the LocationService Overview.

Preview Accounts

To review the accounts that are in preview mode, do the following:

1. Use the getMasterAccountLocationForUpgradePreview operation to determine the location of your preview mode accounts. This operation will return a URL prefix. Combine the URL prefix with the current version and relevant service name to form a complete, local URL - URL prefix / version / service.
2. Use the getAccountsForUpgradePreview operation to return a list of IDs for the accounts that are in preview mode.

Once you have formed the local URL and have the list of account IDs, you may use the read-only, get operations to preview and verify that your old accounts have been correctly transitioned to the new Sponsored Search. See Send a Request to a Service.

Send a Request to the UpgradeService

The UpgradeService has two operations,

• getMasterAccountLocationForUpgradePreview, and
• getAccountsForUpgradePreview.

When you send a request to the UpgradeService using either of these operations, you do not use a local URL. Rather, you use the URL located in the UpgradeService WSDL file, sandbox or production as the case may be.

Note: See the LocationService for more information.

Send a Request to a Service

To send a request to a service other than the LocationService, UpgradeService, or VaultService using the read-only "get" operations, do the following.

First

1. Send a request to the UpgradeService - getMasterAccountLocationForUpgradePreview operation to retrieve the URL prefix for colocation the preview mode accounts are assigned to.
2. Combine the URL prefix with the current version using variable V5 and service name to form the local URL - URL prefix / version / service.
3. Reference the local URL when you post the request. See Requests and HTTPS.

For example, suppose you want to post a request to the CampaignService. If the URL prefix returned by the UpgradeService is "https://pews411.marketing.ews.yahooapis.com/services" then the local URL would be "https://pews411.marketing.ews.yahooapis.com/services/V5/CampaignService".

Second

1. Send a request to the UpgradeService- getAccountsForUpgradePreview operation to retrieve a list of account IDs that are currently in preview mode.
2. Include the account ID in the SOAP header of the request. See EWS Requests.