Class: Google::Apis::Adexchangebuyer2V2beta1::FilterSet
- Inherits:
-
Object
- Object
- Google::Apis::Adexchangebuyer2V2beta1::FilterSet
- 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
-
#absolute_date_range ⇒ Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange
An absolute date range, specified by its start date and end date.
-
#creative_id ⇒ String
The ID of the creative on which to filter; optional.
-
#deal_id ⇒ Fixnum
The ID of the deal on which to filter; optional.
-
#environment ⇒ String
The environment on which to filter; optional.
-
#formats ⇒ Array<String>
The list of formats on which to filter; may be empty.
-
#name ⇒ String
A user-defined name of the filter set.
-
#platforms ⇒ Array<String>
The list of platforms on which to filter; may be empty.
-
#publisher_identifiers ⇒ Array<String>
For Exchange Bidding buyers only.
-
#realtime_time_range ⇒ Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange
An open-ended realtime time range specified by the start timestamp.
-
#relative_date_range ⇒ Google::Apis::Adexchangebuyer2V2beta1::RelativeDateRange
A relative date range, specified by an offset and a duration.
-
#seller_network_ids ⇒ Array<Fixnum>
For Ad Exchange buyers only.
-
#time_series_granularity ⇒ String
The granularity of time intervals if a time series breakdown is desired; optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FilterSet
constructor
A new instance of FilterSet.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ FilterSet
Returns a new instance of FilterSet
944 945 946 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 944 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
853 854 855 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 853 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 account-level troubleshooting data,
i.e. one whose name matches the bidders/*/accounts/*/filterSets/*
pattern.
Corresponds to the JSON property creativeId
861 862 863 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 861 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 account-level troubleshooting data,
i.e. one whose name matches the bidders/*/accounts/*/filterSets/*
pattern.
Corresponds to the JSON property dealId
869 870 871 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 869 def deal_id @deal_id end |
#environment ⇒ String
The environment on which to filter; optional.
Corresponds to the JSON property environment
874 875 876 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 874 def environment @environment end |
#formats ⇒ Array<String>
The list of formats on which to filter; may be empty. The filters
represented by multiple formats are ORed together (i.e. if non-empty,
results must match any one of the formats).
Corresponds to the JSON property formats
881 882 883 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 881 def formats @formats 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 account-level troubleshooting data) This field is required in create operations. Corresponds to the JSON propertyname
892 893 894 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 892 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
899 900 901 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 899 def platforms @platforms end |
#publisher_identifiers ⇒ Array<String>
For Exchange Bidding buyers 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
907 908 909 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 907 def publisher_identifiers @publisher_identifiers 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
914 915 916 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 914 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
924 925 926 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 924 def relative_date_range @relative_date_range end |
#seller_network_ids ⇒ Array<Fixnum>
For Ad Exchange 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
936 937 938 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 936 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
942 943 944 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 942 def time_series_granularity @time_series_granularity end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
949 950 951 952 953 954 955 956 957 958 959 960 961 962 |
# File 'generated/google/apis/adexchangebuyer2_v2beta1/classes.rb', line 949 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) @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 |