Class: Google::Apis::DfareportingV2_5::Report

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


9327
9328
9329
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9327

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

Instance Attribute Details

#account_idString

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

Returns:

  • (String)

9235
9236
9237
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9235

def 
  @account_id
end

#criteriaGoogle::Apis::DfareportingV2_5::Report::Criteria

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


9240
9241
9242
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9240

def criteria
  @criteria
end

#cross_dimension_reach_criteriaGoogle::Apis::DfareportingV2_5::Report::CrossDimensionReachCriteria

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


9245
9246
9247
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9245

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

#deliveryGoogle::Apis::DfareportingV2_5::Report::Delivery

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


9250
9251
9252
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9250

def delivery
  @delivery
end

#etagString

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

Returns:

  • (String)

9255
9256
9257
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9255

def etag
  @etag
end

#file_nameString

The filename used when generating report files for this report. Corresponds to the JSON property fileName

Returns:

  • (String)

9260
9261
9262
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9260

def file_name
  @file_name
end

#floodlight_criteriaGoogle::Apis::DfareportingV2_5::Report::FloodlightCriteria

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


9265
9266
9267
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9265

def floodlight_criteria
  @floodlight_criteria
end

#formatString

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)

9273
9274
9275
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9273

def format
  @format
end

#idString

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

Returns:

  • (String)

9278
9279
9280
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9278

def id
  @id
end

#kindString

The kind of resource this is, in this case dfareporting#report. Corresponds to the JSON property kind

Returns:

  • (String)

9283
9284
9285
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9283

def kind
  @kind
end

#last_modified_timeString

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

Returns:

  • (String)

9289
9290
9291
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9289

def last_modified_time
  @last_modified_time
end

#nameString

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

Returns:

  • (String)

9294
9295
9296
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9294

def name
  @name
end

#owner_profile_idString

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

Returns:

  • (String)

9299
9300
9301
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9299

def owner_profile_id
  @owner_profile_id
end

#path_to_conversion_criteriaGoogle::Apis::DfareportingV2_5::Report::PathToConversionCriteria

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


9304
9305
9306
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9304

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

#reach_criteriaGoogle::Apis::DfareportingV2_5::Report::ReachCriteria

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


9309
9310
9311
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9309

def reach_criteria
  @reach_criteria
end

#scheduleGoogle::Apis::DfareportingV2_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


9315
9316
9317
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9315

def schedule
  @schedule
end

#sub_account_idString

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

Returns:

  • (String)

9320
9321
9322
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9320

def 
  @sub_account_id
end

#typeString

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

Returns:

  • (String)

9325
9326
9327
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9325

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9332

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