class Google::Apis::DoubleclicksearchV2::ReportApiColumnSpec
A request object used to create a DoubleClick Search report.
Attributes
Name of a DoubleClick Search column to include in the report. Corresponds to the JSON property `columnName` @return [String]
Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.\ If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report. Corresponds to the JSON property `customDimensionName` @return [String]
Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. Corresponds to the JSON property `customMetricName` @return [String]
Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with ` startDate`. Corresponds to the JSON property `endDate` @return [String]
Synchronous report only. Set to `true` to group by this column. Defaults to ` false`. Corresponds to the JSON property `groupByColumn` @return [Boolean]
Synchronous report only. Set to `true` to group by this column. Defaults to ` false`. Corresponds to the JSON property `groupByColumn` @return [Boolean]
Text used to identify this column in the report output; defaults to ` columnName` or `savedColumnName` when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. Corresponds to the JSON property `headerText` @return [String]
The platform that is used to provide data for the custom dimension. Acceptable values are “floodlight”. Corresponds to the JSON property `platformSource` @return [String]
Returns metrics only for a specific type of product activity. Accepted values are: - “`sold`”: returns metrics only for products that were sold - “` advertised`”: returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold Corresponds to the JSON property `productReportPerspective` @return [String]
Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. Corresponds to the JSON property `savedColumnName` @return [String]
Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with ` endDate`. Corresponds to the JSON property `startDate` @return [String]
Public Class Methods
# File lib/google/apis/doubleclicksearch_v2/classes.rb, line 566 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/doubleclicksearch_v2/classes.rb, line 571 def update!(**args) @column_name = args[:column_name] if args.key?(:column_name) @custom_dimension_name = args[:custom_dimension_name] if args.key?(:custom_dimension_name) @custom_metric_name = args[:custom_metric_name] if args.key?(:custom_metric_name) @end_date = args[:end_date] if args.key?(:end_date) @group_by_column = args[:group_by_column] if args.key?(:group_by_column) @header_text = args[:header_text] if args.key?(:header_text) @platform_source = args[:platform_source] if args.key?(:platform_source) @product_report_perspective = args[:product_report_perspective] if args.key?(:product_report_perspective) @saved_column_name = args[:saved_column_name] if args.key?(:saved_column_name) @start_date = args[:start_date] if args.key?(:start_date) end