REST Resource: bidders.filterSets

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, e.g., "format=VIDEO AND dealId=12 AND (seller_network_id=34 OR seller_network_id=56)".

JSON representation
{
  "name": string,
  "timeSeriesGranularity": enum(TimeSeriesGranularity),
  "creativeId": string,
  "dealId": string,
  "formats": [
    enum(Format)
  ],
  "environment": enum(Environment),
  "platforms": [
    enum(Platform)
  ],
  "sellerNetworkIds": [
    number
  ],
  "publisherIdentifiers": [
    string
  ],
  "breakdownDimensions": [
    enum(BreakdownDimension)
  ],

  // Union field time_range can be only one of the following:
  "relativeDateRange": {
    object(RelativeDateRange)
  },
  "absoluteDateRange": {
    object(AbsoluteDateRange)
  },
  "realtimeTimeRange": {
    object(RealtimeTimeRange)
  }
  // End of list of possible types for union field time_range.
}
Fields
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.

timeSeriesGranularity

enum(TimeSeriesGranularity)

The granularity of time intervals if a time series breakdown is desired; optional.

creativeId

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.

dealId

string (int64 format)

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.

formats[]

enum(Format)

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

environment

enum(Environment)

The environment on which to filter; optional.

platforms[]

enum(Platform)

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

sellerNetworkIds[]

number

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 file for the set of existing seller network IDs.

publisherIdentifiers[]

string

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[]

enum(BreakdownDimension)

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

object(RelativeDateRange)

A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.

absoluteDateRange

object(AbsoluteDateRange)

An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.

realtimeTimeRange

object(RealtimeTimeRange)

An open-ended realtime time range, defined by the aggregation start timestamp.

Methods

create

Creates the specified filter set for the account with the given account ID.

delete

Deletes the requested filter set from the account with the given account ID.

get

Retrieves the requested filter set for the account with the given account ID.

list

Lists all filter sets for the account with the given account ID.

Send feedback about...

Authorized Buyers
Authorized Buyers