Class: Google::Apis::DfareportingV3_4::Report
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_4::Report
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/representations.rb
Overview
Represents a Report resource.
Defined Under Namespace
Classes: Criteria, CrossDimensionReachCriteria, Delivery, FloodlightCriteria, PathToConversionCriteria, ReachCriteria, Schedule
Instance Attribute Summary collapse
-
#account_id ⇒ Fixnum
The account ID to which this report belongs.
-
#criteria ⇒ Google::Apis::DfareportingV3_4::Report::Criteria
The report criteria for a report of type "STANDARD".
-
#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV3_4::Report::CrossDimensionReachCriteria
The report criteria for a report of type "CROSS_DIMENSION_REACH".
-
#delivery ⇒ Google::Apis::DfareportingV3_4::Report::Delivery
The report's email delivery settings.
-
#etag ⇒ String
The eTag of this response for caching purposes.
-
#file_name ⇒ String
The filename used when generating report files for this report.
-
#floodlight_criteria ⇒ Google::Apis::DfareportingV3_4::Report::FloodlightCriteria
The report criteria for a report of type "FLOODLIGHT".
-
#format ⇒ String
The output format of the report.
-
#id ⇒ Fixnum
The unique ID identifying this report resource.
-
#kind ⇒ String
The kind of resource this is, in this case dfareporting#report.
-
#last_modified_time ⇒ Fixnum
The timestamp (in milliseconds since epoch) of when this report was last modified.
-
#name ⇒ String
The name of the report.
-
#owner_profile_id ⇒ Fixnum
The user profile id of the owner of this report.
-
#path_to_conversion_criteria ⇒ Google::Apis::DfareportingV3_4::Report::PathToConversionCriteria
The report criteria for a report of type "PATH_TO_CONVERSION".
-
#reach_criteria ⇒ Google::Apis::DfareportingV3_4::Report::ReachCriteria
The report criteria for a report of type "REACH".
-
#schedule ⇒ Google::Apis::DfareportingV3_4::Report::Schedule
The report's schedule.
-
#sub_account_id ⇒ Fixnum
The subaccount ID to which this report belongs if applicable.
-
#type ⇒ String
The type of the report.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Report
constructor
A new instance of Report.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Report
Returns a new instance of Report.
10238 10239 10240 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10238 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ Fixnum
The account ID to which this report belongs.
Corresponds to the JSON property accountId
10146 10147 10148 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10146 def account_id @account_id end |
#criteria ⇒ Google::Apis::DfareportingV3_4::Report::Criteria
The report criteria for a report of type "STANDARD".
Corresponds to the JSON property criteria
10151 10152 10153 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10151 def criteria @criteria end |
#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV3_4::Report::CrossDimensionReachCriteria
The report criteria for a report of type "CROSS_DIMENSION_REACH".
Corresponds to the JSON property crossDimensionReachCriteria
10156 10157 10158 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10156 def cross_dimension_reach_criteria @cross_dimension_reach_criteria end |
#delivery ⇒ Google::Apis::DfareportingV3_4::Report::Delivery
The report's email delivery settings.
Corresponds to the JSON property delivery
10161 10162 10163 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10161 def delivery @delivery end |
#etag ⇒ String
The eTag of this response for caching purposes.
Corresponds to the JSON property etag
10166 10167 10168 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10166 def etag @etag end |
#file_name ⇒ String
The filename used when generating report files for this report.
Corresponds to the JSON property fileName
10171 10172 10173 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10171 def file_name @file_name end |
#floodlight_criteria ⇒ Google::Apis::DfareportingV3_4::Report::FloodlightCriteria
The report criteria for a report of type "FLOODLIGHT".
Corresponds to the JSON property floodlightCriteria
10176 10177 10178 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10176 def floodlight_criteria @floodlight_criteria end |
#format ⇒ String
The output format of the report. If not specified, default format is "CSV".
Note that the actual format in the completed report file might differ if for
instance the report's size exceeds the format's capabilities. "CSV" will then
be the fallback format.
Corresponds to the JSON property format
10184 10185 10186 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10184 def format @format end |
#id ⇒ Fixnum
The unique ID identifying this report resource.
Corresponds to the JSON property id
10189 10190 10191 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10189 def id @id end |
#kind ⇒ String
The kind of resource this is, in this case dfareporting#report.
Corresponds to the JSON property kind
10194 10195 10196 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10194 def kind @kind end |
#last_modified_time ⇒ Fixnum
The timestamp (in milliseconds since epoch) of when this report was last
modified.
Corresponds to the JSON property lastModifiedTime
10200 10201 10202 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10200 def last_modified_time @last_modified_time end |
#name ⇒ String
The name of the report.
Corresponds to the JSON property name
10205 10206 10207 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10205 def name @name end |
#owner_profile_id ⇒ Fixnum
The user profile id of the owner of this report.
Corresponds to the JSON property ownerProfileId
10210 10211 10212 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10210 def owner_profile_id @owner_profile_id end |
#path_to_conversion_criteria ⇒ Google::Apis::DfareportingV3_4::Report::PathToConversionCriteria
The report criteria for a report of type "PATH_TO_CONVERSION".
Corresponds to the JSON property pathToConversionCriteria
10215 10216 10217 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10215 def path_to_conversion_criteria @path_to_conversion_criteria end |
#reach_criteria ⇒ Google::Apis::DfareportingV3_4::Report::ReachCriteria
The report criteria for a report of type "REACH".
Corresponds to the JSON property reachCriteria
10220 10221 10222 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10220 def reach_criteria @reach_criteria end |
#schedule ⇒ Google::Apis::DfareportingV3_4::Report::Schedule
The report's schedule. Can only be set if the report's 'dateRange' is a
relative date range and the relative date range is not "TODAY".
Corresponds to the JSON property schedule
10226 10227 10228 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10226 def schedule @schedule end |
#sub_account_id ⇒ Fixnum
The subaccount ID to which this report belongs if applicable.
Corresponds to the JSON property subAccountId
10231 10232 10233 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10231 def sub_account_id @sub_account_id end |
#type ⇒ String
The type of the report.
Corresponds to the JSON property type
10236 10237 10238 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10236 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10243 def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @criteria = args[:criteria] if args.key?(:criteria) @cross_dimension_reach_criteria = args[:cross_dimension_reach_criteria] if args.key?(:cross_dimension_reach_criteria) @delivery = args[:delivery] if args.key?(:delivery) @etag = args[:etag] if args.key?(:etag) @file_name = args[:file_name] if args.key?(:file_name) @floodlight_criteria = args[:floodlight_criteria] if args.key?(:floodlight_criteria) @format = args[:format] if args.key?(:format) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) @name = args[:name] if args.key?(:name) @owner_profile_id = args[:owner_profile_id] if args.key?(:owner_profile_id) @path_to_conversion_criteria = args[:path_to_conversion_criteria] if args.key?(:path_to_conversion_criteria) @reach_criteria = args[:reach_criteria] if args.key?(:reach_criteria) @schedule = args[:schedule] if args.key?(:schedule) @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) @type = args[:type] if args.key?(:type) end |