Класс ECommerce

Методы класса создают объект ECommerce.

Для различных действий пользователя есть соответствующие типы ecommerce-событий. Чтобы создать конкретный тип события, используйте нужный метод класса.

Примечание

Объект ECommerce можно отправить с помощью метода reportECommerce(_:onFailure:) класса AppMetrica и протокола AppMetricaReporting.

Методы экземпляра

showScreenEvent(screen:)

Создает ecommerce-событие ShowScreenEvent. Используйте его, чтобы сообщить об открытии какой-либо страницы, например: списка товаров, поиска, главной страницы.

showProductCardEvent(product:screen:)

Создает ecommerce-событие ShowProductCardEvent. Используйте его, чтобы сообщить о просмотре карточки товара среди других в списке.

showProductDetailsEvent(product:referrer:)

Создает ecommerce-событие ShowProductDetailsEvent. Используйте его, чтобы сообщить о просмотре страницы товара.

addCartItemEvent(cartItem:)

Создает ecommerce-событие AddCartItemEvent. Используйте его, чтобы сообщить о добавлении товара в корзину.

removeCartItemEvent(cartItem:)

Создает ecommerce-событие RemoveCartItemEvent. Используйте его, чтобы сообщить об удалении товара из корзины.

beginCheckoutEvent(order:)

Создает ecommerce-событие BeginCheckoutEvent. Используйте его, чтобы сообщить о начале оформления покупки.

purchaseEvent(order:)

Создает ecommerce-событие PurchaseEvent. Используйте его, чтобы сообщить о завершении покупки.

Описание методов

showScreenEvent(screen:)

static func showScreenEvent(screen: ECommerceScreen) -> ECommerce

Создает ecommerce-событие ShowScreenEvent. Используйте его, чтобы сообщить об открытии какой-либо страницы, например: списка товаров, поиска, главной страницы.

Параметры:

screen

Экран, который был открыт. Объект класса ECommerceScreen.

Возвращает:

Объект класса ECommerce.

showProductCardEvent(product:screen:)

static func showProductCardEvent(product: ECommerceProduct,  screen: ECommerceScreen) -> ECommerce

Создает ecommerce-событие ShowProductCardEvent. Используйте его, чтобы сообщить о просмотре карточки товара среди других в списке.

Примечание

Перед отправкой события убедитесь, что карточка товара была показана на экране более N секунд.

Параметры:

product

Товар, который был показан. Объект класса ECommerceProduct.

screen

Экран, на котором был показан товар. Объект класса ECommerceScreen.

Возвращает:

Объект класса ECommerce.

showProductDetailsEvent(product:referrer:)

static func showProductDetailsEvent(product: ECommerceProduct, referrer: ECommerceReferrer?) -> ECommerce

Создает ecommerce-событие ShowProductDetailsEvent. Используйте его, чтобы сообщить о просмотре страницы товара.

Параметры:

product

Товар, который был показан. Объект класса ECommerceProduct.

referrer

Информация об источнике перехода на страницу товара. Объект класса ECommerceReferrer.

Возвращает:

Объект класса ECommerce.

addCartItemEvent(cartItem:)

static func addCartItemEvent(cartItem: ECommerceCartItem) -> ECommerce

Создает ecommerce-событие AddCartItemEvent. Используйте его, чтобы сообщить о добавлении товара в корзину.

Параметры:

item

Товар, который был добавлен в корзину. Объект класса ECommerceCartItem.

Возвращает:

Объект класса ECommerce.

removeCartItemEvent(cartItem:)

static func removeCartItemEvent(cartItem: ECommerceCartItem) -> ECommerce

Создает ecommerce-событие RemoveCartItemEvent. Используйте его, чтобы сообщить об удалении товара из корзины.

Параметры:

item

Товар, который был удален из корзины. Объект класса ECommerceCartItem.

Возвращает:

Объект класса ECommerce.

beginCheckoutEvent(order:)

static func beginCheckoutEvent(order: ECommerceOrder) -> ECommerce

Создает ecommerce-событие BeginCheckoutEvent. Используйте его, чтобы сообщить о начале оформления покупки.

Параметры:

order

Информация о покупке. Объект класса ECommerceOrder.

Возвращает:

Объект класса ECommerce.

purchaseEvent(order:)

static func purchaseEvent(order: ECommerceOrder) -> ECommerce

Создает ecommerce-событие PurchaseEvent. Используйте его, чтобы сообщить о завершении покупки.

Параметры:

order

Информация о покупке. Объект класса ECommerceOrder.

Возвращает:

Объект класса ECommerce.