Edit

CallAdExtension Data Object - Campaign Management

  • Article

Defines an object that specifies a click-to-call phone number to include in a text ad.

You can associate a call ad extension with campaigns in the account. Each entity (campaign) can be associated with one call ad extension.

Syntax

<xs:complexType name="CallAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="CountryCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="IsCallOnly" nillable="true" type="xs:boolean" />
        <xs:element minOccurs="0" name="IsCallTrackingEnabled" nillable="true" type="xs:boolean" />
        <xs:element minOccurs="0" name="PhoneNumber" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="RequireTollFreeTrackingNumber" nillable="true" type="xs:boolean" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The CallAdExtension object has the following elements: CountryCode, IsCallOnly, IsCallTrackingEnabled, PhoneNumber, RequireTollFreeTrackingNumber.

Element Description Data Type
CountryCode The country code where the phone number is registered. The country code must contain a 2 character country code. The supported country code values include AR, AT, AU, BR, CA, CH, CL, CO, DE, DK, ES, FI, FR, GB, HK, ID, IE, IN, IT, MX, MY, NL, NZ, NO, PE, PH, SE, SG, TH, TW, US, VE, and VN.

Add: Required
Update: Required		 string
IsCallOnly The option to show both your phone number and website, or just your phone number, to people seeing your ads on a smartphone. You might want to show only your phone number if your business requires that you talk to each customer.

Set this property to true if you want the ad extension to only show the phone number without a link to your website, and otherwise if you want the ad extension include a link to your website in addition to the phone number set it to false.

Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set and the ad extension will include a link to your website in addition to the phone number.
Update: Optional		 boolean
IsCallTrackingEnabled Determines whether call tracking is enabled for the call ad extension.

Call tracking is only supported in the United States and United Kingdom.

Set this property to true to enable call tracking, and otherwise set it to false.

Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set.
Update: Optional		 boolean
PhoneNumber The clickable phone number to include in the ad.

The phone number can contain a maximum of 35 characters and must be valid for the specified country or region.

If the campaign includes call and location ad extensions, this phone number will override the phone number specified in the location ad extensions.

Note that the phone number may be reformatted. For example, if you set phone number to 4255551212, it would be reformatted to (425) 555-1212.

Add: Required
Update: Required		 string
RequireTollFreeTrackingNumber You can either use your own phone number or use a Microsoft Advertising forwarding phone number. A Microsoft Advertising forwarding phone number is a unique phone number that is routed to your business phone number. With a Microsoft Advertising forwarding number, you can track all calls from your ad so that you can analyze the ad's performance. This element determines whether a toll-free Microsoft Advertising forwarding phone number should be created for call tracking. This element can only be set if IsCallTrackingEnabled is also true.

Prior to August 2017, clients could set this property to true if a Microsoft Advertising forwarding phone number should be created for call tracking. Since August 2017, clients can no longer create a new toll-free Microsoft Advertising forwarding phone number. If you set this value true then the operation will succeed; however, a toll-free number will not be created and when you retrieve the call ad extension this property will be set to false. If a toll-free forwarding number was provisioned prior to August 2017 then this property will be true if the number is still active when you retrieve the call ad extension.

Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set.
Update: Optional		 boolean

The CallAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

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

Element Description Data Type
DevicePreference Not supported for this ad extension type. 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 CallAdExtension when you retrieve a call 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