Edit

Share via

CustomParameter Data Object - Campaign Management

  • Article

Defines a key and value custom parameter for URL tracking. Used for campaign, ad group, ad, keyword, sitelink, and ad group criterion URL custom parameters.

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

Elements

The CustomParameter object has the following elements: Key, Value.

Element Description Data Type
Key The name of the custom parameter that you want to track.

The maximum length of this string is 16, in UTF-8 bytes. With the Campaign Management service you may not specify special characters such as braces and underscore: "{", "_", and "}". With the Bulk service the surrounding braces and underscore are required. The maximum length of 16 UTF-8 bytes does not include the optional braces and underscore: "{", "_", and "}".

Add: Required
Update: Required		 string
Value The value to track using your custom parameter.

The maximum length of this string is 200, in UTF-8 bytes. You can set the value to an empty string ("") but it cannot be null or empty.

The maximum length of the value string is 250 for all entities except action, price, and sitelink ad extensions. The maximum length of the value string is 200 for action, price, and sitelink ad extensions. For action, price, and sitelink ad extensions, the maximum length increases to 250 for customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635).

Add: Required
Update: Required		 string

Requirements

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

Used By

CustomParameters