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_messages.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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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:



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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

#time_zone ⇒ ::String

Returns Optional. If time_zone_source 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 (e.g. "America/New_York").

Returns:

  • (::String) —

    Optional. If time_zone_source 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 (e.g. "America/New_York").



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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

#time_zone_source ⇒ ::Google::Ads::AdManager::V1::Report::TimeZoneSource

Returns Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone.

Returns:

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

    Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone.



3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 3469

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