Class: Google::Apis::Adexchangebuyer2V2beta1::FilterSet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/adexchangebuyer2_v2beta1/classes.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb,
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb

Overview

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)".

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FilterSet

Returns a new instance of FilterSet.



1718
1719
1720
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1718

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#absolute_date_rangeGoogle::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange

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



1614
1615
1616
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1614

def absolute_date_range
  @absolute_date_range
end

#breakdown_dimensionsArray<String>

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

Returns:

  • (Array<String>)


1621
1622
1623
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1621

def breakdown_dimensions
  @breakdown_dimensions
end

#creative_idString

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

Returns:

  • (String)


1629
1630
1631
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1629

def creative_id
  @creative_id
end

#deal_idFixnum

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

Returns:

  • (Fixnum)


1637
1638
1639
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1637

def deal_id
  @deal_id
end

#environmentString

The environment on which to filter; optional. Corresponds to the JSON property environment

Returns:

  • (String)


1642
1643
1644
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1642

def environment
  @environment
end

#formatString

Creative format bidded on or allowed to bid on, can be empty. Corresponds to the JSON property format

Returns:

  • (String)


1647
1648
1649
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1647

def format
  @format
end

#formatsArray<String>

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

Returns:

  • (Array<String>)


1655
1656
1657
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1655

def formats
  @formats
end

#nameString

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

Returns:

  • (String)


1666
1667
1668
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1666

def name
  @name
end

#platformsArray<String>

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

Returns:

  • (Array<String>)


1673
1674
1675
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1673

def platforms
  @platforms
end

#publisher_identifiersArray<String>

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

Returns:

  • (Array<String>)


1681
1682
1683
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1681

def publisher_identifiers
  @publisher_identifiers
end

#realtime_time_rangeGoogle::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange

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



1688
1689
1690
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1688

def realtime_time_range
  @realtime_time_range
end

#relative_date_rangeGoogle::Apis::Adexchangebuyer2V2beta1::RelativeDateRange

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



1698
1699
1700
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1698

def relative_date_range
  @relative_date_range
end

#seller_network_idsArray<Fixnum>

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 file for the set of existing seller network IDs. Corresponds to the JSON property sellerNetworkIds

Returns:

  • (Array<Fixnum>)


1710
1711
1712
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1710

def seller_network_ids
  @seller_network_ids
end

#time_series_granularityString

The granularity of time intervals if a time series breakdown is desired; optional. Corresponds to the JSON property timeSeriesGranularity

Returns:

  • (String)


1716
1717
1718
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1716

def time_series_granularity
  @time_series_granularity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1723

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