CallAdExtension Data Object

 

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 one or more campaigns; however, a campaign can be associated with only one call ad extension.

<xs:complexType name="CallAdExtension">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element name="CountryCode" nillable="true" type="xs:string" />
        <xs:element name="IsCallOnly" 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>

The CallAdExtension object inherits elements from the AdExtension object. For a list of the inherited elements, see Inherited Elements below.

ElementDescriptionData Type
CountryCodeThe country code where the phone number is registered. The country code must contain a 2 character country code. For a list of country code values, see Geographical Location Codes.

Add: Required
Update: Optional
string
IsCallOnlyThe 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 field 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
IsCallTrackingEnabledDetermines whether call tracking is enabled for the call ad extension.

Note: 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 field or leave it empty, the default value of false will be set.
Update: Optional
boolean
PhoneNumberThe 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.

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: Optional
string
RequireTollFreeTrackingNumberYou can either use your own phone number or use a Bing Ads forwarding phone number. A Bing Ads forwarding phone number is a unique phone number that is routed to your business phone number. With a Bing Ads 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 Bing Ads forwarding phone number should be created for call tracking. This element can only be set if IsCallTrackingEnabled is also true.

Set this property to true if a Bing Ads forwarding phone number should be created for call tracking, and otherwise set it to false.

Important: Each time the flag is set from false to true, a new toll-free number is provisioned.

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

The CallAdExtension object inherits the following elements from the AdExtension object.

System_CAPS_ICON_note.jpg Note

The descriptions below are specific to call ad extensions, and might not apply to other objects that inherit the same elements from the AdExtension object.

ElementDescriptionData Type
DevicePreferenceReserved for future use.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.

Add: Read-only
Update: Read-only
KeyValuePairOfstringstring array
IdThe unique Bing Ads identifier of the ad extension.

Add: Read-only and Required
Update: Read-only
long
SchedulingDetermines 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
StatusThe 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
TypeThe 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
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.

Add: Read-only
Update: Read-only
int

CampaignManagementService.svc v11

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

AdExtensionAssociation
AddAdExtensions
GetAdExtensionsByIds
UpdateAdExtensions

Show: