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



1582
1583
1584
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1582

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

Instance Attribute Details

#absolute_date_range ⇒ Google::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

Returns:



1518
1519
1520
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1518

def absolute_date_range
  @absolute_date_range
end

#buyer_account_id ⇒ Fixnum

The ID of the buyer account on which to filter; optional. Corresponds to the JSON property buyerAccountId

Returns:

  • (Fixnum) 


1523
1524
1525
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1523

def 
  @buyer_account_id
end

#creative_id ⇒ String

The ID of the creative on which to filter; optional. Corresponds to the JSON property creativeId

Returns:

  • (String) 


1563
1564
1565
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1563

def creative_id
  @creative_id
end

#deal_id ⇒ Fixnum

The ID of the deal on which to filter; optional. Corresponds to the JSON property dealId

Returns:

  • (Fixnum) 


1533
1534
1535
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1533

def deal_id
  @deal_id
end

#environment ⇒ String

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

Returns:

  • (String) 


1528
1529
1530
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1528

def environment
  @environment
end

#filter_set_id ⇒ Fixnum

The ID of the filter set; unique within the account of the filter set owner. The value of this field is ignored in create operations. Corresponds to the JSON property filterSetId

Returns:

  • (Fixnum) 


1551
1552
1553
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1551

def filter_set_id
  @filter_set_id
end

#format ⇒ String

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

Returns:

  • (String) 


1538
1539
1540
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1538

def format
  @format
end

#owner_account_id ⇒ Fixnum

The account ID of the buyer who owns this filter set. The value of this field is ignored in create operations. Corresponds to the JSON property ownerAccountId

Returns:

  • (Fixnum) 


1509
1510
1511
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1509

def 
  @owner_account_id
end

#platforms ⇒ Array<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>) 


1570
1571
1572
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1570

def platforms
  @platforms
end

#realtime_time_range ⇒ Google::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

Returns:



1558
1559
1560
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1558

def realtime_time_range
  @realtime_time_range
end

#relative_date_range ⇒ Google::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

Returns:



1580
1581
1582
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1580

def relative_date_range
  @relative_date_range
end

#seller_network_ids ⇒ Array<Fixnum>

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


1503
1504
1505
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1503

def seller_network_ids
  @seller_network_ids
end

#time_series_granularity ⇒ String

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

Returns:

  • (String) 


1544
1545
1546
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1544

def time_series_granularity
  @time_series_granularity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 1587

def update!(**args)
  @seller_network_ids = args[:seller_network_ids] if args.key?(:seller_network_ids)
  @owner_account_id = args[:owner_account_id] if args.key?(:owner_account_id)
  @absolute_date_range = args[:absolute_date_range] if args.key?(:absolute_date_range)
  @buyer_account_id = args[:buyer_account_id] if args.key?(:buyer_account_id)
  @environment = args[:environment] if args.key?(:environment)
  @deal_id = args[:deal_id] if args.key?(:deal_id)
  @format = args[:format] if args.key?(:format)
  @time_series_granularity = args[:time_series_granularity] if args.key?(:time_series_granularity)
  @filter_set_id = args[:filter_set_id] if args.key?(:filter_set_id)
  @realtime_time_range = args[:realtime_time_range] if args.key?(:realtime_time_range)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @platforms = args[:platforms] if args.key?(:platforms)
  @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range)
end