Class: Google::Apis::DfareportingV3_1::Report

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



9945
9946
9947
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9945

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) 


9853
9854
9855
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9853

def 
  @account_id
end

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

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

Returns:



9858
9859
9860
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9858

def criteria
  @criteria
end

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

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

Returns:



9863
9864
9865
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9863

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



9868
9869
9870
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9868

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9873
9874
9875
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9873

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) 


9878
9879
9880
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9878

def file_name
  @file_name
end

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

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

Returns:



9883
9884
9885
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9883

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) 


9891
9892
9893
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9891

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9896
9897
9898
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9896

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) 


9901
9902
9903
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9901

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) 


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

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



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

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



9927
9928
9929
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9927

def reach_criteria
  @reach_criteria
end

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



9933
9934
9935
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9933

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) 


9938
9939
9940
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9938

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


9943
9944
9945
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9943

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9950

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