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



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

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) 


9714
9715
9716
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9714

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:



9719
9720
9721
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9719

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:



9724
9725
9726
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9724

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:



9729
9730
9731
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9729

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9734
9735
9736
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9734

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) 


9739
9740
9741
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9739

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:



9744
9745
9746
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9744

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) 


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

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

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) 


9768
9769
9770
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9768

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


9773
9774
9775
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9773

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) 


9778
9779
9780
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9778

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:



9783
9784
9785
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9783

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:



9788
9789
9790
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9788

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:



9794
9795
9796
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9794

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) 


9799
9800
9801
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 9799

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


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

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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