CustomEventsRule Data Object - Campaign Management

Article
11/13/2024

Defines a custom events remarketing rule.

Remarketing rules are conditions used to determine who to add to your remarketing list. For the custom events rule, you must include one or more of the following conditional event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). If more than one condition is specified, the conditions are joined using the logical AND operator. In other words the visitor will only be added to your remarketing list if all of the specified rule conditions are met.

For a detailed example, see the Remarks section below.

XML
JSON

<xs:complexType name="CustomEventsRule" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:RemarketingRule">
      <xs:sequence>
        <xs:element minOccurs="0" name="Action" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ActionOperator" type="tns:StringOperator" />
        <xs:element minOccurs="0" name="Category" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="CategoryOperator" type="tns:StringOperator" />
        <xs:element minOccurs="0" name="Label" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="LabelOperator" type="tns:StringOperator" />
        <xs:element minOccurs="0" name="Value" nillable="true" type="xs:decimal" />
        <xs:element minOccurs="0" name="ValueOperator" type="tns:NumberOperator" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

{
  "Type": "CustomEvents",
  "Action": "ValueHere",
  "ActionOperator": "ValueHere",
  "Category": "ValueHere",
  "CategoryOperator": "ValueHere",
  "Label": "ValueHere",
  "LabelOperator": "ValueHere",
  "Value": DecimalValueHere,
  "ValueOperator": "ValueHere"
}

Elements

The CustomEventsRule object has the following elements: Action, ActionOperator, Category, CategoryOperator, Label, LabelOperator, Value, ValueOperator.

Element	Description	Data Type
Action	The type of user interaction you want to track. For example 'play' or 'pause'. If this element is specified during an add or update operation, then the ActionOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ActionOperator and Action during update, any existing ActionOperator and Action settings will be deleted.	string
ActionOperator	The operator that can be applied to the value of the Action element. If this element is specified during an add or update operation, then the Action element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ActionOperator and Action during update, any existing ActionOperator and Action settings will be deleted.	StringOperator
Category	The category of event you want to track. For example, 'video'. If this element is specified during an add or update operation, then the CategoryOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include CategoryOperator and Category during update, any existing CategoryOperator and Category settings will be deleted.	string
CategoryOperator	The operator that can be applied to the value of the Category element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include CategoryOperator and Category during update, any existing CategoryOperator and Category settings will be deleted.	StringOperator
Label	The name of the element that caused the action. For example 'trailer' or 'behindthescenes'. If this element is specified during an add or update operation, then the LabelOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include LabelOperator and Label during update, any existing LabelOperator and Label settings will be deleted.	string
LabelOperator	The operator that can be applied to the value of the Label element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include LabelOperator and Label during update, any existing LabelOperator and Label settings will be deleted.	StringOperator
Value	A positive integer value associated with that event. For example the value could be the duration of time that the video played. If this element is specified during an add or update operation, then the ValueOperator element is also required. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ValueOperator and Value during update, any existing ValueOperator and Value settings will be deleted	decimal
ValueOperator	The operator that can be applied to the value of the Value element. Add: Optional if you include one or more of the other events; You must include one or more of the following event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). Update: Optional if you include one or more of the other events; If you do not include ValueOperator and Value during update, any existing ValueOperator and Value settings will be deleted.	NumberOperator

The CustomEventsRule object has Inherited Elements.

Inherited Elements

Inherited Elements from RemarketingRule

The CustomEventsRule object derives from the RemarketingRule object, and inherits the following elements: Type. The descriptions below are specific to CustomEventsRule, and might not apply to other objects that inherit the same elements from the RemarketingRule object.

Element	Description	Data Type
Type	The type of the remarketing rule. For more information about remarketing rule types, see the RemarketingRule Data Object Remarks. Add: Read-only Update: Read-only	string

Remarks

For the CustomEvents rule, you must include one or more of the following conditional event operator pairs: (ActionOperator and Action), (CategoryOperator and Category), (LabelOperator and Label), (ValueOperator and Value). If more than one condition is specified, the conditions are joined using the logical AND operator. In other words the visitor will only be added to your remarketing list if all of the specified rule conditions are met.

For example let's say that the following custom events are set.

<Rule i:type="CustomEventsRule">
  <Type i:nil="true" />
  <Action>play</Action>
  <ActionOperator>Equals</ActionOperator>
  <Category>video</Category>
  <CategoryOperator>Equals</CategoryOperator>
  <Label>trailer</Label>
  <LabelOperator>Equals</LabelOperator>
  <Value>5.00</Value>
  <ValueOperator>Equals</ValueOperator>
</Rule>

The above definition is translated to the following logical expression:

(Category Equals video) and (Action Equals play) and (Label Equals trailer) and (Value Equals 5)

Evaluation of the logical expression determines who will be added to the remarketing list.

Requirements

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

Share via