Class: Google::Apis::DfareportingV3_0::Report

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_0/classes.rb,
generated/google/apis/dfareporting_v3_0/representations.rb,
generated/google/apis/dfareporting_v3_0/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



9804
9805
9806
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9804

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) 


9712
9713
9714
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9712

def 
  @account_id
end

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

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

Returns:



9717
9718
9719
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9717

def criteria
  @criteria
end

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

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

Returns:



9722
9723
9724
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9722

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



9727
9728
9729
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9727

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9732
9733
9734
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9732

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) 


9737
9738
9739
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9737

def file_name
  @file_name
end

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

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

Returns:



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

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) 


9750
9751
9752
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9750

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9755
9756
9757
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9755

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) 


9760
9761
9762
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9760

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) 


9766
9767
9768
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9766

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


9771
9772
9773
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9771

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) 


9776
9777
9778
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9776

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



9781
9782
9783
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9781

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



9786
9787
9788
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9786

def reach_criteria
  @reach_criteria
end

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



9792
9793
9794
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9792

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) 


9797
9798
9799
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9797

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


9802
9803
9804
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9802

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9809

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