Class: Google::Apis::DfareportingV2_7::Report

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



9615
9616
9617
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9615

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) 


9523
9524
9525
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9523

def 
  @account_id
end

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

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

Returns:



9528
9529
9530
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9528

def criteria
  @criteria
end

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

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

Returns:



9533
9534
9535
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9533

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



9538
9539
9540
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9538

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9543
9544
9545
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9543

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) 


9548
9549
9550
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9548

def file_name
  @file_name
end

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

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

Returns:



9553
9554
9555
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9553

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) 


9561
9562
9563
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9561

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9566
9567
9568
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9566

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) 


9571
9572
9573
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9571

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) 


9577
9578
9579
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9577

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


9582
9583
9584
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9582

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) 


9587
9588
9589
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9587

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



9592
9593
9594
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9592

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



9597
9598
9599
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9597

def reach_criteria
  @reach_criteria
end

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



9603
9604
9605
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9603

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) 


9608
9609
9610
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9608

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


9613
9614
9615
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9613

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 9620

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