Yahoo! Search Marketing

Getting Started Guide: AdService Overview

AdService provides operations for creating and managing ads.

About Ads

An ad is a marketing message about your products or services. Ads, together with related keywords, are grouped under ad groups. Ads are served either through Sponsored Search or Content Match®. Values set at the ad level override corresponding values set at, and inherited from, the ad group level.

Ad Management

AdService provides operations for creating, updating, deleting, reviewing, and checking the status of ads.

Create Ads

To create a new keyword, use the addAd and addAds operations. The first operation creates one ad; the second operation creates one or more ads. All new ads are subject to editorial review.

Update Ads

To update an ad, use the updateAd and updateAds operations.

If an updated element requires editorial review (for example, the ad's short description), the original ad remains online during the review process.

To determine the updates for an ad that have been submitted for editorial review, use the getUpdateForAd operation.

Set Ad URLs

To set the URL of an ad, use the setAdURL operation. This operation provides an easy way to update the URL.

Delete Ads

To delete an ad, use the deleteAd and deleteAds operations. Once you delete an Ad, you cannot un-delete it (see Deleting Objects).

Review Ads

To get information about an ad or a list of ads use the getAd and getAds operations. To get a list of the ads in a specific ad group, use the getAdsByAdGroupID operation.

Ad Status

To determine the status of an ad, use the getStatusForAd operation.

To retrieve all of the ads with a specific status in a specific ad group, use the getAdsByAdGroupIDByStatus operation.

To change the status of an ad, use the updateStatusForAd and updateStatusForAds operations. You can set the status to On or Off, but not Deleted. To delete an ad, use the delete ad operations.

Keep in mind that an ad's status is different from its editorial status. An active ad (that is, an ad that can be served) is an ad with AdStatus = On and EditorialStatus = Approved.

Editorial Review

Newly created and/or updated ads are subject to editorial review and are evaluated against Yahoo!'s editorial guidelines. Most ads are approved within minutes of submission, assuming the ad does not contain sensitive content. A small number of ads, however, are passed on for editorial review. This review process can take up to 48 hours to complete. Updates to ads are subject to the same review process.

To determine the editorial status of an ad, use the getAd and getAds operations to retrieve the ad and then check the value of the editorialStatus element in the Ad data object (see the Ad and EditorialStatus data objects).

To retrieve all of the ads with a specific editorial status in a specific ad group, use the getAdsByAdGroupIDByEditorialStatus operation.

If your ad is not approved, you can update and resubmit it. Use the editorial reason text and, when available, editorial suggestion text, returned by editorial review as a guide when you make your modifications.

To get the editorial reason codes, use the getEditorialReasonsForAd operation. To get the corresponding text, use the getEditorialReasonText operation. Note that there is no operation to return the editorial suggestion text (see Editorial Reason Text and Editorial Suggestion Text).