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.



10714
10715
10716
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10714

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) 


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

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:



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

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:



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

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:



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

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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:



10642
10643
10644
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10642

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) 


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

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

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) 


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

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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:



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

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:



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

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:



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

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:



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

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:



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

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) 


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

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10712
10713
10714
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10712

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10719

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