All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.content.model.Metrics.html Maven / Gradle / Ivy

There is a newer version: v2.1-rev20241217-2.0.0
Show newest version






Metrics (Content API for Shopping v2.1-rev20240609-2.0.0)












com.google.api.services.content.model

Class Metrics

  • All Implemented Interfaces:
    Cloneable, Map<String,Object>


    public final class Metrics
    extends com.google.api.client.json.GenericJson
    Performance metrics. Values are only set for metrics requested explicitly in the request's search query.

    This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.
    • Constructor Detail

      • Metrics

        public Metrics()
    • Method Detail

      • getAos

        public Double getAos()
        *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.**
        Returns:
        value or null for none
      • setAos

        public Metrics setAos(Double 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.**
        Parameters:
        aos - aos or null for none
      • getAovMicros

        public Double getAovMicros()
        *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.**
        Returns:
        value or null for none
      • setAovMicros

        public Metrics setAovMicros(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.**
        Parameters:
        aovMicros - aovMicros or null for none
      • getClicks

        public Long getClicks()
        Number of clicks.
        Returns:
        value or null for none
      • setClicks

        public Metrics setClicks(Long clicks)
        Number of clicks.
        Parameters:
        clicks - clicks or null for none
      • getConversionRate

        public Double getConversionRate()
        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.
        Returns:
        value or null for none
      • setConversionRate

        public Metrics setConversionRate(Double 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.
        Parameters:
        conversionRate - conversionRate or null for none
      • getConversionValueMicros

        public Long getConversionValueMicros()
        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.
        Returns:
        value or null for none
      • setConversionValueMicros

        public Metrics setConversionValueMicros(Long 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.
        Parameters:
        conversionValueMicros - conversionValueMicros or null for none
      • getConversions

        public Double getConversions()
        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.
        Returns:
        value or null for none
      • setConversions

        public Metrics setConversions(Double 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.
        Parameters:
        conversions - conversions or null for none
      • getCtr

        public Double getCtr()
        Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).
        Returns:
        value or null for none
      • setCtr

        public Metrics setCtr(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).
        Parameters:
        ctr - ctr or null for none
      • getDaysToShip

        public Double getDaysToShip()
        *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.**
        Returns:
        value or null for none
      • setDaysToShip

        public Metrics setDaysToShip(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.**
        Parameters:
        daysToShip - daysToShip or null for none
      • getImpressions

        public Long getImpressions()
        Number of times merchant's products are shown.
        Returns:
        value or null for none
      • setImpressions

        public Metrics setImpressions(Long impressions)
        Number of times merchant's products are shown.
        Parameters:
        impressions - impressions or null for none
      • getItemDaysToShip

        public Double getItemDaysToShip()
        *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.**
        Returns:
        value or null for none
      • setItemDaysToShip

        public Metrics setItemDaysToShip(Double 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.**
        Parameters:
        itemDaysToShip - itemDaysToShip or null for none
      • getItemFillRate

        public Double getItemFillRate()
        *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.**
        Returns:
        value or null for none
      • setItemFillRate

        public Metrics setItemFillRate(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.**
        Parameters:
        itemFillRate - itemFillRate or null for none
      • getOrderedItemSalesMicros

        public Long getOrderedItemSalesMicros()
        *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.**
        Returns:
        value or null for none
      • setOrderedItemSalesMicros

        public Metrics setOrderedItemSalesMicros(Long 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.**
        Parameters:
        orderedItemSalesMicros - orderedItemSalesMicros or null for none
      • getOrderedItems

        public Long getOrderedItems()
        *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.**
        Returns:
        value or null for none
      • setOrderedItems

        public Metrics setOrderedItems(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.**
        Parameters:
        orderedItems - orderedItems or null for none
      • getOrders

        public Long getOrders()
        *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.**
        Returns:
        value or null for none
      • setOrders

        public Metrics setOrders(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.**
        Parameters:
        orders - orders or null for none
      • getRejectedItems

        public Long getRejectedItems()
        *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.**
        Returns:
        value or null for none
      • setRejectedItems

        public Metrics setRejectedItems(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.**
        Parameters:
        rejectedItems - rejectedItems or null for none
      • getReturnRate

        public Double getReturnRate()
        *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.**
        Returns:
        value or null for none
      • setReturnRate

        public Metrics setReturnRate(Double 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.**
        Parameters:
        returnRate - returnRate or null for none
      • getReturnedItems

        public Long getReturnedItems()
        *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.**
        Returns:
        value or null for none
      • setReturnedItems

        public Metrics setReturnedItems(Long 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.**
        Parameters:
        returnedItems - returnedItems or null for none
      • getReturnsMicros

        public Long getReturnsMicros()
        *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.**
        Returns:
        value or null for none
      • setReturnsMicros

        public Metrics setReturnsMicros(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.**
        Parameters:
        returnsMicros - returnsMicros or null for none
      • getShippedItemSalesMicros

        public Long getShippedItemSalesMicros()
        *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.**
        Returns:
        value or null for none
      • setShippedItemSalesMicros

        public Metrics setShippedItemSalesMicros(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.**
        Parameters:
        shippedItemSalesMicros - shippedItemSalesMicros or null for none
      • getShippedItems

        public Long getShippedItems()
        *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.**
        Returns:
        value or null for none
      • setShippedItems

        public Metrics setShippedItems(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.**
        Parameters:
        shippedItems - shippedItems or null for none
      • getShippedOrders

        public Long getShippedOrders()
        *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.**
        Returns:
        value or null for none
      • setShippedOrders

        public Metrics setShippedOrders(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.**
        Parameters:
        shippedOrders - shippedOrders or null for none
      • getUnshippedItems

        public Double getUnshippedItems()
        *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.**
        Returns:
        value or null for none
      • setUnshippedItems

        public Metrics setUnshippedItems(Double 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.**
        Parameters:
        unshippedItems - unshippedItems or null for none
      • getUnshippedOrders

        public Double getUnshippedOrders()
        *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.**
        Returns:
        value or null for none
      • setUnshippedOrders

        public Metrics setUnshippedOrders(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.**
        Parameters:
        unshippedOrders - unshippedOrders or null for none
      • set

        public Metrics set(String fieldName,
                           Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson
      • clone

        public Metrics clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2025 Weber Informatics LLC | Privacy Policy