AdExtension Data Object - Campaign Management

Article
03/20/2023

Defines the base object of an ad extension.

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

Syntax

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

Elements

The AdExtension object has the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version.

Element	Description	Data Type
DevicePreference	This 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. This element is only applicable for the AppAdExtension and SitelinkAdExtension types.	long
ForwardCompatibilityMap	The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.	KeyValuePairOfstringstring array
Id	The unique Microsoft Advertising identifier of the ad extension.	long
Scheduling	Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.	Schedule
Status	The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.	AdExtensionStatus
Type	The type of ad extension. For more information, see Remarks.	string
Version	Tracks the number of times the ad extension has been updated. The version is set to 1 when the ad extension is created, and increments by one after each update.	int

Remarks

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.

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

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

AddAdExtensions
AdExtensionAssociation
GetAdExtensionsByIds
UpdateAdExtensions

Share via