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



936
937
938
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 936

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:



851
852
853
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 851

def absolute_date_range
  @absolute_date_range
end

#creative_id ⇒ String

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

Returns:

  • (String) 


858
859
860
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 858

def creative_id
  @creative_id
end

#deal_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


865
866
867
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 865

def deal_id
  @deal_id
end

#environment ⇒ String

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

Returns:

  • (String) 


870
871
872
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 870

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) 


877
878
879
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 877

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) 


882
883
884
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 882

def format
  @format
end

#name ⇒ String

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 buyer-level troubleshooting data) This field is required in create operations. Corresponds to the JSON property name

Returns:

  • (String) 


893
894
895
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 893

def name
  @name
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>) 


900
901
902
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 900

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:



907
908
909
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 907

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:



917
918
919
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 917

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


928
929
930
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 928

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) 


934
935
936
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 934

def time_series_granularity
  @time_series_granularity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 941

def update!(**args)
  @absolute_date_range = args[:absolute_date_range] if args.key?(:absolute_date_range)
  @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)
  @filter_set_id = args[:filter_set_id] if args.key?(:filter_set_id)
  @format = args[:format] if args.key?(:format)
  @name = args[:name] if args.key?(:name)
  @platforms = args[:platforms] if args.key?(:platforms)
  @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