REST Resource: bidders.accounts.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, for example, "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)
  ],
  "format": enum (Format),
  "environment": enum (Environment),
  "platforms": [
    enum (Platform)
  ],
  "sellerNetworkIds": [
    integer
  ],
  "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 preferred; 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, for example, 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, for example, one whose name matches the bidders/*/accounts/*/filterSets/* pattern.
formats[]
(deprecated)

enum (Format)

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

enum (Format)

Creative format bidded on or allowed to bid on, can be empty.
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 (for example, if non-empty, results must match any one of the platforms).
sellerNetworkIds[]

integer

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

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.

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, for example, the limits for these values are: offsetDays >= 0 durationDays >= 1 offsetDays + durationDays <= 30

JSON representation 
{
  "offsetDays": integer,
  "durationDays": integer
}
Fields
offsetDays

integer

The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0.
durationDays

integer

The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7.

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 startDate, it will fail.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
startDate

object (Date)

The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before endDate.
endDate

object (Date)

The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after startDate.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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.

JSON representation 
{
  "startTimestamp": string
}
Fields
startTimestamp

string (Timestamp format)

The start timestamp of the real-time RTB metrics aggregation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

TimeSeriesGranularity

The granularity of time intervals for a time series.

Enums
TIME_SERIES_GRANULARITY_UNSPECIFIED A placeholder for an unspecified interval; no time series is applied. All rows in response will contain data for the entire requested time range.
HOURLY Indicates that data will be broken down by the hour.
DAILY Indicates that data will be broken down by the day.

Format

The format of the ad impression.

Enums
FORMAT_UNSPECIFIED A placeholder for an undefined format; indicates that no format filter will be applied.
NATIVE_DISPLAY The ad impression is a native ad, and display (for example, image) format.
NATIVE_VIDEO The ad impression is a native ad, and video format.
NON_NATIVE_DISPLAY The ad impression is not a native ad, and display (for example, image) format.
NON_NATIVE_VIDEO The ad impression is not a native ad, and video format.

Environment

An environment in which the ad impression appears.

Enums
ENVIRONMENT_UNSPECIFIED A placeholder for an undefined environment; indicates that no environment filter will be applied.
WEB The ad impression appears on the web.
APP The ad impression appears in an app.

Platform

The platform on which the ad impression appears.

Enums
PLATFORM_UNSPECIFIED A placeholder for an undefined platform; indicates that no platform filter will be applied.
DESKTOP The ad impression appears on a desktop.
TABLET The ad impression appears on a tablet.
MOBILE The ad impression appears on a mobile device.

BreakdownDimension

The dimensions along which a breakdown may be requested.

Enums
BREAKDOWN_DIMENSION_UNSPECIFIED A placeholder for an unspecified dimension; should not be used.
PUBLISHER_IDENTIFIER The response should be broken down by publisher identifier. This option is available only for Open Bidding buyers.

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.