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, CrossMediaReachCriteria, Delivery, FloodlightCriteria, PathToConversionCriteria, ReachCriteria, Schedule

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Report

Returns a new instance of Report.



10571
10572
10573
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10571

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) 


10474
10475
10476
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10474

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:



10479
10480
10481
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10479

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:



10484
10485
10486
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10484

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

#cross_media_reach_criteria ⇒ Google::Apis::DfareportingV4::Report::CrossMediaReachCriteria

Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". Corresponds to the JSON property crossMediaReachCriteria

Returns:



10489
10490
10491
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10489

def cross_media_reach_criteria
  @cross_media_reach_criteria
end

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

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

Returns:



10494
10495
10496
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10494

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10499
10500
10501
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10499

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) 


10504
10505
10506
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10504

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:



10509
10510
10511
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10509

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) 


10517
10518
10519
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10517

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10522
10523
10524
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10522

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) 


10527
10528
10529
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10527

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) 


10533
10534
10535
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10533

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10538
10539
10540
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10538

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) 


10543
10544
10545
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10543

def owner_profile_id
  @owner_profile_id
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:



10548
10549
10550
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10548

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:



10553
10554
10555
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10553

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:



10559
10560
10561
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10559

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) 


10564
10565
10566
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10564

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10569
10570
10571
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10569

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10576

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