Resource: FilterSet
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, for example, "format=VIDEO AND dealId=12 AND (seller_network_id=34 OR seller_network_id=56)".
JSON representation | |
---|---|
{ "name": string, "timeSeriesGranularity": enum ( |
Fields | ||
---|---|---|
name |
A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns:
This field is required in create operations. |
|
timeSeriesGranularity |
The granularity of time intervals if a time series breakdown is preferred; optional. |
|
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, for example, one whose name matches the |
|
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, for example, one whose name matches the |
|
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. |
|
format |
Creative format bidded on or allowed to bid on, can be empty. |
|
environment |
The environment on which to filter; optional. |
|
platforms[] |
The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms). |
|
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 (for example, 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. |
|
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. |
|
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. |
|
Union field time_range . The time range for the filter set; can be specified as a relative date range, an absolute date range, or an open-ended real-time time range. time_range can be only one of the following: |
||
relativeDateRange |
A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone. |
|
absoluteDateRange |
An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone. |
|
realtimeTimeRange |
An open-ended realtime time range, defined by the aggregation start timestamp. |
Methods |
|
---|---|
|
Creates the specified filter set for the account with the given account ID. |
|
Deletes the requested filter set from the account with the given account ID. |
|
Retrieves the requested filter set for the account with the given account ID. |
|
Lists all filter sets for the account with the given account ID. |