Microsoft Advertising APIs
Ad Data Object

Represents a Microsoft adCenter ad.

Elements

Business Rules

Element Rules

Syntax
<xs:complexType name="ArrayOfAd">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="unbounded" name="Ad" nillable="true" type="tns:Ad" />
  </xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfAd" nillable="true" type="tns:ArrayOfAd" />

<xs:complexType name="Ad">
  <xs:sequence>
    <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:AdEditorialStatus" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:AdStatus" />
    <xs:element minOccurs="0" name="Type" nillable="true" type="tns:AdType" />
  </xs:sequence>
</xs:complexType>
<xs:element name="Ad" nillable="true" type="tns:Ad" />
Elements

Element Description Data Type Add Update Rules

EditorialStatus

Specifies the review status of the ad.

AdEditorialStatus

Not used

Not used

EditorialStatus Element

Id

Identifies the ad.

long

Read-only

Required

Specifies the ad to update.

None

Status

Specifies the status of the ad.

AdStatus

Not used

Not used

Status Element

Type

Specifies the type of the ad.

AdType

Read-only

Read-only

Type Element

Business Rules

General Business

There can be no more than 20 ads in an ad group.

Adding Ads

  • Ads can be added to an ad group that is in the draft, submitted, or paused state.
  • Ads cannot be added to an ad group that has been deleted.

Updating Ads

All ads—except deleted ads—can be updated.

Deleting Ads

  • Ads can be deleted from an ad group that is in the draft, submitted, or paused state.
  • Ads cannot be deleted from an ad group that has been deleted.
  • Deleting an ad does not remove or alter the entry in the ad table. Deleting an ad removes only the association with the ad group and any associations with keywords.

Retrieving Ads
Element Rules

EditorialStatus Element

The EditorialStatus element is read-only and cannot be changed by the user.

Status Element

The Status element can be changed only by using either the PauseAds or the ResumeAds service operation.

Type Element

The Type element is read-only; it is set at creation time and is based on the type of derived class used to create the object.
Remarks

The Ad data object is abstract—it cannot be directly instantiated. Instead, you should instantiate one of its derived data objects: TextAd, ImageAd, or MobileAd.
Requirements

WSDL: CampaignManagementService.svc in version 6.
See Also

Reference

CampaignManagement AddAds Service Operation
CampaignManagement PauseAds Service Operation
CampaignManagement ResumeAds Service Operation
CampaignManagement GetAdsByAdGroupId Service Operation
CampaignManagement GetAdsByIds Service Operation
ImageAd Data Object
MobileAd Data Object
TextAd Data Object
CampaignManagement UpdateAds Service Operation
Page view tracker