Class: Google::Apis::DfareportingV2_6::Report
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_6::Report
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v2_6/classes.rb,
generated/google/apis/dfareporting_v2_6/representations.rb,
generated/google/apis/dfareporting_v2_6/representations.rb
Overview
Represents a Report resource.
Defined Under Namespace
Classes: Criteria, CrossDimensionReachCriteria, Delivery, FloodlightCriteria, PathToConversionCriteria, ReachCriteria, Schedule
Instance Attribute Summary collapse
-
#account_id ⇒ String
The account ID to which this report belongs.
-
#criteria ⇒ Google::Apis::DfareportingV2_6::Report::Criteria
The report criteria for a report of type "STANDARD".
-
#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV2_6::Report::CrossDimensionReachCriteria
The report criteria for a report of type "CROSS_DIMENSION_REACH".
-
#delivery ⇒ Google::Apis::DfareportingV2_6::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::DfareportingV2_6::Report::FloodlightCriteria
The report criteria for a report of type "FLOODLIGHT".
-
#format ⇒ String
The output format of the report.
-
#id ⇒ String
The unique ID identifying this report resource.
-
#kind ⇒ String
The kind of resource this is, in this case dfareporting#report.
-
#last_modified_time ⇒ String
The timestamp (in milliseconds since epoch) of when this report was last modified.
-
#name ⇒ String
The name of the report.
-
#owner_profile_id ⇒ String
The user profile id of the owner of this report.
-
#path_to_conversion_criteria ⇒ Google::Apis::DfareportingV2_6::Report::PathToConversionCriteria
The report criteria for a report of type "PATH_TO_CONVERSION".
-
#reach_criteria ⇒ Google::Apis::DfareportingV2_6::Report::ReachCriteria
The report criteria for a report of type "REACH".
-
#schedule ⇒ Google::Apis::DfareportingV2_6::Report::Schedule
The report's schedule.
-
#sub_account_id ⇒ String
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.
9523 9524 9525 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9523 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ String
The account ID to which this report belongs.
Corresponds to the JSON property accountId
9431 9432 9433 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9431 def account_id @account_id end |
#criteria ⇒ Google::Apis::DfareportingV2_6::Report::Criteria
The report criteria for a report of type "STANDARD".
Corresponds to the JSON property criteria
9436 9437 9438 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9436 def criteria @criteria end |
#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV2_6::Report::CrossDimensionReachCriteria
The report criteria for a report of type "CROSS_DIMENSION_REACH".
Corresponds to the JSON property crossDimensionReachCriteria
9441 9442 9443 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9441 def cross_dimension_reach_criteria @cross_dimension_reach_criteria end |
#delivery ⇒ Google::Apis::DfareportingV2_6::Report::Delivery
The report's email delivery settings.
Corresponds to the JSON property delivery
9446 9447 9448 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9446 def delivery @delivery end |
#etag ⇒ String
The eTag of this response for caching purposes.
Corresponds to the JSON property etag
9451 9452 9453 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9451 def etag @etag end |
#file_name ⇒ String
The filename used when generating report files for this report.
Corresponds to the JSON property fileName
9456 9457 9458 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9456 def file_name @file_name end |
#floodlight_criteria ⇒ Google::Apis::DfareportingV2_6::Report::FloodlightCriteria
The report criteria for a report of type "FLOODLIGHT".
Corresponds to the JSON property floodlightCriteria
9461 9462 9463 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9461 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
9469 9470 9471 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9469 def format @format end |
#id ⇒ String
The unique ID identifying this report resource.
Corresponds to the JSON property id
9474 9475 9476 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9474 def id @id end |
#kind ⇒ String
The kind of resource this is, in this case dfareporting#report.
Corresponds to the JSON property kind
9479 9480 9481 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9479 def kind @kind end |
#last_modified_time ⇒ String
The timestamp (in milliseconds since epoch) of when this report was last
modified.
Corresponds to the JSON property lastModifiedTime
9485 9486 9487 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9485 def last_modified_time @last_modified_time end |
#name ⇒ String
The name of the report.
Corresponds to the JSON property name
9490 9491 9492 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9490 def name @name end |
#owner_profile_id ⇒ String
The user profile id of the owner of this report.
Corresponds to the JSON property ownerProfileId
9495 9496 9497 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9495 def owner_profile_id @owner_profile_id end |
#path_to_conversion_criteria ⇒ Google::Apis::DfareportingV2_6::Report::PathToConversionCriteria
The report criteria for a report of type "PATH_TO_CONVERSION".
Corresponds to the JSON property pathToConversionCriteria
9500 9501 9502 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9500 def path_to_conversion_criteria @path_to_conversion_criteria end |
#reach_criteria ⇒ Google::Apis::DfareportingV2_6::Report::ReachCriteria
The report criteria for a report of type "REACH".
Corresponds to the JSON property reachCriteria
9505 9506 9507 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9505 def reach_criteria @reach_criteria end |
#schedule ⇒ Google::Apis::DfareportingV2_6::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
9511 9512 9513 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9511 def schedule @schedule end |
#sub_account_id ⇒ String
The subaccount ID to which this report belongs if applicable.
Corresponds to the JSON property subAccountId
9516 9517 9518 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9516 def sub_account_id @sub_account_id end |
#type ⇒ String
The type of the report.
Corresponds to the JSON property type
9521 9522 9523 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9521 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 |
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9528 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 |