CustomParameters Data Object - Campaign Management

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

Syntax

XML

<xs:complexType name="CustomParameters" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Parameters" nillable="true" type="tns:ArrayOfCustomParameter" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "Parameters": [
    {
      "Key": "ValueHere",
      "Value": "ValueHere"
    }
  ]
}

Elements

The CustomParameters object has the following elements: Parameters.

Element	Description	Data Type
Parameters	The collection of key and value custom parameters for URL tracking. For campaigns, ad groups, and ad groups, ad group criterions, and ads Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. For action, price, and sitelink ad extensions Microsoft Advertising will accept the first 3 custom parameter key and value pairs that you include, and any additional custom parameters will be ignored. For customers in the Custom Parameters Limit Increase Phase 3 pilot (GetCustomerPilotFeatures returns 635) for action, price, and sitelink ad extensions, Microsoft Advertising will accept the first 8 custom parameter key and value pairs that you include, and if you include more than 8 custom parameters an error will be returned. Add: Required Update: Optional. Once you create this CustomParameters object, the existing custom parameters will be removed or replaced. To remove all existing custom parameters create this CustomParameters object and set the Parameters element to nil. To replace or append to the list of custom parameters, create this CustomParameters object and assign to the Parameters element a new list of CustomParameter objects, including any previous custom parameters that you want to retain. To retain all of the existing custom parameters, set the element that uses this CustomParameters object to nil. For example set the UrlCustomParameters element of an ExpandedTextAd to nil if you do not want to update any of the custom parameters.CustomParameter array	CustomParameter array

Requirements

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

Used By

ActionAdExtension
Ad
AdGroup
AppAdExtension
BiddableAdGroupCriterion
Campaign
DisclaimerAdExtension
FilterLinkAdExtension
FlyerAdExtension
ImageAdExtension
Keyword
PriceAdExtension
PromotionAdExtension
SitelinkAdExtension
VideoAdExtension