Class: Google::Apis::ContentV2_1::Metrics

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

Performance metrics. Values are only set for metrics requested explicitly in the request's search query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Metrics

Returns a new instance of Metrics.



7073
7074
7075
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7073

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

Instance Attribute Details

#aos ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order size - the average number of items in an order. This metric cannot be segmented by product dimensions and customer_country_code. Corresponds to the JSON property aos

Returns:

  • (Float) 


6873
6874
6875
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6873

def aos
  @aos
end

#aov_micros ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. This metric cannot be segmented by product dimensions and customer_country_code. Corresponds to the JSON property aovMicros

Returns:

  • (Float) 


6886
6887
6888
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6886

def aov_micros
  @aov_micros
end

#clicks ⇒ Fixnum

Number of clicks. Corresponds to the JSON property clicks

Returns:

  • (Fixnum) 


6891
6892
6893
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6891

def clicks
  @clicks
end

#conversion_rate ⇒ Float

Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the FREE_PRODUCT_LISTING program. Corresponds to the JSON property conversionRate

Returns:

  • (Float) 


6898
6899
6900
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6898

def conversion_rate
  @conversion_rate
end

#conversion_value_micros ⇒ Fixnum

Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the FREE_PRODUCT_LISTING program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. Corresponds to the JSON property conversionValueMicros

Returns:

  • (Fixnum) 


6909
6910
6911
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6909

def conversion_value_micros
  @conversion_value_micros
end

#conversions ⇒ Float

Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. The metric is currently available only for the FREE_PRODUCT_LISTING program. Corresponds to the JSON property conversions

Returns:

  • (Float) 


6918
6919
6920
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6918

def conversions
  @conversions
end

#ctr ⇒ Float

Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Corresponds to the JSON property ctr

Returns:

  • (Float) 


6924
6925
6926
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6924

def ctr
  @ctr
end

#days_to_ship ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. This metric cannot be segmented by product dimensions and customer_country_code. Corresponds to the JSON property daysToShip

Returns:

  • (Float) 


6932
6933
6934
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6932

def days_to_ship
  @days_to_ship
end

#impressions ⇒ Fixnum

Number of times merchant's products are shown. Corresponds to the JSON property impressions

Returns:

  • (Fixnum) 


6937
6938
6939
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6937

def impressions
  @impressions
end

#item_days_to_ship ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an item being ordered and the item being *This metric cannot be segmented by customer_country_code. * Corresponds to the JSON property itemDaysToShip

Returns:

  • (Float) 


6945
6946
6947
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6945

def item_days_to_ship
  @item_days_to_ship
end

#item_fill_rate ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property itemFillRate

Returns:

  • (Float) 


6955
6956
6957
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6955

def item_fill_rate
  @item_fill_rate
end

#ordered_item_sales_micros ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property orderedItemSalesMicros

Returns:

  • (Fixnum) 


6968
6969
6970
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6968

def ordered_item_sales_micros
  @ordered_item_sales_micros
end

#ordered_items ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property orderedItems

Returns:

  • (Fixnum) 


6976
6977
6978
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6976

def ordered_items
  @ordered_items
end

#orders ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. This metric cannot be segmented by product dimensions and customer_country_code. Corresponds to the JSON property orders

Returns:

  • (Fixnum) 


6984
6985
6986
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6984

def orders
  @orders
end

#rejected_items ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items canceled by the merchant, reported on the order date. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property rejectedItems

Returns:

  • (Fixnum) 


6992
6993
6994
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6992

def rejected_items
  @rejected_items
end

#return_rate ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property returnRate

Returns:

  • (Float) 


7003
7004
7005
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7003

def return_rate
  @return_rate
end

#returned_items ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items sent back for return, reported on the date when the merchant accepted the return. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property returnedItems

Returns:

  • (Fixnum) 


7011
7012
7013
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7011

def returned_items
  @returned_items
end

#returns_micros ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, ' segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property returnsMicros

Returns:

  • (Fixnum) 


7024
7025
7026
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7024

def returns_micros
  @returns_micros
end

#shipped_item_sales_micros ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property shippedItemSalesMicros

Returns:

  • (Fixnum) 


7036
7037
7038
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7036

def shipped_item_sales_micros
  @shipped_item_sales_micros
end

#shipped_items ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of shipped items, reported on the shipment date. This metric cannot be segmented by customer_country_code. Corresponds to the JSON property shippedItems

Returns:

  • (Fixnum) 


7043
7044
7045
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7043

def shipped_items
  @shipped_items
end

#shipped_orders ⇒ Fixnum

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of fully shipped orders, reported on the last shipment date. This metric cannot be segmented by product dimensions and customer_country_code. Corresponds to the JSON property shippedOrders

Returns:

  • (Fixnum) 


7051
7052
7053
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7051

def shipped_orders
  @shipped_orders
end

#unshipped_items ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. *This metric cannot be segmented by customer_country_code. * Corresponds to the JSON property unshippedItems

Returns:

  • (Float) 


7061
7062
7063
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7061

def unshipped_items
  @unshipped_items
end

#unshipped_orders ⇒ Float

Deprecated: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. This metric cannot be segmented by product dimensions and customer_country_code. Corresponds to the JSON property unshippedOrders

Returns:

  • (Float) 


7071
7072
7073
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7071

def unshipped_orders
  @unshipped_orders
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 7078

def update!(**args)
  @aos = args[:aos] if args.key?(:aos)
  @aov_micros = args[:aov_micros] if args.key?(:aov_micros)
  @clicks = args[:clicks] if args.key?(:clicks)
  @conversion_rate = args[:conversion_rate] if args.key?(:conversion_rate)
  @conversion_value_micros = args[:conversion_value_micros] if args.key?(:conversion_value_micros)
  @conversions = args[:conversions] if args.key?(:conversions)
  @ctr = args[:ctr] if args.key?(:ctr)
  @days_to_ship = args[:days_to_ship] if args.key?(:days_to_ship)
  @impressions = args[:impressions] if args.key?(:impressions)
  @item_days_to_ship = args[:item_days_to_ship] if args.key?(:item_days_to_ship)
  @item_fill_rate = args[:item_fill_rate] if args.key?(:item_fill_rate)
  @ordered_item_sales_micros = args[:ordered_item_sales_micros] if args.key?(:ordered_item_sales_micros)
  @ordered_items = args[:ordered_items] if args.key?(:ordered_items)
  @orders = args[:orders] if args.key?(:orders)
  @rejected_items = args[:rejected_items] if args.key?(:rejected_items)
  @return_rate = args[:return_rate] if args.key?(:return_rate)
  @returned_items = args[:returned_items] if args.key?(:returned_items)
  @returns_micros = args[:returns_micros] if args.key?(:returns_micros)
  @shipped_item_sales_micros = args[:shipped_item_sales_micros] if args.key?(:shipped_item_sales_micros)
  @shipped_items = args[:shipped_items] if args.key?(:shipped_items)
  @shipped_orders = args[:shipped_orders] if args.key?(:shipped_orders)
  @unshipped_items = args[:unshipped_items] if args.key?(:unshipped_items)
  @unshipped_orders = args[:unshipped_orders] if args.key?(:unshipped_orders)
end