Show / Hide Table of Contents

Class FilterSet

A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".

Inheritance
object
FilterSet
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.AdExchangeBuyerII.v2beta1.Data
Assembly: Google.Apis.AdExchangeBuyerII.v2beta1.dll
Syntax
public class FilterSet : IDirectResponseSchema

Properties

AbsoluteDateRange

An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.

Declaration
[JsonProperty("absoluteDateRange")]
public virtual AbsoluteDateRange AbsoluteDateRange { get; set; }
Property Value
Type Description
AbsoluteDateRange

BreakdownDimensions

The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.

Declaration
[JsonProperty("breakdownDimensions")]
public virtual IList<string> BreakdownDimensions { get; set; }
Property Value
Type Description
IList<string>

CreativeId

The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the bidders/*/accounts/*/filterSets/* pattern.

Declaration
[JsonProperty("creativeId")]
public virtual string CreativeId { get; set; }
Property Value
Type Description
string

DealId

The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the bidders/*/accounts/*/filterSets/* pattern.

Declaration
[JsonProperty("dealId")]
public virtual long? DealId { get; set; }
Property Value
Type Description
long?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Environment

The environment on which to filter; optional.

Declaration
[JsonProperty("environment")]
public virtual string Environment { get; set; }
Property Value
Type Description
string

Format

Creative format bidded on or allowed to bid on, can be empty.

Declaration
[JsonProperty("format")]
public virtual string Format { get; set; }
Property Value
Type Description
string

Formats

Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.

Declaration
[JsonProperty("formats")]
public virtual IList<string> Formats { get; set; }
Property Value
Type Description
IList<string>

Name

A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - bidders/*/filterSets/* (for accessing bidder-level troubleshooting data) - bidders/*/accounts/*/filterSets/* (for accessing account-level troubleshooting data) This field is required in create operations.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Platforms

The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms).

Declaration
[JsonProperty("platforms")]
public virtual IList<string> Platforms { get; set; }
Property Value
Type Description
IList<string>

PublisherIdentifiers

For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.

Declaration
[JsonProperty("publisherIdentifiers")]
public virtual IList<string> PublisherIdentifiers { get; set; }
Property Value
Type Description
IList<string>

RealtimeTimeRange

An open-ended realtime time range, defined by the aggregation start timestamp.

Declaration
[JsonProperty("realtimeTimeRange")]
public virtual RealtimeTimeRange RealtimeTimeRange { get; set; }
Property Value
Type Description
RealtimeTimeRange

RelativeDateRange

A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.

Declaration
[JsonProperty("relativeDateRange")]
public virtual RelativeDateRange RelativeDateRange { get; set; }
Property Value
Type Description
RelativeDateRange

SellerNetworkIds

For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See seller-network-ids file for the set of existing seller network IDs.

Declaration
[JsonProperty("sellerNetworkIds")]
public virtual IList<int?> SellerNetworkIds { get; set; }
Property Value
Type Description
IList<int?>

TimeSeriesGranularity

The granularity of time intervals if a time series breakdown is preferred; optional.

Declaration
[JsonProperty("timeSeriesGranularity")]
public virtual string TimeSeriesGranularity { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX