Class: Google::Apis::DfareportingV2_6::Report

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



9524
9525
9526
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9524

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) 


9432
9433
9434
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9432

def 
  @account_id
end

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

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

Returns:



9437
9438
9439
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9437

def criteria
  @criteria
end

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

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

Returns:



9442
9443
9444
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9442

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



9447
9448
9449
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9447

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9452
9453
9454
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9452

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) 


9457
9458
9459
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9457

def file_name
  @file_name
end

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

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

Returns:



9462
9463
9464
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9462

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) 


9470
9471
9472
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9470

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9475
9476
9477
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9475

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) 


9480
9481
9482
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9480

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) 


9486
9487
9488
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9486

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


9491
9492
9493
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9491

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) 


9496
9497
9498
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9496

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



9501
9502
9503
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9501

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



9506
9507
9508
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9506

def reach_criteria
  @reach_criteria
end

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



9512
9513
9514
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9512

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) 


9517
9518
9519
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9517

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


9522
9523
9524
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9522

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9529

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