Edit

Share via

Call Ad Extension Record - Bulk

  • Article

Defines a call ad extension that can be uploaded and downloaded in a bulk file.

You can associate a call ad extension with campaigns in the account. Each entity (campaign) can be associated with one call ad extension. Use the Campaign Call Ad Extension record to manage call ad extension associations.

You can download all Call Ad Extension records in the account by including the DownloadEntity value of CallAdExtensions in the DownloadCampaignsByAccountIds or DownloadCampaignsByCampaignIds service request. Additionally the download request must include the EntityData scope. For more details about the Bulk service including best practices, see Bulk Download and Upload.

The following Bulk CSV example would add a new Call Ad Extension to the account's shared library.

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Start Date,End Date,Phone Number,Device Preference,Name,Ad Schedule,Use Searcher Time Zone,Country Code,Call Only,Call Tracking Enabled,Toll Free
Format Version,,,,,,,,,,,,6.0,,,,,,
Call Ad Extension,Active,-12,0,,,ClientIdGoesHere,,,12/31/2020,2065550100,,,(Monday[09:00-21:00]),FALSE,US,TRUE,TRUE,FALSE

If you are using the Bing Ads SDKs for .NET, Java, or Python, you can save time using the BulkServiceManager to upload and download the BulkCallAdExtension object, instead of calling the service operations directly and writing custom code to parse each field in the bulk file.

var uploadEntities = new List<BulkEntity>();

// Map properties in the Bulk file to the BulkCallAdExtension
var bulkCallAdExtension = new BulkCallAdExtension
{
    // 'Parent Id' column header in the Bulk file
    AccountId = 0,
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",
                
    // Map properties in the Bulk file to the 
    // CallAdExtension object of the Campaign Management service.
    CallAdExtension = new CallAdExtension
    {
        // 'Country Code' column header in the Bulk file
        CountryCode = "US",
        // 'Id' column header in the Bulk file
        Id = callAdExtensionIdKey,
        // 'Call Only' column header in the Bulk file
        IsCallOnly = true,
        // 'Call Tracking Enabled' column header in the Bulk file
        IsCallTrackingEnabled = true,
        // 'Phone Number' column header in the Bulk file
        PhoneNumber = "2065550100",
        // 'Toll Free' column header in the Bulk file
        RequireTollFreeTrackingNumber = false,
                    
        // 'Ad Schedule' column header in the Bulk file
        Scheduling = new Schedule
        {
            // Each day and time range is delimited by a semicolon (;) in the Bulk file
            DayTimeRanges = new[]
            {
                // Within each day and time range the format is Day[StartHour:StartMinue-EndHour:EndMinute].
                new DayTime
                {
                    Day = Day.Monday,
                    StartHour = 9,
                    StartMinute = Minute.Zero,
                    EndHour = 21,
                    EndMinute = Minute.Zero,
                },
            },
            // 'End Date' column header in the Bulk file
            EndDate = new Microsoft.BingAds.V13.CampaignManagement.Date
            {
                Month = 12,
                Day = 31,
                Year = DateTime.UtcNow.Year + 1
            },
            // 'Start Date' column header in the Bulk file
            StartDate = null,
            // 'Use Searcher Time Zone' column header in the Bulk file
            UseSearcherTimeZone = false,
        },

        // 'Status' column header in the Bulk file
        Status = AdExtensionStatus.Active,
    },
};

uploadEntities.Add(bulkCallAdExtension);

var entityUploadParameters = new EntityUploadParameters
{
    Entities = uploadEntities,
    ResponseMode = ResponseMode.ErrorsAndResults,
    ResultFileDirectory = FileDirectory,
    ResultFileName = DownloadFileName,
    OverwriteResultFile = true,
};

var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();

For a Call Ad Extension record, the following attribute fields are available in the Bulk File Schema.

Ad Schedule

The list of day and time ranges that you want the ad extension to be displayed with your ads. Each day and time range includes the scheduled day of week, start/end hour, and start/end minute. Each day and time range is enclosed by left and right parentheses, and separated from other day and time ranges with a semicolon (;) delimiter. Within each day and time range the format is Day[StartHour:StartMinue-EndHour:EndMinute].

The possible values of StartHour range from 00 to 23, where 00 is equivalent to 12:00AM and 12 is 12:00PM.

The possible values of EndHour range from 00 to 24, where 00 is equivalent to 12:00AM and 12 is 12:00PM.

The possible values of StartMinute and EndMinute range from 00 to 60.

The following example demonstrates day and time ranges during weekdays from 9:00AM through 9:00PM: (Monday[09:00-21:00]);(Tuesday[09:00-21:00]);(Wednesday[09:00-21:00]);(Thursday[09:00-21:00]);(Friday[09:00-21:00])

Add: Optional. If you do not set this field, the ad extension will be eligible for scheduling anytime during the calendar start and end dates.
Update: Optional. The individual day and time ranges cannot be updated. You can effectively update the day and time ranges by sending a new set that should replace the prior set. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only

Call Only

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 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. If no value is set for the update, this setting is not changed.
Delete: Read-only

Call Tracking Enabled

Determines whether call tracking is enabled for the call ad extension.

Set this property to TRUE to enable call tracking, and otherwise set it to FALSE.

Note

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

Add: Optional. If you do not specify this field or leave it empty, the default value of FALSE will be set.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Client Id

Used to associate records in the bulk upload file with records in the results file. The value of this field is not used or stored by the server; it is simply copied from the uploaded record to the corresponding result record. It may be any valid string to up 100 in length.

Add: Optional
Update: Optional
Delete: Read-only

Country Code

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

Editorial Location

The component or property of the ad extension that failed editorial review.

Add: Read-only
Update: Read-only
Delete: Read-only

Editorial Reason Code

A code that identifies the reason for the failure. For a list of possible reason codes, see Editorial Reason Codes.

Add: Read-only
Update: Read-only
Delete: Read-only

Editorial Status

The editorial status of the ad extension.

Possible values are described in the table below.

Value Description
Active The ad extension passed editorial review.
ActiveLimited The ad extension passed editorial review in one or more markets, and one or more elements of the ad extension is undergoing editorial review in another market. For example the ad extension passed editorial review for Canada and is still pending review in the United States.
Disapproved The ad extension failed editorial review.
Inactive One or more elements of the ad extension is undergoing editorial review.

Add: Read-only
Update: Read-only
Delete: Read-only

Editorial Term

The term that failed editorial review.

This field will not be set if a combination of terms caused the failure or if the failure was based on a policy violation.

Add: Read-only
Update: Read-only
Delete: Read-only

End Date

The ad extension scheduled end date string formatted as MM/DD/YYYY.

The end date is inclusive. For example, if you set this field to 12/31/2020, the ad extensions will stop being shown at 11:59 PM on 12/31/2020.

Add: Optional. If you do not specify an end date, the ad extension will continue to be delivered unless you pause the associated campaigns, ad groups, or ads.
Update: Optional. The end date can be shortened or extended, as long as the start date is either null or occurs before the new end date. If you set this field to the delete_value string, then you are effectively removing the end date. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only

Id

The system-generated identifier of the ad extension.

Add: Optional. You must either leave this field empty, or specify a negative identifier. A negative identifier set for the ad extension can then be referenced in the Id field of dependent record types such as Campaign Call Ad Extension. This is recommended if you are adding new ad extensions and new dependent records in the same Bulk file. For more information, see Bulk File Schema Reference Keys.
Update: Read-only and Required
Delete: Read-only and Required

Modified Time

The date and time that the entity was last updated. The value is in Coordinated Universal Time (UTC).

Note

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Read-only
Update: Read-only
Delete: Read-only

Parent Id

The system-generated identifier of the account that contains the ad extension.

This bulk field maps to the Id field of the Account record.

Add: Read-only
Update: Read-only
Delete: Read-only

Phone Number

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.

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. If no value is set for the update, this setting is not changed.
Delete: Read-only

Publisher Countries

The list of publisher countries or regions whose editorial guidelines do not allow the specified term.

In a bulk file, the list of publisher countries or regions are delimited with a semicolon (;).

Add: Read-only
Update: Read-only
Delete: Read-only

Start Date

The ad extension scheduled start date string formatted as MM/DD/YYYY.

The start date is inclusive. For example, if you set StartDate to 5/5/2020, the ad extensions will start being shown at 12:00 AM on 5/5/2020.

Add: Optional. If you do not specify a start date, the ad extension is immediately eligible to be scheduled.
Update: Optional. The start date can be shortened or extended, as long as the end date is either null or occurs after the new start date. If you set this field to the delete_value string, then you are effectively removing the start date and the ad extension is immediately eligible to be scheduled. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only

Status

The status of the ad extension.

Possible values are Active or Deleted.

Add: Optional. The default value is Active.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Required. The Status must be set to Deleted.

Toll Free

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 field determines whether a toll-free Microsoft Advertising forwarding phone number should be created for call tracking. This field can only be set if Call Tracking Enabled field 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 field or leave it empty, the default value of FALSE will be set.
Update: Optional. If no value is set for the update, this setting is not changed.
Delete: Read-only

Use Searcher Time Zone

Determines whether to use the account time zone or the time zone of the search user where the ads could be delivered.

Set this property to TRUE if you want the ad extensions to be shown in the search user's time zone, 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 and the account time zone will be used.
Update: Optional. If you set this field to the delete_value string, then you are effectively resetting to the default value of FALSE. The Ad Schedule, End Date, Start Date, and Use Searcher Time Zone fields depend on each other and are updated together. If you leave all of these fields empty during update, then none of them are updated. If you include values for any of these fields, then the prior values for all of these fields are removed or replaced. To remove all prior schedule settings, set each of these fields to delete_value.
Delete: Read-only

Version

The 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
Delete: Read-only