Class: Google::Apis::DoubleclicksearchV2::ReportRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/doubleclicksearch_v2/classes.rb,
generated/google/apis/doubleclicksearch_v2/representations.rb,
generated/google/apis/doubleclicksearch_v2/representations.rb

Overview

A request object used to create a DoubleClick Search report.

Defined Under Namespace

Classes: Filter, OrderBy, ReportScope, TimeRange

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReportRequest

Returns a new instance of ReportRequest.


683
684
685
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 683

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#columnsArray<Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec>

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. Corresponds to the JSON property columns


595
596
597
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 595

def columns
  @columns
end

#download_formatString

Format that the report should be returned in. Currently csv or tsv is supported. Corresponds to the JSON property downloadFormat

Returns:

  • (String)

601
602
603
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 601

def download_format
  @download_format
end

#filtersArray<Google::Apis::DoubleclicksearchV2::ReportRequest::Filter>

A list of filters to be applied to the report. Corresponds to the JSON property filters


606
607
608
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 606

def filters
  @filters
end

#include_deleted_entitiesBoolean Also known as: include_deleted_entities?

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

Returns:

  • (Boolean)

612
613
614
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 612

def include_deleted_entities
  @include_deleted_entities
end

#include_removed_entitiesBoolean Also known as: include_removed_entities?

Determines if removed entities should be included in the report. Defaults to false. Corresponds to the JSON property includeRemovedEntities

Returns:

  • (Boolean)

619
620
621
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 619

def include_removed_entities
  @include_removed_entities
end

#max_rows_per_fileFixnum

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

Returns:

  • (Fixnum)

627
628
629
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 627

def max_rows_per_file
  @max_rows_per_file
end

#order_byArray<Google::Apis::DoubleclicksearchV2::ReportRequest::OrderBy>

Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows. Corresponds to the JSON property orderBy


633
634
635
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 633

def order_by
  @order_by
end

#report_scopeGoogle::Apis::DoubleclicksearchV2::ReportRequest::ReportScope

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


640
641
642
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 640

def report_scope
  @report_scope
end

#report_typeString

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 reference for the columns that are available for each type. Corresponds to the JSON property reportType

Returns:

  • (String)

648
649
650
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 648

def report_type
  @report_type
end

#row_countFixnum

Synchronous report only. The maxinum 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

Returns:

  • (Fixnum)

654
655
656
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 654

def row_count
  @row_count
end

#start_rowFixnum

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

Returns:

  • (Fixnum)

660
661
662
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 660

def start_row
  @start_row
end

#statistics_currencyString

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

Returns:

  • (String)

668
669
670
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 668

def statistics_currency
  @statistics_currency
end

#time_rangeGoogle::Apis::DoubleclicksearchV2::ReportRequest::TimeRange

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


674
675
676
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 674

def time_range
  @time_range
end

#verify_single_time_zoneBoolean Also known as: verify_single_time_zone?

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

Returns:

  • (Boolean)

680
681
682
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 680

def verify_single_time_zone
  @verify_single_time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
# File 'generated/google/apis/doubleclicksearch_v2/classes.rb', line 688

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