Class: Google::Apis::DfareportingV3_5::Report

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

Overview

Represents a Report resource.

Defined Under Namespace

Classes: Criteria, CrossDimensionReachCriteria, Delivery, FloodlightCriteria, PathAttributionCriteria, PathCriteria, PathToConversionCriteria, ReachCriteria, Schedule

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Report

Returns a new instance of Report.



10161
10162
10163
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10161

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) 


10059
10060
10061
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10059

def 
  @account_id
end

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

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

Returns:



10064
10065
10066
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10064

def criteria
  @criteria
end

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

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

Returns:



10069
10070
10071
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10069

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



10074
10075
10076
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10074

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10079
10080
10081
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10079

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) 


10084
10085
10086
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10084

def file_name
  @file_name
end

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

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

Returns:



10089
10090
10091
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10089

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) 


10097
10098
10099
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10097

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10102
10103
10104
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10102

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) 


10107
10108
10109
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10107

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) 


10113
10114
10115
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10113

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10118
10119
10120
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10118

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) 


10123
10124
10125
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10123

def owner_profile_id
  @owner_profile_id
end

#path_attribution_criteria ⇒ Google::Apis::DfareportingV3_5::Report::PathAttributionCriteria

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

Returns:



10128
10129
10130
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10128

def path_attribution_criteria
  @path_attribution_criteria
end

#path_criteria ⇒ Google::Apis::DfareportingV3_5::Report::PathCriteria

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

Returns:



10133
10134
10135
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10133

def path_criteria
  @path_criteria
end

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

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

Returns:



10138
10139
10140
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10138

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



10143
10144
10145
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10143

def reach_criteria
  @reach_criteria
end

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



10149
10150
10151
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10149

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) 


10154
10155
10156
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10154

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10159
10160
10161
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10159

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10166

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_attribution_criteria = args[:path_attribution_criteria] if args.key?(:path_attribution_criteria)
  @path_criteria = args[:path_criteria] if args.key?(:path_criteria)
  @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