AdExtension Data Object

 

Defines the base object of an ad extension.

Do not try to instantiate an AdExtension. You can create one or more following objects that derive from it.

<xs:complexType name="AdExtension">
  <xs:sequence>
    <xs:element name="DevicePreference" type="xs:long" nillable="true" minOccurs="0"/>
    <xs:element name="ForwardCompatibilityMap" type="q53:ArrayOfKeyValuePairOfstringstring" nillable="true" minOccurs="0" xmlns:q53="http://schemas.datacontract.org/2004/07/System.Collections.Generic"/>
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element name="Scheduling" type="tns:Schedule" nillable="true" minOccurs="0"/>
    <xs:element name="Status" type="tns:AdExtensionStatus" nillable="true" minOccurs="0"/>
    <xs:element name="Type" type="xs:string" nillable="true"/>
    <xs:element name="Version" type="xs:int" nillable="true" minOccurs="0"/>
  </xs:sequence>
</xs:complexType>

ElementDescriptionData Type
DevicePreferenceThis element determines whether the preference is for the ad extension to be displayed on mobile devices or all devices.

To specify a preference for mobile devices, set this element to 30001.

To specify all devices, set this element to 0 (zero) or leave the element nil. By default, this element will be nil.

Note: This element is only applicable for the AppAdExtension and Sitelink2AdExtension types. For SiteLinksAdExtension objects, you specify the DevicePreference for each SiteLink, otherwise the operation will fail if you attempt to set the ad extension level DevicePreference element.
long
ForwardCompatibilityMapThe list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

There are currently no forward compatibility changes for the AdExtension object.
KeyValuePairOfstringstring array
IdThe unique Bing Ads identifier of the ad extension.long
SchedulingDetermines the calendar day and time ranges when the ad extension is eligible to be shown in ads.

Note: This element is not applicable for the SiteLinksAdExtension type; You can specify a Scheduling element for each SiteLink object (nested list within the SiteLinksAdExtension) instead. For all other ad extension types including Sitelink2AdExtension, the AdExtension object will include the Scheduling element.
Schedule
StatusThe status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.AdExtensionStatus
TypeThe type of ad extension.

For more information, see Remarks.
string
VersionThe number of times the contents of the ad extension has been updated. The version is set to 1 when you add the extension and is incremented each time it’s revised.int

If you generate the SOAP manually, use the type attribute of the <AdExtension> node as shown in the following example to specify the type of ad extension.

xml
<AdExtension i:type="ReviewAdExtension" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Id i:nil="true" />
    <Status i:nil=”true” />
      . . .
</AdExtension>

CampaignManagementService.svc v11

Namespace: https://bingads.microsoft.com/CampaignManagement/v11

AdExtensionAssociation
AddAdExtensions
GetAdExtensionsAssociations
GetAdExtensionsByIds
UpdateAdExtensions

Show: