Class: Google::Apis::DfareportingV4::Report

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

Overview

Represents a Report resource.

Defined Under Namespace

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Report

Returns a new instance of Report.



10708
10709
10710
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10708

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) 


10606
10607
10608
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10606

def 
  @account_id
end

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

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

Returns:



10611
10612
10613
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10611

def criteria
  @criteria
end

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

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

Returns:



10616
10617
10618
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10616

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



10621
10622
10623
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10621

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10626
10627
10628
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10626

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) 


10631
10632
10633
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10631

def file_name
  @file_name
end

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

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

Returns:



10636
10637
10638
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10636

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) 


10644
10645
10646
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10644

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10649
10650
10651
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10649

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) 


10654
10655
10656
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10654

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) 


10660
10661
10662
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10660

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10665
10666
10667
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10665

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) 


10670
10671
10672
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10670

def owner_profile_id
  @owner_profile_id
end

#path_attribution_criteria ⇒ Google::Apis::DfareportingV4::Report::PathAttributionCriteria

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

Returns:



10675
10676
10677
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10675

def path_attribution_criteria
  @path_attribution_criteria
end

#path_criteria ⇒ Google::Apis::DfareportingV4::Report::PathCriteria

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

Returns:



10680
10681
10682
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10680

def path_criteria
  @path_criteria
end

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

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

Returns:



10685
10686
10687
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10685

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



10690
10691
10692
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10690

def reach_criteria
  @reach_criteria
end

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



10696
10697
10698
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10696

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) 


10701
10702
10703
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10701

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10706
10707
10708
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10706

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10713

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_attribution_criteria = args[:path_attribution_criteria] if args.key?(:path_attribution_criteria)
  @path_criteria = args[:path_criteria] if args.key?(:path_criteria)
  @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