Package com.yandex.metrica.ecommerce

Class ECommerceProduct

java.lang.Object
com.yandex.metrica.ecommerce.ECommerceProduct
public class ECommerceProduct
extends java.lang.Object
Describes a product.

  • Constructor Details

    • ECommerceProduct

      public ECommerceProduct​(@NonNull java.lang.String sku)
      Creates a product.
      Parameters:
      sku - product SKU (Stock Keeping Unit).

  • Method Details

    • getSku

      @NonNull public java.lang.String getSku()
      Returns:
      sku
      See Also:
      ECommerceProduct(String)

    • getName

      @Nullable public java.lang.String getName()
      Returns:
      name
      See Also:
      setName(String)

    • setName

      @NonNull public ECommerceProduct setName​(@Nullable java.lang.String name)
      Sets product name.
      Parameters:
      name - Name of the product.
      Returns:
      same ECommerceProduct object

    • getCategoriesPath

      @Nullable public java.util.List<java.lang.String> getCategoriesPath()
      Returns:
      categories path
      See Also:
      setCategoriesPath(java.util.List)

    • setCategoriesPath

      @NonNull public ECommerceProduct setCategoriesPath​(@Nullable java.util.List<java.lang.String> categoriesPath)
      Sets product categories path.
      Parameters:
      categoriesPath - Categories-wise path to the product.
      Returns:
      same ECommerceProduct object

    • getPayload

      @Nullable public java.util.Map<java.lang.String,​java.lang.String> getPayload()
      Returns:
      payload
      See Also:
      setPayload(java.util.Map)

    • setPayload

      @NonNull public ECommerceProduct setPayload​(@Nullable java.util.Map<java.lang.String,​java.lang.String> payload)
      Sets payload.
      Parameters:
      payload - Payload - additional key-value structured data with various content.
      Returns:
      same ECommerceProduct object

    • getActualPrice

      @Nullable public ECommercePrice getActualPrice()
      Returns:
      actual price
      See Also:
      setActualPrice(ECommercePrice)

    • setActualPrice

      @NonNull public ECommerceProduct setActualPrice​(@Nullable ECommercePrice actualPrice)
      Sets actual price of the product - price after all discounts and promocodes are applied.
      Parameters:
      actualPrice - Actual price of the product.
      Returns:
      same ECommerceProduct object
      See Also:
      ECommercePrice

    • getOriginalPrice

      @Nullable public ECommercePrice getOriginalPrice()
      Returns:
      original price
      See Also:
      setOriginalPrice(ECommercePrice)

    • setOriginalPrice

      @NonNull public ECommerceProduct setOriginalPrice​(@Nullable ECommercePrice originalPrice)
      Sets original price of the product.
      Parameters:
      originalPrice - Original price of the product.
      Returns:
      same ECommerceProduct object
      See Also:
      ECommercePrice

    • getPromocodes

      @Nullable public java.util.List<java.lang.String> getPromocodes()
      Returns:
      promocodes
      See Also:
      setPromocodes(java.util.List)

    • setPromocodes

      @NonNull public ECommerceProduct setPromocodes​(@Nullable java.util.List<java.lang.String> promocodes)
      Sets promocodes.
      Parameters:
      promocodes - List of promocodes applied to the product.
      Returns:
      same ECommerceProduct object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object