Class: Google::Ads::AdManager::V1::ReportDefinition

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/report_service.rb

Overview

The definition of how a report should be run.

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_date_range ⇒ ::Google::Ads::AdManager::V1::Report::DateRange

Returns Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#creative_custom_field_ids ⇒ ::Array<::Integer>

Returns Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.

Returns:

  • (::Array<::Integer>) —

    Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#currency_code ⇒ ::String

Returns Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

Returns:

  • (::String) —

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



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_dimension_key_ids ⇒ ::Array<::Integer>

Returns Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.

Returns:

  • (::Array<::Integer>) —

    Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date_range ⇒ ::Google::Ads::AdManager::V1::Report::DateRange

Returns Required. The primary date range of this report.

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dimensions ⇒ ::Array<::Google::Ads::AdManager::V1::Report::Dimension>

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

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filters ⇒ ::Array<::Google::Ads::AdManager::V1::Report::Filter>

Returns Optional. The filters for this report.

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#flags ⇒ ::Array<::Google::Ads::AdManager::V1::Report::Flag>

Returns Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#line_item_custom_field_ids ⇒ ::Array<::Integer>

Returns Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.

Returns:

  • (::Array<::Integer>) —

    Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metrics ⇒ ::Array<::Google::Ads::AdManager::V1::Report::Metric>

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

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_custom_field_ids ⇒ ::Array<::Integer>

Returns Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.

Returns:

  • (::Array<::Integer>) —

    Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#report_type ⇒ ::Google::Ads::AdManager::V1::Report::ReportType

Returns Required. The type of this report.

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sorts ⇒ ::Array<::Google::Ads::AdManager::V1::Report::Sort>

Returns Optional. Default sorts to apply to this report.

Returns:



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#time_period_column ⇒ ::Google::Ads::AdManager::V1::Report::TimePeriodColumn

Returns Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.

Returns:

  • (::Google::Ads::AdManager::V1::Report::TimePeriodColumn) —

    Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#time_zone ⇒ ::String

Returns Optional. The time zone the date range is defined in for this report. Defaults to publisher's time zone if not specified. Time zone in IANA format. Acceptable values depend on the report type. Publisher time zone is always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" for UTC.

Returns:

  • (::String) —

    Optional. The time zone the date range is defined in for this report. Defaults to publisher's time zone if not specified. Time zone in IANA format. Acceptable values depend on the report type. Publisher time zone is always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" for UTC.



3362
3363
3364
3365
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3362

class ReportDefinition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end