class Google::Apis::Adexchangebuyer2V2beta1::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, e.g., “format=VIDEO AND deal_id=12 AND ( seller_network_id=34 OR seller_network_id=56)”.

Attributes

absolute_date_range[RW]

An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail. Corresponds to the JSON property `absoluteDateRange` @return [Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange]

breakdown_dimensions[RW]

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. Corresponds to the JSON property `breakdownDimensions` @return [Array<String>]

creative_id[RW]

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, i.e., one whose name matches the `bidders//accounts//filterSets/*` pattern. Corresponds to the JSON property `creativeId` @return [String]

deal_id[RW]

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, i.e., one whose name matches the `bidders//accounts//filterSets/*` pattern. Corresponds to the JSON property `dealId` @return [Fixnum]

environment[RW]

The environment on which to filter; optional. Corresponds to the JSON property `environment` @return [String]

format[RW]

Creative format bidded on or allowed to bid on, can be empty. Corresponds to the JSON property `format` @return [String]

formats[RW]

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. Corresponds to the JSON property `formats` @return [Array<String>]

name[RW]

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. Corresponds to the JSON property `name` @return [String]

platforms[RW]

The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms). Corresponds to the JSON property `platforms` @return [Array<String>]

publisher_identifiers[RW]

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. Corresponds to the JSON property `publisherIdentifiers` @return [Array<String>]

realtime_time_range[RW]

An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set. Corresponds to the JSON property `realtimeTimeRange` @return [Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange]

relative_date_range[RW]

A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30 Corresponds to the JSON property `relativeDateRange` @return [Google::Apis::Adexchangebuyer2V2beta1::RelativeDateRange]

seller_network_ids[RW]

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 (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](developers.google. com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs. Corresponds to the JSON property `sellerNetworkIds` @return [Array<Fixnum>]

time_series_granularity[RW]

The granularity of time intervals if a time series breakdown is desired; optional. Corresponds to the JSON property `timeSeriesGranularity` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/adexchangebuyer2_v2beta1/classes.rb, line 1657
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/adexchangebuyer2_v2beta1/classes.rb, line 1662
def update!(**args)
  @absolute_date_range = args[:absolute_date_range] if args.key?(:absolute_date_range)
  @breakdown_dimensions = args[:breakdown_dimensions] if args.key?(:breakdown_dimensions)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @deal_id = args[:deal_id] if args.key?(:deal_id)
  @environment = args[:environment] if args.key?(:environment)
  @format = args[:format] if args.key?(:format)
  @formats = args[:formats] if args.key?(:formats)
  @name = args[:name] if args.key?(:name)
  @platforms = args[:platforms] if args.key?(:platforms)
  @publisher_identifiers = args[:publisher_identifiers] if args.key?(:publisher_identifiers)
  @realtime_time_range = args[:realtime_time_range] if args.key?(:realtime_time_range)
  @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range)
  @seller_network_ids = args[:seller_network_ids] if args.key?(:seller_network_ids)
  @time_series_granularity = args[:time_series_granularity] if args.key?(:time_series_granularity)
end