Skip to main content

filter_sets

Overview

Namefilter_sets
TypeResource
Idgoogleads.adexchangebuyer2.filter_sets

Fields

NameDatatypeDescription
namestringA 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.
sellerNetworkIdsarrayFor 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.
platformsarrayThe 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).
timeSeriesGranularitystringThe granularity of time intervals if a time series breakdown is preferred; optional.
creativeIdstringThe 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.
realtimeTimeRangeobjectAn 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.
environmentstringThe environment on which to filter; optional.
formatstringCreative format bidded on or allowed to bid on, can be empty.
breakdownDimensionsarrayThe 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.
publisherIdentifiersarrayFor 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.
relativeDateRangeobjectA 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: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30
formatsarrayCreative 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.
dealIdstringThe 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.
absoluteDateRangeobjectAn 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.

Methods

NameAccessible byRequired ParamsDescription
bidders_accounts_filterSets_getSELECTaccountsId, biddersId, filterSetsIdRetrieves the requested filter set for the account with the given account ID.
bidders_accounts_filterSets_listSELECTaccountsId, biddersIdLists all filter sets for the account with the given account ID.
bidders_filterSets_getSELECTbiddersId, filterSetsIdRetrieves the requested filter set for the account with the given account ID.
bidders_filterSets_listSELECTbiddersIdLists all filter sets for the account with the given account ID.
bidders_accounts_filterSets_createINSERTaccountsId, biddersIdCreates the specified filter set for the account with the given account ID.
bidders_filterSets_createINSERTbiddersIdCreates the specified filter set for the account with the given account ID.
bidders_accounts_filterSets_deleteDELETEaccountsId, biddersId, filterSetsIdDeletes the requested filter set from the account with the given account ID.
bidders_filterSets_deleteDELETEbiddersId, filterSetsIdDeletes the requested filter set from the account with the given account ID.