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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Report

Returns a new instance of Report.



10399
10400
10401
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10399

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) 


10307
10308
10309
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10307

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:



10312
10313
10314
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10312

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:



10317
10318
10319
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10317

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:



10322
10323
10324
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10322

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10327
10328
10329
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10327

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) 


10332
10333
10334
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10332

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:



10337
10338
10339
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10337

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) 


10345
10346
10347
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10345

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10350
10351
10352
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10350

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) 


10355
10356
10357
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10355

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) 


10361
10362
10363
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10361

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10366
10367
10368
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10366

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) 


10371
10372
10373
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10371

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:



10376
10377
10378
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10376

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:



10381
10382
10383
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10381

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:



10387
10388
10389
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10387

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) 


10392
10393
10394
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10392

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10397
10398
10399
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10397

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10404

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