Class: Google::Apis::ContentV2_1::RepricingProductReport

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

Overview

Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RepricingProductReport

Returns a new instance of RepricingProductReport.



11873
11874
11875
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11873

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

Instance Attribute Details

#application_count ⇒ Fixnum

Total count of Repricer applications. This value captures how many times the rule of this type was applied to this product during this reporting period. Corresponds to the JSON property applicationCount

Returns:

  • (Fixnum) 


11815
11816
11817
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11815

def application_count
  @application_count
end

#buybox_winning_product_stats ⇒ Google::Apis::ContentV2_1::RepricingProductReportBuyboxWinningProductStats

Stats specific to buybox winning rules for product report. Corresponds to the JSON property buyboxWinningProductStats

Returns:



11820
11821
11822
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11820

def buybox_winning_product_stats
  @buybox_winning_product_stats
end

#date ⇒ Google::Apis::ContentV2_1::Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property date

Returns:



11832
11833
11834
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11832

def date
  @date
end

#high_watermark ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property highWatermark

Returns:



11837
11838
11839
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11837

def high_watermark
  @high_watermark
end

#inapplicability_details ⇒ Array<Google::Apis::ContentV2_1::InapplicabilityDetails>

List of all reasons the rule did not apply to the product during the specified reporting period. Corresponds to the JSON property inapplicabilityDetails

Returns:



11843
11844
11845
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11843

def inapplicability_details
  @inapplicability_details
end

#low_watermark ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property lowWatermark

Returns:



11848
11849
11850
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11848

def low_watermark
  @low_watermark
end

#order_item_count ⇒ Fixnum

Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed. Corresponds to the JSON property orderItemCount

Returns:

  • (Fixnum) 


11856
11857
11858
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11856

def order_item_count
  @order_item_count
end

#rule_ids ⇒ Array<String>

Ids of the Repricing rule for this report. Corresponds to the JSON property ruleIds

Returns:

  • (Array<String>) 


11861
11862
11863
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11861

def rule_ids
  @rule_ids
end

#total_gmv ⇒ Google::Apis::ContentV2_1::PriceAmount

The price represented as a number and currency. Corresponds to the JSON property totalGmv

Returns:



11866
11867
11868
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11866

def total_gmv
  @total_gmv
end

#type ⇒ String

Type of the rule. Corresponds to the JSON property type

Returns:

  • (String) 


11871
11872
11873
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11871

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11878

def update!(**args)
  @application_count = args[:application_count] if args.key?(:application_count)
  @buybox_winning_product_stats = args[:buybox_winning_product_stats] if args.key?(:buybox_winning_product_stats)
  @date = args[:date] if args.key?(:date)
  @high_watermark = args[:high_watermark] if args.key?(:high_watermark)
  @inapplicability_details = args[:inapplicability_details] if args.key?(:inapplicability_details)
  @low_watermark = args[:low_watermark] if args.key?(:low_watermark)
  @order_item_count = args[:order_item_count] if args.key?(:order_item_count)
  @rule_ids = args[:rule_ids] if args.key?(:rule_ids)
  @total_gmv = args[:total_gmv] if args.key?(:total_gmv)
  @type = args[:type] if args.key?(:type)
end