Class: Google::Apis::DfareportingV3_4::Report

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



10231
10232
10233
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10231

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) 


10139
10140
10141
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10139

def 
  @account_id
end

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

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

Returns:



10144
10145
10146
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10144

def criteria
  @criteria
end

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

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

Returns:



10149
10150
10151
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10149

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

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

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

Returns:



10154
10155
10156
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10154

def delivery
  @delivery
end

#etag ⇒ String

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

Returns:

  • (String) 


10159
10160
10161
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10159

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) 


10164
10165
10166
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10164

def file_name
  @file_name
end

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

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

Returns:



10169
10170
10171
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10169

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) 


10177
10178
10179
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10177

def format
  @format
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10182
10183
10184
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10182

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) 


10187
10188
10189
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10187

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) 


10193
10194
10195
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10193

def last_modified_time
  @last_modified_time
end

#name ⇒ String

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

Returns:

  • (String) 


10198
10199
10200
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10198

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) 


10203
10204
10205
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10203

def owner_profile_id
  @owner_profile_id
end

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

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

Returns:



10208
10209
10210
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10208

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

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

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

Returns:



10213
10214
10215
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10213

def reach_criteria
  @reach_criteria
end

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



10219
10220
10221
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10219

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) 


10224
10225
10226
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10224

def 
  @sub_account_id
end

#type ⇒ String

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

Returns:

  • (String) 


10229
10230
10231
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10229

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10236

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