REST Resource: curators.reports

Resource: Report

The Report resource.

JSON representation 
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
Fields
name

string

Identifier. The resource name of the report. Report resource name have the form: curators/{accountId}/reports/{reportId}
reportId

string (int64 format)

Output only. Report ID.
reportDefinition

object (ReportDefinition)

Required. The report definition of the report.
displayName

string

Optional. Display name for the report.
updateTime

string (Timestamp format)

Output only. The instant this report was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
createTime

string (Timestamp format)

Output only. The instant this report was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
locale

string

Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can't be modified.

ReportDefinition

The definition of how a report should be run.

JSON representation 
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
Fields
dimensions[]

enum (Dimension)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
metrics[]

enum (Metric)

Required. The list of metrics to report on. If empty, the report will have no metrics.
filters[]

object (Filter)

Optional. The filters for this report.
timeZoneSource

enum (TimeZoneSource)

Optional. Where to get the time zone for this report. Defaults to using the Pacific time zone (PT). If source is PROVIDED, the timeZone field in the report definition must also set a time zone.
timeZone

string

Optional. If timeZoneSource is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, "America/New_York".
currencyCode

string

Optional. The ISO 4217 currency code for this report. Defaults to account currency code if not specified.
dateRange

object (DateRange)

Required. The primary date range of this report.
sorts[]

object (Sort)

Optional. Default sorts to apply to this report.

Dimension

Reporting dimensions.

Enums
DIMENSION_UNSPECIFIED Default value. This value is unused.
ADVERTISER_DOMAIN The domain of the advertiser.
COUNTRY Display name of a country.
CURATION_DATA_SEGMENT_ID The ID of the data segment created by a curator.
CURATION_DATA_SEGMENT_RESPONSE_STATUS The response status of the data segment requests in the Real-time curation. Refer to https://developers.google.com/authorized-buyers/curation/get-started/start for details.
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME The localized display name of the response status of the data segment requests in the Real-time curation. Refer to https://developers.google.com/authorized-buyers/curation/get-started/start for details.
CURATOR_FEE_TYPE The type of curation service (e.g. packaging or data segment).
DATE Date.
DEAL_ID Deal ID.
DEAL_NAME Deal name.
DETECTED_ADVERTISER_NAME Display name of the detected advertiser.
DSP_NAME Display name of the DSP.
DSP_SEAT_ID DSP Seat ID.
ENVIRONMENT The user device and container environment where the impression originates. Supported values are "app" and "web".
ENVIRONMENT_NAME The localized display name of the user device and container environment where the impression originates. Supported values are "app" and "web".
HOLDING_COMPANY_NAME Display name of the holding company.
HOUR Hour.
MOBILE_APP_ID Mobile App ID.
MOBILE_APP_NAME Mobile App Name.
MOBILE_OS Mobile operating system.
MONTH Month.
PACKAGE_FEE_VISIBILITY The visibility of the package fee (e.g. disclosed or non-disclosed).
PLATFORM Platform, e.g. "desktop" vs. "mobile".
PUBLISHER_DOMAIN Publisher domain.
PUBLISHER_ID Publisher identifier.
PUBLISHER_NAME Publisher name.
WEEK Week.

Metric

Reporting metrics.

Enums
METRIC_UNSPECIFIED Default value. This value is unused.
ACTIVE_VIEW_MEASURABILITY_RATE Active View measurability rate.
ACTIVE_VIEW_MEASURABLE Active View measurable.
ACTIVE_VIEW_VIEWABILITY_RATE Active view viewability rate.
ACTIVE_VIEW_VIEWABLE Active View viewable imps.
AUCTIONS_WON Auctions won.
BIDS Bids.
BIDS_IN_AUCTION Bids in auction.
BID_REQUESTS Bid requests.
CLICKS Clicks.
CURATION_PARTNER_FEE Curator fee.
DATA_SEGMENT_REQUESTS Number of data segment requests sent in the Real-time curation.
IMPRESSIONS Impressions.
SPEND Spend in reporting currency specified in the request. Defaults to USD.

Filter

A filter over one or more fields.

JSON representation 
{

  // Union field type can be only one of the following:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of list of possible types for union field type.
}
Fields
Union field type. The type determines how the underlying filters are combined. type can be only one of the following:
fieldFilter

object (FieldFilter)

A filter on a single field.
notFilter

object (Filter)

A filter whose result is negated.
andFilter

object (FilterList)

A list of filters whose results are AND-ed.
orFilter

object (FilterList)

A list of filters whose results are OR-ed.

FieldFilter

A filter on a specific field.

JSON representation 
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
Fields
field

object (Field)

Required. The field to filter on.
operation

enum (Operation)

Required. The operation of this filter.
values[]

object (ReportValue)

Required. Values to filter to.

Field

A dimension or a metric in a report.

JSON representation 
{

  // Union field field can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field field.
}
Fields
Union field field. Either a dimension or a metric. field can be only one of the following:
dimension

enum (Dimension)

The dimension this field represents.
metric

enum (Metric)

The metric this field represents.

Operation

Supported filter operations.

Enums
IN

For scalar operands, checks if the operand is in the set of provided filter values.

For list operands, checks if any element in the operand is in the set of provided filter values.

Default value.
NOT_IN

For scalar operands, checks that the operand is not in the set of provided filter values.

For list operands, checks that none of the elements in the operand is in the set of provided filter values.
CONTAINS

For scalar string operands, checks if the operand contains any of the provided filter substrings.

For string list operands, checks if any string in the operand contains any of the provided filter substrings.
NOT_CONTAINS

For scalar string operands, checks that the operand contains none of the provided filter substrings.

For string list operands, checks that none of the strings in the operand contain none of the provided filter substrings.
LESS_THAN Operand is less than the provided filter value.
LESS_THAN_EQUALS Operand is less than or equal to provided filter value.
GREATER_THAN Operand is greater than provided filter value.
GREATER_THAN_EQUALS Operand is greater than or equal to provided filter value.
BETWEEN Operand is between provided filter values.
MATCHES Operand matches against a regular expression or set of regular expressions (one must match).
NOT_MATCHES Operand negative matches against a regular expression or set of regular expressions (none must match).

ReportValue

Represents a single value in a report.

JSON representation 
{

  // Union field value can be only one of the following:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of list of possible types for union field value.
}
Fields
Union field value. The value of the field, depends on the field's data format. value can be only one of the following:
intValue

string (int64 format)

For integer values.
doubleValue

number

For double values.
stringValue

string

For string values.
boolValue

boolean

For boolean values.
intListValue

object (IntList)

For lists of integer values.
stringListValue

object (StringList)

For lists of string values.
doubleListValue

object (DoubleList)

For lists of double values.
bytesValue

string (bytes format)

For bytes values.

A base64-encoded string.

IntList

A list of integer values.

JSON representation 
{
  "values": [
    string
  ]
}
Fields
values[]

string (int64 format)

The values

StringList

A list of string values.

JSON representation 
{
  "values": [
    string
  ]
}
Fields
values[]

string

The values

DoubleList

A list of double values.

JSON representation 
{
  "values": [
    number
  ]
}
Fields
values[]

number

The values

FilterList

A list of filters.

JSON representation 
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
Fields
filters[]

object (Filter)

Required. A list of filters.

TimeZoneSource

The source to determine the time zone for the report.

Enums
TIME_ZONE_SOURCE_UNSPECIFIED Unspecified default value.
AD_EXCHANGE Use the Pacific time zone(PT).
UTC Use UTC time zone.
PROVIDED Use the time zone provided in the ReportDefinition.time_zone field. Reports may take longer to run since the dates are dynamically calculated at request time.

DateRange

A date range for a report.

JSON representation 
{

  // Union field date_range_type can be only one of the following:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of list of possible types for union field date_range_type.
}
Fields
Union field date_range_type. Either a fixed or relative date range. date_range_type can be only one of the following:
fixed

object (FixedDateRange)

A fixed date range.
relative

enum (RelativeDateRange)

A relative date range.

FixedDateRange

A date range between two fixed dates (inclusive of end date).

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

object (Date)

Required. The start date of this date range.
endDate

object (Date)

Required. The end date (inclusive) of this date range.

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, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

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.

RelativeDateRange

Options for relative date ranges.

Enums
RELATIVE_DATE_RANGE_UNSPECIFIED Default value. This value is unused.
TODAY The date the report is run.
YESTERDAY The date a day before the date that the report is run.
THIS_WEEK_TO_DATE From the beginning of the calendar week in which the up to and including the day the report is run.
THIS_WEEK_TO_YESTERDAY From the beginning of the calendar week in which the report is run, up to and including the day before the report is run.
THIS_MONTH_TO_DATE From the beginning of the calendar month in which the report is run, to up to and including the day the report is run.
THIS_MONTH_TO_YESTERDAY From the beginning of the calendar month in which the report is run, up to and including the day before the report is run.
THIS_QUARTER_TO_DATE From the beginning of the calendar quarter in which the report is run, up to and including the day the report is run.
THIS_QUARTER_TO_YESTERDAY From the beginning of the calendar quarter in which the report is run, up to and including the day before the report is run.
THIS_YEAR_TO_DATE From the beginning of the calendar year in which the report is run, to up to and including the day the report is run.
THIS_YEAR_TO_YESTERDAY From the beginning of the calendar year in which the report is run, to up to and including the day before the report is run.
LAST_WEEK The entire previous calendar week, Monday to Sunday (inclusive), preceding the calendar week the report is run.
LAST_WEEK_STARTING_SUNDAY The entire previous calendar week, Sunday to Saturday (inclusive), preceding the calendar week the report is run.
LAST_MONTH The entire previous calendar month preceding the calendar month the report is run.
LAST_QUARTER The entire previous calendar quarter preceding the calendar quarter the report is run.
LAST_YEAR The entire previous calendar year preceding the calendar year the report is run.
LAST_7_DAYS The 7 days preceding the day the report is run.
LAST_30_DAYS The 30 days preceding the day the report is run.
LAST_60_DAYS The 60 days preceding the day the report is run.
LAST_90_DAYS The 90 days preceding the day the report is run.
LAST_93_DAYS The 93 days preceding the day the report is run.
LAST_180_DAYS The 180 days preceding the day the report is run.
LAST_360_DAYS The 360 days preceding the day the report is run.
LAST_365_DAYS The 365 days preceding the day the report is run.
LAST_3_MONTHS The entire previous 3 calendar months preceding the calendar month the report is run.
LAST_6_MONTHS The entire previous 6 calendar months preceding the calendar month the report is run.
LAST_12_MONTHS The entire previous 12 calendar months preceding the calendar month the report is run.
ALL_AVAILABLE From 3 years before the report is run, to the day before the report is run, inclusive.

Sort

Represents a sorting in a report.

JSON representation 
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
Fields
field

object (Field)

Required. A field (dimension or metric) to sort by.
descending

boolean

Optional. The sort order. If true the sort will be descending.

Methods

create

 Creates a Report object.

delete

 Deletes a Report object.

get

 Retrieves a Report object.

list

 Lists Report objects.

patch

 Updates a Report object.

run

 Initiates the execution of an existing report asynchronously.