Edit

Share via

AppAdExtension Data Object - Campaign Management

  • Article

Defines an app ad extension that can be included in an ad.

You can associate an app ad extension with the account or with campaigns and ad groups in the account. Each entity (account, campaign, or ad group) can be associated with as many app ad extensions as you decide, up to the total number of app ad extensions in your account.

<xs:complexType name="AppAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="AppPlatform" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AppStoreId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q48="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q48:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q49="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q49:ArrayOfstring" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The AppAdExtension object has the following elements: AppPlatform, AppStoreId, DestinationUrl, DisplayText, FinalAppUrls, FinalMobileUrls, FinalUrls, FinalUrlSuffix, TrackingUrlTemplate, UrlCustomParameters.

Element Description Data Type
AppPlatform The application platform.

Possible values include iOS, Android, and Windows.

Add: Required
Update: Required		 string
AppStoreId The application identifier provided by the app store.

If the application is new, please expect to wait 4-7 days before the ad will be eligible to deliver.

Add: Required
Update: Required		 string
DestinationUrl The URL of the app store download webpage that users are taken to when they click the app extension link.

The URL can contain dynamic text strings such as {keyword}. For a list of supported parameters, see the Available parameters section within the Microsoft Advertising help article What tracking or URL parameters can I use?.

The URL can contain a maximum of 1,024 characters. If the URL does not specify a protocol, the system uses the HTTP protocol when a user clicks the ad. If the URL specifies the HTTP protocol when you add an ad, the service will remove the http:// protocol string (the HTTP protocol string does not count against the 1,024 character limit); however, the service will not remove an HTTPS protocol string (https://) from the URL.

Add: Required
Update: Optional		 string
DisplayText The text displayed in the app ad extension. The text can contain a maximum of 35 characters.

Add: Required
Update: Optional		 string
FinalAppUrls For future use. AppUrl array
FinalMobileUrls Reserved for future use. string array
FinalUrls Reserved for future use. string array
FinalUrlSuffix Reserved for future use. string
TrackingUrlTemplate Reserved for future use. string
UrlCustomParameters Reserved for future use. CustomParameters

The AppAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

The AppAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to AppAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.

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.

Add: Optional
Update: Optional. If no value is set for the update, this setting is not changed.		 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.

There are currently no forward compatibility changes for the AdExtension object.

Add: Read-only
Update: Read-only		 KeyValuePairOfstringstring array
Id The unique Microsoft Advertising identifier of the ad extension.

Add: Read-only
Update: Read-only and Required		 long
Scheduling Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.

Add: Optional
Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.		 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.

Add: Read-only
Update: Read-only		 AdExtensionStatus
Type The type of the ad extension. This value is AppAdExtension when you retrieve an app ad extension.

Add: Read-only
Update: Read-only

For more information about ad extension types, see the Ad Extension Data Object 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.

Add: Not allowed
Update: Not allowed		 int

Requirements

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