Class: Google::Apis::DfareportingV3_3::Report

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/representations.rb

Overview

Represents a Report resource.

Defined Under Namespace

Classes: Criteria, CrossDimensionReachCriteria, Delivery, FloodlightCriteria, PathToConversionCriteria, ReachCriteria, Schedule

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Report

Returns a new instance of Report.



9834
9835
9836
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9834

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

Returns:

  • (Fixnum) 


9742
9743
9744
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9742

def 
  @account_id
end

#criteria ⇒ Google::Apis::DfareportingV3_3::Report::Criteria

The report criteria for a report of type "STANDARD". Corresponds to the JSON property criteria

Returns:



9747
9748
9749
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9747

def criteria
  @criteria
end

#cross_dimension_reach_criteria ⇒ Google::Apis::DfareportingV3_3::Report::CrossDimensionReachCriteria

The report criteria for a report of type "CROSS_DIMENSION_REACH". Corresponds to the JSON property crossDimensionReachCriteria

Returns:



9752
9753
9754
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9752

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

#delivery ⇒ Google::Apis::DfareportingV3_3::Report::Delivery

The report's email delivery settings. Corresponds to the JSON property delivery

Returns:



9757
9758
9759
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9757

def delivery
  @delivery
end

#etag ⇒ String

The eTag of this response for caching purposes. Corresponds to the JSON property etag

Returns:

  • (String) 


9762
9763
9764
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9762

def etag
  @etag
end

#file_name ⇒ String

The filename used when generating report files for this report. Corresponds to the JSON property fileName

Returns:

  • (String) 


9767
9768
9769
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9767

def file_name
  @file_name
end

#floodlight_criteria ⇒ Google::Apis::DfareportingV3_3::Report::FloodlightCriteria

The report criteria for a report of type "FLOODLIGHT". Corresponds to the JSON property floodlightCriteria

Returns:



9772
9773
9774
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9772

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

Returns:

  • (String) 


9780
9781
9782
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9780

def format
  @format
end

#id ⇒ Fixnum

The unique ID identifying this report resource. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


9785
9786
9787
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9785

def id
  @id
end

#kind ⇒ String

The kind of resource this is, in this case dfareporting#report. Corresponds to the JSON property kind

Returns:

  • (String) 


9790
9791
9792
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9790

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

Returns:

  • (Fixnum) 


9796
9797
9798
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9796

def last_modified_time
  @last_modified_time
end

#name ⇒ String

The name of the report. Corresponds to the JSON property name

Returns:

  • (String) 


9801
9802
9803
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9801

def name
  @name
end

#owner_profile_id ⇒ Fixnum

The user profile id of the owner of this report. Corresponds to the JSON property ownerProfileId

Returns:

  • (Fixnum) 


9806
9807
9808
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9806

def owner_profile_id
  @owner_profile_id
end

#path_to_conversion_criteria ⇒ Google::Apis::DfareportingV3_3::Report::PathToConversionCriteria

The report criteria for a report of type "PATH_TO_CONVERSION". Corresponds to the JSON property pathToConversionCriteria

Returns:



9811
9812
9813
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9811

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

#reach_criteria ⇒ Google::Apis::DfareportingV3_3::Report::ReachCriteria

The report criteria for a report of type "REACH". Corresponds to the JSON property reachCriteria

Returns:



9816
9817
9818
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9816

def reach_criteria
  @reach_criteria
end

#schedule ⇒ Google::Apis::DfareportingV3_3::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

Returns:



9822
9823
9824
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9822

def schedule
  @schedule
end

#sub_account_id ⇒ Fixnum

The subaccount ID to which this report belongs if applicable. Corresponds to the JSON property subAccountId

Returns:

  • (Fixnum) 


9827
9828
9829
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9827

def 
  @sub_account_id
end

#type ⇒ String

The type of the report. Corresponds to the JSON property type

Returns:

  • (String) 


9832
9833
9834
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9832

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9839

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