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



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

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) 


9851
9852
9853
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9851

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:



9856
9857
9858
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9856

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:



9861
9862
9863
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9861

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:



9866
9867
9868
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9866

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


9871
9872
9873
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9871

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) 


9876
9877
9878
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9876

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:



9881
9882
9883
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9881

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) 


9889
9890
9891
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9889

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9894
9895
9896
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9894

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) 


9899
9900
9901
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9899

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) 


9905
9906
9907
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9905

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


9910
9911
9912
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9910

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) 


9915
9916
9917
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9915

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:



9920
9921
9922
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9920

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:



9925
9926
9927
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9925

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:



9931
9932
9933
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9931

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) 


9936
9937
9938
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9936

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


9941
9942
9943
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9941

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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