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, PathAttributionCriteria, PathCriteria, 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.


10666
10667
10668
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10666

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

Instance Attribute Details

#account_idFixnum

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

Returns:

  • (Fixnum)

10564
10565
10566
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10564

def 
  @account_id
end

#criteriaGoogle::Apis::DfareportingV3_4::Report::Criteria

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


10569
10570
10571
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10569

def criteria
  @criteria
end

#cross_dimension_reach_criteriaGoogle::Apis::DfareportingV3_4::Report::CrossDimensionReachCriteria

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


10574
10575
10576
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10574

def cross_dimension_reach_criteria
  @cross_dimension_reach_criteria
end

#deliveryGoogle::Apis::DfareportingV3_4::Report::Delivery

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


10579
10580
10581
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10579

def delivery
  @delivery
end

#etagString

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

Returns:

  • (String)

10584
10585
10586
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10584

def etag
  @etag
end

#file_nameString

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

Returns:

  • (String)

10589
10590
10591
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10589

def file_name
  @file_name
end

#floodlight_criteriaGoogle::Apis::DfareportingV3_4::Report::FloodlightCriteria

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


10594
10595
10596
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10594

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)

10602
10603
10604
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10602

def format
  @format
end

#idFixnum

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

Returns:

  • (Fixnum)

10607
10608
10609
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10607

def id
  @id
end

#kindString

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

Returns:

  • (String)

10612
10613
10614
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10612

def kind
  @kind
end

#last_modified_timeFixnum

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

Returns:

  • (Fixnum)

10618
10619
10620
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10618

def last_modified_time
  @last_modified_time
end

#nameString

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

Returns:

  • (String)

10623
10624
10625
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10623

def name
  @name
end

#owner_profile_idFixnum

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

Returns:

  • (Fixnum)

10628
10629
10630
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10628

def owner_profile_id
  @owner_profile_id
end

#path_attribution_criteriaGoogle::Apis::DfareportingV3_4::Report::PathAttributionCriteria

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


10633
10634
10635
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10633

def path_attribution_criteria
  @path_attribution_criteria
end

#path_criteriaGoogle::Apis::DfareportingV3_4::Report::PathCriteria

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


10638
10639
10640
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10638

def path_criteria
  @path_criteria
end

#path_to_conversion_criteriaGoogle::Apis::DfareportingV3_4::Report::PathToConversionCriteria

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


10643
10644
10645
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10643

def path_to_conversion_criteria
  @path_to_conversion_criteria
end

#reach_criteriaGoogle::Apis::DfareportingV3_4::Report::ReachCriteria

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


10648
10649
10650
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10648

def reach_criteria
  @reach_criteria
end

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


10654
10655
10656
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10654

def schedule
  @schedule
end

#sub_account_idFixnum

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

Returns:

  • (Fixnum)

10659
10660
10661
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10659

def 
  @sub_account_id
end

#typeString

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

Returns:

  • (String)

10664
10665
10666
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10664

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10671

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