Class: Google::Apis::DfareportingV3_2::Report

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



9984
9985
9986
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9984

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) 


9892
9893
9894
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9892

def 
  @account_id
end

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

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

Returns:



9897
9898
9899
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9897

def criteria
  @criteria
end

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

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

Returns:



9902
9903
9904
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9902

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



9907
9908
9909
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9907

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9912
9913
9914
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9912

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) 


9917
9918
9919
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9917

def file_name
  @file_name
end

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

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

Returns:



9922
9923
9924
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9922

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) 


9930
9931
9932
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9930

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9935
9936
9937
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9935

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) 


9940
9941
9942
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9940

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) 


9946
9947
9948
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9946

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


9951
9952
9953
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9951

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) 


9956
9957
9958
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9956

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



9961
9962
9963
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9961

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



9966
9967
9968
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9966

def reach_criteria
  @reach_criteria
end

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



9972
9973
9974
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9972

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) 


9977
9978
9979
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9977

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


9982
9983
9984
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9982

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 9989

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