FilterSet

import type { FilterSet } from "https://googleapis.deno.dev/v1/adexchangebuyer2:v2beta1.ts";

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 deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".

interface FilterSet {

absoluteDateRange?: AbsoluteDateRange;

breakdownDimensions?: "BREAKDOWN_DIMENSION_UNSPECIFIED" | "PUBLISHER_IDENTIFIER"[];

creativeId?: string;

dealId?: bigint;

environment?: "ENVIRONMENT_UNSPECIFIED" | "WEB" | "APP";

format?:

| "FORMAT_UNSPECIFIED"

| "NATIVE_DISPLAY"

| "NATIVE_VIDEO"

| "NON_NATIVE_DISPLAY"

| "NON_NATIVE_VIDEO";

formats?:

| "FORMAT_UNSPECIFIED"

| "NATIVE_DISPLAY"

| "NATIVE_VIDEO"

| "NON_NATIVE_DISPLAY"

| "NON_NATIVE_VIDEO"[];

name?: string;

platforms?:

| "PLATFORM_UNSPECIFIED"

| "DESKTOP"

| "TABLET"

| "MOBILE"[];

publisherIdentifiers?: string[];

realtimeTimeRange?: RealtimeTimeRange;

relativeDateRange?: RelativeDateRange;

sellerNetworkIds?: number[];

timeSeriesGranularity?: "TIME_SERIES_GRANULARITY_UNSPECIFIED" | "HOURLY" | "DAILY";

}

§Properties

absoluteDateRange?: AbsoluteDateRange

[src]

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

breakdownDimensions?: "BREAKDOWN_DIMENSION_UNSPECIFIED" | "PUBLISHER_IDENTIFIER"[]

[src]

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.

creativeId?: string

[src]

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?: bigint

[src]

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.

environment?: "ENVIRONMENT_UNSPECIFIED" | "WEB" | "APP"

[src]

The environment on which to filter; optional.

format?: "FORMAT_UNSPECIFIED" | "NATIVE_DISPLAY" | "NATIVE_VIDEO" | "NON_NATIVE_DISPLAY" | "NON_NATIVE_VIDEO"

[src]

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

formats?: "FORMAT_UNSPECIFIED" | "NATIVE_DISPLAY" | "NATIVE_VIDEO" | "NON_NATIVE_DISPLAY" | "NON_NATIVE_VIDEO"[]

[src]

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.

name?: string

[src]

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.

platforms?: "PLATFORM_UNSPECIFIED" | "DESKTOP" | "TABLET" | "MOBILE"[]

[src]

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

publisherIdentifiers?: string[]

[src]

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.

realtimeTimeRange?: RealtimeTimeRange

[src]

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

relativeDateRange?: RelativeDateRange

[src]

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

sellerNetworkIds?: number[]

[src]

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.

timeSeriesGranularity?: "TIME_SERIES_GRANULARITY_UNSPECIFIED" | "HOURLY" | "DAILY"

[src]

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