Class: Google::Apis::DfareportingV3_4::Report

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



10502
10503
10504
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10502

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) 


10400
10401
10402
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10400

def 
  @account_id
end

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

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

Returns:



10405
10406
10407
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10405

def criteria
  @criteria
end

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

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

Returns:



10410
10411
10412
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10410

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



10415
10416
10417
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10415

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10420
10421
10422
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10420

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) 


10425
10426
10427
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10425

def file_name
  @file_name
end

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

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

Returns:



10430
10431
10432
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10430

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) 


10438
10439
10440
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10438

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10443
10444
10445
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10443

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) 


10448
10449
10450
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10448

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) 


10454
10455
10456
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10454

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10459
10460
10461
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10459

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) 


10464
10465
10466
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10464

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



10469
10470
10471
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10469

def path_attribution_criteria
  @path_attribution_criteria
end

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

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

Returns:



10474
10475
10476
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10474

def path_criteria
  @path_criteria
end

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

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

Returns:



10479
10480
10481
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10479

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



10484
10485
10486
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10484

def reach_criteria
  @reach_criteria
end

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



10490
10491
10492
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10490

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) 


10495
10496
10497
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10495

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10500
10501
10502
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10500

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10507

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