Class Metrics

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

Inheritance
object
Metrics
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1.Data
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class Metrics : IDirectResponseSchema

Properties

Aos

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.

Declaration
[JsonProperty("aos")]
public virtual double? Aos { get; set; }
Property Value
Type Description
double?

AovMicros

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.

Declaration
[JsonProperty("aovMicros")]
public virtual double? AovMicros { get; set; }
Property Value
Type Description
double?

Clicks

Number of clicks.

Declaration
[JsonProperty("clicks")]
public virtual long? Clicks { get; set; }
Property Value
Type Description
long?

ConversionRate

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.

Declaration
[JsonProperty("conversionRate")]
public virtual double? ConversionRate { get; set; }
Property Value
Type Description
double?

ConversionValueMicros

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.

Declaration
[JsonProperty("conversionValueMicros")]
public virtual long? ConversionValueMicros { get; set; }
Property Value
Type Description
long?

Conversions

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.

Declaration
[JsonProperty("conversions")]
public virtual double? Conversions { get; set; }
Property Value
Type Description
double?

Ctr

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

Declaration
[JsonProperty("ctr")]
public virtual double? Ctr { get; set; }
Property Value
Type Description
double?

DaysToShip

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.

Declaration
[JsonProperty("daysToShip")]
public virtual double? DaysToShip { get; set; }
Property Value
Type Description
double?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Impressions

Number of times merchant's products are shown.

Declaration
[JsonProperty("impressions")]
public virtual long? Impressions { get; set; }
Property Value
Type Description
long?

ItemDaysToShip

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.

Declaration
[JsonProperty("itemDaysToShip")]
public virtual double? ItemDaysToShip { get; set; }
Property Value
Type Description
double?

ItemFillRate

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.

Declaration
[JsonProperty("itemFillRate")]
public virtual double? ItemFillRate { get; set; }
Property Value
Type Description
double?

OrderedItemSalesMicros

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.

Declaration
[JsonProperty("orderedItemSalesMicros")]
public virtual long? OrderedItemSalesMicros { get; set; }
Property Value
Type Description
long?

OrderedItems

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.

Declaration
[JsonProperty("orderedItems")]
public virtual long? OrderedItems { get; set; }
Property Value
Type Description
long?

Orders

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.

Declaration
[JsonProperty("orders")]
public virtual long? Orders { get; set; }
Property Value
Type Description
long?

RejectedItems

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.

Declaration
[JsonProperty("rejectedItems")]
public virtual long? RejectedItems { get; set; }
Property Value
Type Description
long?

ReturnRate

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.

Declaration
[JsonProperty("returnRate")]
public virtual double? ReturnRate { get; set; }
Property Value
Type Description
double?

ReturnedItems

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.

Declaration
[JsonProperty("returnedItems")]
public virtual long? ReturnedItems { get; set; }
Property Value
Type Description
long?

ReturnsMicros

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.

Declaration
[JsonProperty("returnsMicros")]
public virtual long? ReturnsMicros { get; set; }
Property Value
Type Description
long?

ShippedItemSalesMicros

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.

Declaration
[JsonProperty("shippedItemSalesMicros")]
public virtual long? ShippedItemSalesMicros { get; set; }
Property Value
Type Description
long?

ShippedItems

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.

Declaration
[JsonProperty("shippedItems")]
public virtual long? ShippedItems { get; set; }
Property Value
Type Description
long?

ShippedOrders

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.

Declaration
[JsonProperty("shippedOrders")]
public virtual long? ShippedOrders { get; set; }
Property Value
Type Description
long?

UnshippedItems

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.

Declaration
[JsonProperty("unshippedItems")]
public virtual double? UnshippedItems { get; set; }
Property Value
Type Description
double?

UnshippedOrders

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.

Declaration
[JsonProperty("unshippedOrders")]
public virtual double? UnshippedOrders { get; set; }
Property Value
Type Description
double?

Implements