Predicate Data Object - Customer Billing

Article
11/13/2024

Defines a predicate for the list of insertion orders returned using one of the search operations, for example SearchCoupons or SearchInsertionOrders.

Syntax

XML
JSON

<xs:complexType name="Predicate" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Field" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Operator" type="tns:PredicateOperator" />
    <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

{
  "Field": "ValueHere",
  "Operator": "ValueHere",
  "Value": "ValueHere"
}

Elements

The Predicate object has the following elements: Field, Operator, Value.

Element	Description	Data Type
Field	The name of the element for the object you are searching. For possible values, see the SearchInsertionOrders operation.	string
Operator	Defines the relationship between the field and the value.	PredicateOperator
Value	The string to search in the specified field. The length of this string must be four or greater, unless the field is set to MarketCountry or MarketLanguage.	string

Remarks

The supported Field element and Operator elements of a Predicate object for each service operation are provided in detail below.

SearchCoupons Predicates

For the SearchCoupons service operation, the following are supported Field element and Operator elements of a Predicate object.

Field	Operator	Description
CustomerId	Equals	Use this field to search by the coupon class's owner customer. This predicate field is required.
CouponClassName	Equals	Use this field to search by the coupon class name.
IsRedeemed	Equals	Use this field to search by the coupon's IsRedeemed element.
StartDate	GreaterThanEquals	Use this field to search by coupon start date. The date is stored in Coordinated Universal Time (UTC). Only the month, day, and year of the specified string are used for search. If you specify the hour, minutes, and seconds of a date they will be ignored. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

SearchInsertionOrders Predicates

For the SearchInsertionOrders service operation, the following are supported Field element and Operator elements of a Predicate object.

Field	Operator	Description
AccountId	Equals	Use this field to search by the insertion order's account identifier. This predicate field is required.
EndDate	GreaterThanEquals LessThanEquals	Use this field to search by insertion order end date. The date is stored in Coordinated Universal Time (UTC). Only the month, day, and year of the specified string are used for search. If you specify the hour, minutes, and seconds of a date they will be ignored. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.
InsertionOrderId	Equals In	Use this field to search by insertion order ID.
StartDate	GreaterThanEquals LessThanEquals	Use this field to search by insertion order start date. The date is stored in Coordinated Universal Time (UTC). Only the month, day, and year of the specified string are used for search. If you specify the hour, minutes, and seconds of a date they will be ignored. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Requirements

Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities

Used By

SearchCoupons
SearchInsertionOrders

Share via