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 minOccurs="0" name="DevicePreference" nillable="true" type="xs:long" />
        <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
DevicePreferenceThis element determines whether the preference is for the click to call phone number to be displayed on mobile devices or all devices.

Note: Reserved for future use.
long
IsCallOnlyA Boolean value that determines whether the phone number is the only clickable item in the ad. If true and the ad is displayed on a hi-fi mobile device, all otherwise clickable items such as addresses, the display URL, and site links will be disabled.

Add: Optional

Update: Optional
boolean
IsCallTrackingEnabledA Boolean value that determines whether call tracking is enabled for the call ad extension.

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

To enable call tracking, set this element to true. To disable call tracking, set this element to false.

If this element is nil or not specified, the default value is False.

Add: Optional

Update: Optional
boolean
PhoneNumberThe phone number to include in the ad. The phone number is clickable on hi-fi mobile devices.

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 will be reformatted to (425) 555-1212.

Add: Required

Update: Optional
string
RequireTollFreeTrackingNumberA Boolean value that determines whether a toll-free tracking number should be created for call tracking. This element can only be set if IsCallTrackingEnabled is also true.

To create a toll-free number, set this element to true. To inactivate an existing toll-free number, set this element to false.

If this element is nil or not specified, the default value is False.

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

Add: Optional

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
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.

Note: Not everyone has this feature yet. If you don’t, don’t worry. It’s coming soon.

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.

Get: This element is not returned in the AdExtension object by default. You must include Scheduling in the optional ReturnAdditionalFields flags when calling GetAdExtensionsAssociations and GetAdExtensionsByIds.
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 v10

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

AdExtensionAssociationAddAdExtensionsGetAdExtensionsByIdsUpdateAdExtensions

Community Additions

ADD
Show: