Class: Google::Apis::DfareportingV2_1::Report
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_1::Report
- Includes:
- Core::Hashable
- Defined in:
- generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/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_1::Report::Criteria
The report criteria for a report of type "STANDARD".
-
#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV2_1::Report::CrossDimensionReachCriteria
The report criteria for a report of type "CROSS_DIMENSION_REACH".
-
#delivery ⇒ Google::Apis::DfareportingV2_1::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_1::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_1::Report::PathToConversionCriteria
The report criteria for a report of type "PATH_TO_CONVERSION".
-
#reach_criteria ⇒ Google::Apis::DfareportingV2_1::Report::ReachCriteria
The report criteria for a report of type "REACH".
-
#schedule ⇒ Google::Apis::DfareportingV2_1::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::Hashable
Constructor Details
#initialize(**args) ⇒ Report
Returns a new instance of Report.
8911 8912 8913 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8911 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
8819 8820 8821 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8819 def account_id @account_id end |
#criteria ⇒ Google::Apis::DfareportingV2_1::Report::Criteria
The report criteria for a report of type "STANDARD".
Corresponds to the JSON property criteria
8824 8825 8826 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8824 def criteria @criteria end |
#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV2_1::Report::CrossDimensionReachCriteria
The report criteria for a report of type "CROSS_DIMENSION_REACH".
Corresponds to the JSON property crossDimensionReachCriteria
8829 8830 8831 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8829 def cross_dimension_reach_criteria @cross_dimension_reach_criteria end |
#delivery ⇒ Google::Apis::DfareportingV2_1::Report::Delivery
The report's email delivery settings.
Corresponds to the JSON property delivery
8834 8835 8836 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8834 def delivery @delivery end |
#etag ⇒ String
The eTag of this response for caching purposes.
Corresponds to the JSON property etag
8839 8840 8841 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8839 def etag @etag end |
#file_name ⇒ String
The filename used when generating report files for this report.
Corresponds to the JSON property fileName
8844 8845 8846 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8844 def file_name @file_name end |
#floodlight_criteria ⇒ Google::Apis::DfareportingV2_1::Report::FloodlightCriteria
The report criteria for a report of type "FLOODLIGHT".
Corresponds to the JSON property floodlightCriteria
8849 8850 8851 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8849 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
8857 8858 8859 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8857 def format @format end |
#id ⇒ String
The unique ID identifying this report resource.
Corresponds to the JSON property id
8862 8863 8864 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8862 def id @id end |
#kind ⇒ String
The kind of resource this is, in this case dfareporting#report.
Corresponds to the JSON property kind
8867 8868 8869 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8867 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
8873 8874 8875 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8873 def last_modified_time @last_modified_time end |
#name ⇒ String
The name of the report.
Corresponds to the JSON property name
8878 8879 8880 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8878 def name @name end |
#owner_profile_id ⇒ String
The user profile id of the owner of this report.
Corresponds to the JSON property ownerProfileId
8883 8884 8885 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8883 def owner_profile_id @owner_profile_id end |
#path_to_conversion_criteria ⇒ Google::Apis::DfareportingV2_1::Report::PathToConversionCriteria
The report criteria for a report of type "PATH_TO_CONVERSION".
Corresponds to the JSON property pathToConversionCriteria
8888 8889 8890 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8888 def path_to_conversion_criteria @path_to_conversion_criteria end |
#reach_criteria ⇒ Google::Apis::DfareportingV2_1::Report::ReachCriteria
The report criteria for a report of type "REACH".
Corresponds to the JSON property reachCriteria
8893 8894 8895 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8893 def reach_criteria @reach_criteria end |
#schedule ⇒ Google::Apis::DfareportingV2_1::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
8899 8900 8901 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8899 def schedule @schedule end |
#sub_account_id ⇒ String
The subaccount ID to which this report belongs if applicable.
Corresponds to the JSON property subAccountId
8904 8905 8906 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8904 def sub_account_id @sub_account_id end |
#type ⇒ String
The type of the report.
Corresponds to the JSON property type
8909 8910 8911 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8909 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8916 def update!(**args) @account_id = args[:account_id] unless args[:account_id].nil? @criteria = args[:criteria] unless args[:criteria].nil? @cross_dimension_reach_criteria = args[:cross_dimension_reach_criteria] unless args[:cross_dimension_reach_criteria].nil? @delivery = args[:delivery] unless args[:delivery].nil? @etag = args[:etag] unless args[:etag].nil? @file_name = args[:file_name] unless args[:file_name].nil? @floodlight_criteria = args[:floodlight_criteria] unless args[:floodlight_criteria].nil? @format = args[:format] unless args[:format].nil? @id = args[:id] unless args[:id].nil? @kind = args[:kind] unless args[:kind].nil? @last_modified_time = args[:last_modified_time] unless args[:last_modified_time].nil? @name = args[:name] unless args[:name].nil? @owner_profile_id = args[:owner_profile_id] unless args[:owner_profile_id].nil? @path_to_conversion_criteria = args[:path_to_conversion_criteria] unless args[:path_to_conversion_criteria].nil? @reach_criteria = args[:reach_criteria] unless args[:reach_criteria].nil? @schedule = args[:schedule] unless args[:schedule].nil? @sub_account_id = args[:sub_account_id] unless args[:sub_account_id].nil? @type = args[:type] unless args[:type].nil? end |