class Google::Apis::DoubleclicksearchV2::ReportRequest

A request object used to create a DoubleClick Search report.

Attributes

columns[RW]

The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the ` columnName` parameter is required. For saved columns only the `savedColumnName` parameter is required. Both `columnName` and `savedColumnName` cannot be set in the same stanza.\ The maximum number of columns per request is 300. Corresponds to the JSON property `columns` @return [Array<Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec>]

download_format[RW]

Format that the report should be returned in. Currently `csv` or `tsv` is supported. Corresponds to the JSON property `downloadFormat` @return [String]

filters[RW]

A list of filters to be applied to the report.\ The maximum number of filters per request is 300. Corresponds to the JSON property `filters` @return [Array<Google::Apis::DoubleclicksearchV2::ReportRequest::Filter>]

include_deleted_entities[RW]

Determines if removed entities should be included in the report. Defaults to ` false`. Deprecated, please use `includeRemovedEntities` instead. Corresponds to the JSON property `includeDeletedEntities` @return [Boolean]

include_deleted_entities?[RW]

Determines if removed entities should be included in the report. Defaults to ` false`. Deprecated, please use `includeRemovedEntities` instead. Corresponds to the JSON property `includeDeletedEntities` @return [Boolean]

include_removed_entities[RW]

Determines if removed entities should be included in the report. Defaults to ` false`. Corresponds to the JSON property `includeRemovedEntities` @return [Boolean]

include_removed_entities?[RW]

Determines if removed entities should be included in the report. Defaults to ` false`. Corresponds to the JSON property `includeRemovedEntities` @return [Boolean]

max_rows_per_file[RW]

Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are ` 1000000` to `100000000`, inclusive. Corresponds to the JSON property `maxRowsPerFile` @return [Fixnum]

order_by[RW]

Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300. Corresponds to the JSON property `orderBy` @return [Array<Google::Apis::DoubleclicksearchV2::ReportRequest::OrderBy>]

report_scope[RW]

The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required. Corresponds to the JSON property `reportScope` @return [Google::Apis::DoubleclicksearchV2::ReportRequest::ReportScope]

report_type[RW]

Determines the type of rows that are returned in the report. For example, if you specify `reportType: keyword`, each row in the report will contain data about a keyword. See the [Types of Reports](/search-ads/v2/report-types/) reference for the columns that are available for each type. Corresponds to the JSON property `reportType` @return [String]

row_count[RW]

Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to ` 10000`. Corresponds to the JSON property `rowCount` @return [Fixnum]

start_row[RW]

Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`. Corresponds to the JSON property `startRow` @return [Fixnum]

statistics_currency[RW]

Specifies the currency in which monetary will be returned. Possible values are: `usd`, `agency` (valid if the report is scoped to agency or lower), ` advertiser` (valid if the report is scoped to * advertiser or lower), or ` account` (valid if the report is scoped to engine account or lower). Corresponds to the JSON property `statisticsCurrency` @return [String]

time_range[RW]

If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range. Corresponds to the JSON property `timeRange` @return [Google::Apis::DoubleclicksearchV2::ReportRequest::TimeRange]

verify_single_time_zone[RW]

If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`. Corresponds to the JSON property `verifySingleTimeZone` @return [Boolean]

verify_single_time_zone?[RW]

If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`. Corresponds to the JSON property `verifySingleTimeZone` @return [Boolean]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/doubleclicksearch_v2/classes.rb, line 687
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/doubleclicksearch_v2/classes.rb, line 692
def update!(**args)
  @columns = args[:columns] if args.key?(:columns)
  @download_format = args[:download_format] if args.key?(:download_format)
  @filters = args[:filters] if args.key?(:filters)
  @include_deleted_entities = args[:include_deleted_entities] if args.key?(:include_deleted_entities)
  @include_removed_entities = args[:include_removed_entities] if args.key?(:include_removed_entities)
  @max_rows_per_file = args[:max_rows_per_file] if args.key?(:max_rows_per_file)
  @order_by = args[:order_by] if args.key?(:order_by)
  @report_scope = args[:report_scope] if args.key?(:report_scope)
  @report_type = args[:report_type] if args.key?(:report_type)
  @row_count = args[:row_count] if args.key?(:row_count)
  @start_row = args[:start_row] if args.key?(:start_row)
  @statistics_currency = args[:statistics_currency] if args.key?(:statistics_currency)
  @time_range = args[:time_range] if args.key?(:time_range)
  @verify_single_time_zone = args[:verify_single_time_zone] if args.key?(:verify_single_time_zone)
end