Bid Manager API v1.1 is deprecated and will sunset on April 27, 2023.

Migrate to v2 to avoid service interruption. See our migration guide for steps in migrating to v2.

Parameters

Stay organized with collections Save and categorize content based on your preferences.

Parameters of a query or report.

JSON representation 
{
  "type": enum (ReportType),
  "groupBys": [
    string
  ],
  "filters": [
    {
      object (FilterPair)
    }
  ],
  "metrics": [
    string
  ],
  "options": {
    object (Options)
  }
}
Fields
type

enum (ReportType)

The type of the report.

The type of the report will dictate what dimesions, filters, and metrics can be used.
groupBys[]

string

Data is grouped by the filters listed in this field.
filters[]

object (FilterPair)

Filters used to match traffic data in your report.
metrics[]

string

Metrics to include as columns in your report.
options

object (Options)

Additional query options.

ReportType

Possible types of report.

Enums
REPORT_TYPE_UNSPECIFIED Default value when report type is not specified or is unknown in this version.
STANDARD Standard report.
INVENTORY_AVAILABILITY Inventory Availability report.
AUDIENCE_COMPOSITION Audience Composition report.
FLOODLIGHT Floodlight report.
YOUTUBE YouTube report.
GRP GRP report.
YOUTUBE_PROGRAMMATIC_GUARANTEED YouTube Programmatic Guaranteed report.
REACH Reach report.
UNIQUE_REACH_AUDIENCE Unique Reach Audience report.
FULL_PATH Full Path report.
PATH_ATTRIBUTION Path Attribution report.

FilterPair

Filter used to match traffic data in your report.

JSON representation 
{
  "type": string,
  "value": string
}
Fields
type

string

Filter type.
value

string

Filter value.

Options

Additional query options.

JSON representation 
{
  "includeOnlyTargetedUserLists": boolean,
  "pathQueryOptions": {
    object (PathQueryOptions)
  }
}
Fields
includeOnlyTargetedUserLists

boolean

Set to true and filter your report by FILTER_INSERTION_ORDER or FILTER_LINE_ITEM to include data for audience lists specifically targeted by those items.
pathQueryOptions

object (PathQueryOptions)

Options that contain Path Filters and Custom Channel Groupings.

PathQueryOptions

Path Query Options for Report Options.

JSON representation 
{
  "channelGrouping": {
    object (ChannelGrouping)
  },
  "pathFilters": [
    {
      object (PathFilter)
    }
  ]
}
Fields
channelGrouping

object (ChannelGrouping)

Custom Channel Groupings.
pathFilters[]

object (PathFilter)

Path Filters. There is a limit of 100 path filters that can be set per report.

ChannelGrouping

A channel grouping defines a set of rules that can be used to categorize events in a path report.

JSON representation 
{
  "name": string,
  "rules": [
    {
      object (Rule)
    }
  ],
  "fallbackName": string
}
Fields
name

string

Channel Grouping name.
rules[]

object (Rule)

Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
fallbackName

string

The name to apply to an event that does not match any of the rules in the channel grouping.

Rule

A Rule defines a name, and a boolean expression in conjunctive normal form{.external} that can be applied to a path event to determine if that name should be applied.

JSON representation 
{
  "name": string,
  "disjunctiveMatchStatements": [
    {
      object (DisjunctiveMatchStatement)
    }
  ]
}
Fields
name

string

Rule name.
disjunctiveMatchStatements[]

object (DisjunctiveMatchStatement)

DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters.

DisjunctiveMatchStatement

DisjunctiveMatchStatement that OR's all contained filters.

JSON representation 
{
  "eventFilters": [
    {
      object (EventFilter)
    }
  ]
}
Fields
eventFilters[]

object (EventFilter)

Filters. There is a limit of 100 filters that can be set per disjunctive match statement.

EventFilter

Defines the type of filter to be applied to the path, a DV360 event dimension filter.

JSON representation 
{
  "dimensionFilter": {
    object (PathQueryOptionsFilter)
  }
}
Fields
dimensionFilter

object (PathQueryOptionsFilter)

Filter on a dimension.

PathQueryOptionsFilter

Dimension filter on path events.

JSON representation 
{
  "filter": string,
  "match": enum (Match),
  "values": [
    string
  ]
}
Fields
filter

string

Dimension the filter is applied to.
match

enum (Match)

Match logic of the filter.
values[]

string

Values to filter on.

Match

The type of match.

Enums
UNKNOWN Default value when match is not specified or is unknown in this version.
EXACT Matches a value exactly.
PARTIAL Matches a value partially.
BEGINS_WITH Begins with a value.
WILDCARD_EXPRESSION Matches a value, utilizing wildcard character logic in the value.

PathFilter

Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions.

When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.

JSON representation 
{
  "eventFilters": [
    {
      object (EventFilter)
    }
  ],
  "pathMatchPosition": enum (PathMatchPosition)
}
Fields
eventFilters[]

object (EventFilter)

Filter on an event to be applied to some part of the path.
pathMatchPosition

enum (PathMatchPosition)

The position of the path the filter should match to (first, last, or any event in path).

PathMatchPosition

The position in the path to match to.

Enums
PATH_MATCH_POSITION_UNSPECIFIED Default value when path match position is not specified or is unknown in this version.
ANY Any position in the path.
FIRST The first position in the path.
LAST The last position in the path.