Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1350108168.1 KB
buyers

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

post/v2beta1/{+ownerName}/filterSets

Path parameters

ownerNamestring required

Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

Query parameters

isTransientboolean

Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.

Request body

namestring

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.

format'FORMAT_UNSPECIFIED' | 'NATIVE_DISPLAY' | 'NATIVE_VIDEO' | 'NON_NATIVE_DISPLAY' | 'NON_NATIVE_VIDEO'

Creative format bidded on or allowed to bid on, can be empty.

platformsstring[]

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

breakdownDimensionsstring[]

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.

timeSeriesGranularity'TIME_SERIES_GRANULARITY_UNSPECIFIED' | 'HOURLY' | 'DAILY'

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

dealIdstring int64

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.

sellerNetworkIdsinteger[]

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.

formatsstring[]

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.

creativeIdstring

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.

publisherIdentifiersstring[]

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.

environment'ENVIRONMENT_UNSPECIFIED' | 'WEB' | 'APP'

The environment on which to filter; optional.

Response

Successful response