Class: Google::Apis::DfareportingV2_3::Report

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



8941
8942
8943
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8941

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ String

The account ID to which this report belongs. Corresponds to the JSON property accountId

Returns:

  • (String) 


8849
8850
8851
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8849

def 
  @account_id
end

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

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

Returns:



8854
8855
8856
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8854

def criteria
  @criteria
end

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

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

Returns:



8859
8860
8861
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8859

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



8864
8865
8866
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8864

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


8869
8870
8871
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8869

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) 


8874
8875
8876
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8874

def file_name
  @file_name
end

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

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

Returns:



8879
8880
8881
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8879

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) 


8887
8888
8889
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8887

def format
  @format
end

#id ⇒ String

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

Returns:

  • (String) 


8892
8893
8894
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8892

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) 


8897
8898
8899
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8897

def kind
  @kind
end

#last_modified_time ⇒ String

The timestamp (in milliseconds since epoch) of when this report was last modified. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


8903
8904
8905
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8903

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


8908
8909
8910
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8908

def name
  @name
end

#owner_profile_id ⇒ String

The user profile id of the owner of this report. Corresponds to the JSON property ownerProfileId

Returns:

  • (String) 


8913
8914
8915
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8913

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



8918
8919
8920
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8918

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



8923
8924
8925
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8923

def reach_criteria
  @reach_criteria
end

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



8929
8930
8931
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8929

def schedule
  @schedule
end

#sub_account_id ⇒ String

The subaccount ID to which this report belongs if applicable. Corresponds to the JSON property subAccountId

Returns:

  • (String) 


8934
8935
8936
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8934

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


8939
8940
8941
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8939

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8946

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