PageVisitorsRule Data Object - Campaign Management

Article
03/20/2023

Defines a page visitors remarketing rule.

Remarketing rules are conditions used to determine who to add to your remarketing list. For the PageVisitors rule, you must include one or more rule item groups.

Important

During calendar year 2021 we added support for conjunctive normal form (CNF). Previously Microsoft Advertising only supported disjunctive normal form (DNF). The default normal form for a new page visitors rule remains DNF. However, you must ensure that your application can appropriately read and distinguish between CNF and DNF. Your application should no longer assume that the rule is disjunctive.

If the normal form is conjunctive (CNF), the rule item conditions for the same page are first joined using the logical OR operator. Then, each result from the list of rule item groups are joined using the logical AND operator. In other words the user will be added to your remarketing list if any of the specified rule item conditions within all of the rule item groups are met.

If the normal form is disjunctive (DNF), the rule item conditions for the same page are first joined using the logical AND operator. Then, each result from the list of rule item groups are joined using the logical OR operator. In other words the user will be added to your remarketing list if all of the specified rule item conditions within any one of the rule item groups are met.

For a detailed example, see the Remarks section below.

Syntax

<xs:complexType name="PageVisitorsRule" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:RemarketingRule">
      <xs:sequence>
        <xs:element minOccurs="0" name="NormalForm" nillable="true" type="tns:NormalForm">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="RuleItemGroups" nillable="true" type="tns:ArrayOfRuleItemGroup" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The PageVisitorsRule object has the following elements: NormalForm, RuleItemGroups.

Element	Description	Data Type
NormalForm	Determines whether the rule item groups are evaluated based on conjunctive normal form (CNF) or disjunctive normal form (DNF). This element is not returned by default. To get this element, include the NormalForm value in the ReturnAdditionalFields element when you call the GetAudiencesByIds service operation. Add: Optional. The default value is "Disjunctive". Update: Optional	NormalForm
RuleItemGroups	The list of rule item groups that you want applied to the remarketing list. The maximum number of rule item groups in this element is 100. The maximum number of rule items per rule item group is 100. Add: Required Update: Required. If you want to keep any of the previous rule item groups, then you must explicitly set them again during update.	RuleItemGroup array

The PageVisitorsRule object has Inherited Elements.

Inherited Elements

Inherited Elements from RemarketingRule

The PageVisitorsRule object derives from the RemarketingRule object, and inherits the following elements: Type. The descriptions below are specific to PageVisitorsRule, 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

Remarketing rules are conditions used to determine who to add to your remarketing list. For the PageVisitors rule, you must include one or more rule item groups.

Important

For an example of disjunctive normal form evaluation, let's say that the following rule item groups are set.

<Rule i:type="PageVisitorsRule">
  <Type i:nil="true" />
  <NormalForm i:nil="true" />
  <RuleItemGroups>
    <RuleItemGroup>
      <Items>
        <RuleItem i:type="StringRuleItem">
          <Type i:nil="true" />
          <Operand>Url</Operand>
          <Operator>Contains</Operator>
          <Value>X</Value>
        </RuleItem>
        <RuleItem i:type="StringRuleItem">
          <Type i:nil="true" />
          <Operand>ReferrerUrl</Operand>
          <Operator>DoesNotContain</Operator>
          <Value>Z</Value>
        </RuleItem>
      </Items>
    </RuleItemGroup>
    <RuleItemGroup>
      <Items>
        <RuleItem i:type="StringRuleItem">
          <Type i:nil="true" />
          <Operand>Url</Operand>
          <Operator>DoesNotBeginWith</Operator>
          <Value>Y</Value>
        </RuleItem>
      </Items>
    </RuleItemGroup>
    <RuleItemGroup>
      <Items>
        <RuleItem i:type="StringRuleItem">
          <Type i:nil="true" />
          <Operand>ReferrerUrl</Operand>
          <Operator>Equals</Operator>
          <Value>Z</Value>
        </RuleItem>
      </Items>
    </RuleItemGroup>
  </RuleItemGroups>
</Rule>

The above definition is translated to the following logical expression:

((Url Contains X) and (ReferrerUrl DoesNotContain Z)) or ((Url DoesNotBeginWith Y)) or ((ReferrerUrl Equals Z))

Evaluation of the logical expression determines which of the following example users will be added to the remarketing list.

User	Url Visited	Referrer Url	Added to List
User 1	A	X	Yes. Evaluation of the logical expression results as True. ((Url Contains X) and (ReferrerUrl DoesNotContain Z)) or ((Url DoesNotBeginWith Y)) or ((ReferrerUrl Equals Z)) (False and True) or (True) or (False) False or True or False True
User 2	B	Y	No. Evaluation of the logical expression results as False. ((Url Contains X) and (ReferrerUrl DoesNotContain Z)) or ((Url DoesNotBeginWith Y)) or ((ReferrerUrl Equals Z)) (False and True) or (False) or (False) False or False or False False
User 3	C	Z	Yes. Evaluation of the logical expression results as True. ((Url Contains X) and (ReferrerUrl DoesNotContain Z)) or ((Url DoesNotBeginWith Y)) or ((ReferrerUrl Equals Z)) (False and False) or (True) or (True) False or True or True True

Requirements

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