Class: Google::Apis::DfareportingV5::Report

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dfareporting_v5/classes.rb,
lib/google/apis/dfareporting_v5/representations.rb,
lib/google/apis/dfareporting_v5/representations.rb

Overview

Represents a Report resource.

Defined Under Namespace

Classes: Criteria, CrossMediaReachCriteria, Delivery, FloodlightCriteria, PathToConversionCriteria, ReachCriteria, Schedule

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Report

Returns a new instance of Report.



10967
10968
10969
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10967

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) 


10875
10876
10877
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10875

def 
  @account_id
end

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

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

Returns:



10880
10881
10882
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10880

def criteria
  @criteria
end

#cross_media_reach_criteria ⇒ Google::Apis::DfareportingV5::Report::CrossMediaReachCriteria

Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". Corresponds to the JSON property crossMediaReachCriteria

Returns:



10885
10886
10887
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10885

def cross_media_reach_criteria
  @cross_media_reach_criteria
end

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

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

Returns:



10890
10891
10892
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10890

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10895
10896
10897
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10895

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) 


10900
10901
10902
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10900

def file_name
  @file_name
end

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

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

Returns:



10905
10906
10907
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10905

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) 


10913
10914
10915
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10913

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10918
10919
10920
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10918

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) 


10923
10924
10925
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10923

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) 


10929
10930
10931
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10929

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10934
10935
10936
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10934

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) 


10939
10940
10941
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10939

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



10944
10945
10946
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10944

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



10949
10950
10951
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10949

def reach_criteria
  @reach_criteria
end

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



10955
10956
10957
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10955

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) 


10960
10961
10962
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10960

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10965
10966
10967
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10965

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 10972

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @criteria = args[:criteria] if args.key?(:criteria)
  @cross_media_reach_criteria = args[:cross_media_reach_criteria] if args.key?(:cross_media_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