AccountProperty Data Object - Campaign Management

Maps an account level property name to a string value.

Syntax

<xs:complexType name="AccountProperty" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Name" type="tns:AccountPropertyName" />
    <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

Element Description Data Type
Name The name of the account property. AccountPropertyName
Value The value of the named account property.

The value will vary by account property name. For more information, see Account Property Values in the section below.
string

Remarks

Account Property Values

AdClickParallelTracking

Determines whether parallel tracking is enabled. Parallel tracking lets you send users directly to your final URL while click measurement runs in the background.

Parallel tracking reduces the time it takes for your landing page to load, increasing customer satisfaction with your ad and website (making conversions more likely!).

You need to have {lpurl] or one of its variants in your URL's tracking template for parallel tracking to work. For more information see What tracking or URL parameters can I use?.

If the Name element is set to AdClickParallelTracking, then the returned Value can be either true or false. If the value is true, then parallel tracking is enabled.

Important

Parallel tracking is only available for pilot customers (GetCustomerPilotFeatures returns 474), and currently all other customers are opted out. During pilot you can enable and disable the feature i.e., set the property to true or false. By the end of calendar year 2019 all customers will be enabled for parallel tracking, and the value can only be set to true.

FinalUrlSuffix

If the Name element is set to FinalUrlSuffix, then the Value represents your account's Final URL Suffix.

The final URL suffix can include tracking parameters that will be appended to the end of your landing page URL. We recommend placing tracking parameters that your landing page requires in a final URL suffix so that your customers are always sent to your landing page. For more details and validation rules see Final URL Suffix in the technical guides.

To delete the account's Final URL Suffix set the Name to FinalUrlSuffix and the Value to "" (empty string).

IncludeViewThroughConversions

Determines whether you want to include view-through conversions for campaigns in the account.

View-through conversions are conversions that people make after they have seen your ad, even though they did not click the ad.

If the Name element is set to IncludeViewThroughConversions, then the Value can be set to either true or false. If the value is true, then view-through conversions will be included. By default, if you are in the feature pilot (GetCustomerPilotFeatures returns 616) this property is set true, meaning that the values in the "All" conversions columns of your performance reports will include view-through conversions. You can choose to disable it if you don't want to include view-through conversions.

Note

View-through conversions require a UETTag, so this property is not applicable for the AppInstallGoal, InStoreTransactionGoal, and OfflineConversionGoal.

MSCLKIDAutoTaggingEnabled

Determines whether auto-tagging of the MSCLKID query string parameter is enabled. The MSCLKID is a 32-character GUID that is unique for each ad click.

If the Name element is set to MSCLKIDAutoTaggingEnabled, then the Value can be set to either true or false. If the value is true, then the MSCLKID auto tagging feature is enabled. You might want to enable auto-tagging of MSCLKID for tracking leads via offline conversion goals. If auto-tagging of MSCLKID is enabled, the MSCLKID is automatically appended to the landing page URL when a customer clicks on your ad. For example, www.contoso.com/?msclkid={msclkid}. The click ID is unique for each ad click and multiple clicks on the same ad from the same user will result in multiple click IDs.

Important

Every time you add or update a new DurationGoal, EventGoal, OfflineConversionGoal, PagesViewedPerVisitGoal or UrlGoal via either the Microsoft Advertising web application or Campaign Management API, the MSCLKIDAutoTaggingEnabled value of the corresponding AccountProperty is set to true automatically. If the Scope of the goal is set to Customer level, then the AccountProperty for all accounts under the Customer will be set.

ProfileExpansionEnabled

Determines whether to expand LinkedIn profile targeting across your account to reach additional customers similar to the ones you currently target.

Enabling profile targeting expansion allows Microsoft Advertising to show your ads to additional customers similar to the ones you currently target. For example, if you target a specific LinkedIn audience segment, we will also target Bing users who don't have a confirmed LinkedIn account but who share the same characteristics as LinkedIn users in that segment.

If the Name element is set to ProfileExpansionEnabled, then the Value can be set to either true or false. If the value is true, then the LinkedIn profile targeting expansion feature is enabled.

TrackingUrlTemplate

If the Name element is set to TrackingUrlTemplate, then the Value represents your account's tracking template to use as a default for all URLs in your account. The value of the TrackingUrlTemplate key can be set to any valid string as described below.

  • Tracking templates defined for lower level entities e.g. keyword override those set for higher level entities e.g. campaign. For more information, see Entity Limits.

  • The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit.

  • The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}.

  • You must include at least one of the following landing page URL parameters: {lpurl}, {lpurl+2}, {lpurl+3}, {unescapedlpurl}, {escapedlpurl}. Additionally, you can use any dynamic parameter supported by Microsoft Advertising. For a list of supported parameters, see the Available parameters sections within the Microsoft Advertising help article Set up a tracking template.

  • Microsoft Advertising does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the final URL will include the key and value placeholders of your custom parameters without substitution. For example if your tracking template is for example http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}, and neither {_season} or {_promocode} are defined at the campaign, ad group, keyword, or ad level, then the final URL will be the same.

To delete the account's tracking template set the Name to TrackingUrlTemplate and the Value to "" (empty string).

Requirements

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

Used By

GetAccountProperties
SetAccountProperties