FilterSet (Ad Exchange Buyer API II v2beta1-rev20210613-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.adexchangebuyer2.v2beta1.model.FilterSet

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class FilterSet
extends GenericJson
```
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)".
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Ad Exchange Buyer API II. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

FilterSet()

Constructors
Constructor and Description
`FilterSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FilterSet`	`clone()`
`AbsoluteDateRange`	`getAbsoluteDateRange()` An absolute date range, defined by a start date and an end date.
`List<String>`	`getBreakdownDimensions()` The set of dimensions along which to break down the response; may be empty.
`String`	`getCreativeId()` The ID of the creative on which to filter; optional.
`Long`	`getDealId()` The ID of the deal on which to filter; optional.
`String`	`getEnvironment()` The environment on which to filter; optional.
`String`	`getFormat()` Creative format bidded on or allowed to bid on, can be empty.
`List<String>`	`getFormats()` Creative formats bidded on or allowed to bid on, can be empty.
`String`	`getName()` A user-defined name of the filter set.
`List<String>`	`getPlatforms()` The list of platforms on which to filter; may be empty.
`List<String>`	`getPublisherIdentifiers()` For Open Bidding partners only.
`RealtimeTimeRange`	`getRealtimeTimeRange()` An open-ended realtime time range, defined by the aggregation start timestamp.
`RelativeDateRange`	`getRelativeDateRange()` A relative date range, defined by an offset from today and a duration.
`List<Integer>`	`getSellerNetworkIds()` For Authorized Buyers only.
`String`	`getTimeSeriesGranularity()` The granularity of time intervals if a time series breakdown is desired; optional.
`FilterSet`	`set(String fieldName, Object value)`
`FilterSet`	`setAbsoluteDateRange(AbsoluteDateRange absoluteDateRange)` An absolute date range, defined by a start date and an end date.
`FilterSet`	`setBreakdownDimensions(List<String> breakdownDimensions)` The set of dimensions along which to break down the response; may be empty.
`FilterSet`	`setCreativeId(String creativeId)` The ID of the creative on which to filter; optional.
`FilterSet`	`setDealId(Long dealId)` The ID of the deal on which to filter; optional.
`FilterSet`	`setEnvironment(String environment)` The environment on which to filter; optional.
`FilterSet`	`setFormat(String format)` Creative format bidded on or allowed to bid on, can be empty.
`FilterSet`	`setFormats(List<String> formats)` Creative formats bidded on or allowed to bid on, can be empty.
`FilterSet`	`setName(String name)` A user-defined name of the filter set.
`FilterSet`	`setPlatforms(List<String> platforms)` The list of platforms on which to filter; may be empty.
`FilterSet`	`setPublisherIdentifiers(List<String> publisherIdentifiers)` For Open Bidding partners only.
`FilterSet`	`setRealtimeTimeRange(RealtimeTimeRange realtimeTimeRange)` An open-ended realtime time range, defined by the aggregation start timestamp.
`FilterSet`	`setRelativeDateRange(RelativeDateRange relativeDateRange)` A relative date range, defined by an offset from today and a duration.
`FilterSet`	`setSellerNetworkIds(List<Integer> sellerNetworkIds)` For Authorized Buyers only.
`FilterSet`	`setTimeSeriesGranularity(String timeSeriesGranularity)` The granularity of time intervals if a time series breakdown is desired; optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - FilterSet
```
public FilterSet()
```
- Method Detail
  - getAbsoluteDateRange
```
public AbsoluteDateRange getAbsoluteDateRange()
```
    An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
    
    Returns:
    
    value or null for none
  - setAbsoluteDateRange
```
public FilterSet setAbsoluteDateRange(AbsoluteDateRange absoluteDateRange)
```
    An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
    
    Parameters:
    
    absoluteDateRange - absoluteDateRange or null for none
  - getBreakdownDimensions
```
public List<String> getBreakdownDimensions()
```
    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.
    
    Returns:
    
    value or null for none
  - setBreakdownDimensions
```
public FilterSet setBreakdownDimensions(List<String> breakdownDimensions)
```
    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.
    
    Parameters:
    
    breakdownDimensions - breakdownDimensions or null for none
  - getCreativeId
```
public String getCreativeId()
```
    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.
    
    Returns:
    
    value or null for none
  - setCreativeId
```
public FilterSet setCreativeId(String creativeId)
```
    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.
    
    Parameters:
    
    creativeId - creativeId or null for none
  - getDealId
```
public Long getDealId()
```
    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.
    
    Returns:
    
    value or null for none
  - setDealId
```
public FilterSet setDealId(Long dealId)
```
    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.
    
    Parameters:
    
    dealId - dealId or null for none
  - getEnvironment
```
public String getEnvironment()
```
    The environment on which to filter; optional.
    
    Returns:
    
    value or null for none
  - setEnvironment
```
public FilterSet setEnvironment(String environment)
```
    The environment on which to filter; optional.
    
    Parameters:
    
    environment - environment or null for none
  - getFormat
```
public String getFormat()
```
    Creative format bidded on or allowed to bid on, can be empty.
    
    Returns:
    
    value or null for none
  - setFormat
```
public FilterSet setFormat(String format)
```
    Creative format bidded on or allowed to bid on, can be empty.
    
    Parameters:
    
    format - format or null for none
  - getFormats
```
public List<String> getFormats()
```
    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.
    
    Returns:
    
    value or null for none
  - setFormats
```
public FilterSet setFormats(List<String> formats)
```
    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.
    
    Parameters:
    
    formats - formats or null for none
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    value or null for none
  - setName
```
public FilterSet setName(String name)
```
    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.
    
    Parameters:
    
    name - name or null for none
  - getPlatforms
```
public List<String> getPlatforms()
```
    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).
    
    Returns:
    
    value or null for none
  - setPlatforms
```
public FilterSet setPlatforms(List<String> platforms)
```
    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).
    
    Parameters:
    
    platforms - platforms or null for none
  - getPublisherIdentifiers
```
public List<String> getPublisherIdentifiers()
```
    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.
    
    Returns:
    
    value or null for none
  - setPublisherIdentifiers
```
public FilterSet setPublisherIdentifiers(List<String> publisherIdentifiers)
```
    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.
    
    Parameters:
    
    publisherIdentifiers - publisherIdentifiers or null for none
  - getRealtimeTimeRange
```
public RealtimeTimeRange getRealtimeTimeRange()
```
    An open-ended realtime time range, defined by the aggregation start timestamp.
    
    Returns:
    
    value or null for none
  - setRealtimeTimeRange
```
public FilterSet setRealtimeTimeRange(RealtimeTimeRange realtimeTimeRange)
```
    An open-ended realtime time range, defined by the aggregation start timestamp.
    
    Parameters:
    
    realtimeTimeRange - realtimeTimeRange or null for none
  - getRelativeDateRange
```
public RelativeDateRange getRelativeDateRange()
```
    A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
    
    Returns:
    
    value or null for none
  - setRelativeDateRange
```
public FilterSet setRelativeDateRange(RelativeDateRange relativeDateRange)
```
    A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
    
    Parameters:
    
    relativeDateRange - relativeDateRange or null for none
  - getSellerNetworkIds
```
public List<Integer> getSellerNetworkIds()
```
    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](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
    
    Returns:
    
    value or null for none
  - setSellerNetworkIds
```
public FilterSet setSellerNetworkIds(List<Integer> sellerNetworkIds)
```
    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](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
    
    Parameters:
    
    sellerNetworkIds - sellerNetworkIds or null for none
  - getTimeSeriesGranularity
```
public String getTimeSeriesGranularity()
```
    The granularity of time intervals if a time series breakdown is desired; optional.
    
    Returns:
    
    value or null for none
  - setTimeSeriesGranularity
```
public FilterSet setTimeSeriesGranularity(String timeSeriesGranularity)
```
    The granularity of time intervals if a time series breakdown is desired; optional.
    
    Parameters:
    
    timeSeriesGranularity - timeSeriesGranularity or null for none
  - set
```
public FilterSet set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public FilterSet clone()
```
    Overrides:
    
    clone in class GenericJson

Class FilterSet

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

FilterSet

Method Detail

getAbsoluteDateRange

setAbsoluteDateRange

getBreakdownDimensions

setBreakdownDimensions

getCreativeId

setCreativeId

getDealId

setDealId

getEnvironment

setEnvironment

getFormat

setFormat

getFormats

setFormats

getName

setName

getPlatforms

setPlatforms

getPublisherIdentifiers

setPublisherIdentifiers

getRealtimeTimeRange

setRealtimeTimeRange

getRelativeDateRange

setRelativeDateRange

getSellerNetworkIds

setSellerNetworkIds

getTimeSeriesGranularity

setTimeSeriesGranularity

set

clone