com.yandex.metrica.ecommerce
Class ECommerceScreen
java.lang.Object
com.yandex.metrica.ecommerce.ECommerceScreen
public class ECommerceScreen
extends java.lang.Object
Класс с информацией об экране/странице.
Method Summary
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> | getCategoriesPath()
Возвращает путь к экрану по категориям.
|
java.lang.String | getName()
Возвращает название экрана.
|
java.util.Map<java.lang.String,java.lang.String> | getPayload()
Возвращает дополнительную информацию об экране.
|
java.lang.String | getSearchQuery()
Возвращает поисковый запрос.
|
ECommerceScreen | setCategoriesPath(java.util.List<java.lang.String> categoriesPath)
Задает путь к экрану по категориям.
|
ECommerceScreen | setName(java.lang.String name)
Задает название экрана.
|
ECommerceScreen | setPayload(java.util.Map<java.lang.String,java.lang.String> payload)
Задает дополнительную информацию об экране.
|
ECommerceScreen | setSearchQuery(java.lang.String searchQuery)
Задает поисковый запрос.
|
java.lang.String | toString() |
Method Detail
getName
@Nullable public java.lang.String getName()
Возвращает название экрана.
- Returns:
- Название экрана.
- See Also:
setName(String)
setName
public ECommerceScreen setName(@Nullable java.lang.String name)
Задает название экрана.
- Parameters:
name
- Название экрана. Допустимые размеры: до 100 символов.- Returns:
- Объект класса
ECommerceScreen
.
getCategoriesPath
@Nullable public java.util.List<java.lang.String> getCategoriesPath()
Возвращает путь к экрану по категориям.
- Returns:
- Путь к экрану по категориям.
- See Also:
setCategoriesPath(java.util.List)
setCategoriesPath
public ECommerceScreen setCategoriesPath(@Nullable java.util.List<java.lang.String> categoriesPath)
Задает путь к экрану по категориям.
- Parameters:
categoriesPath
- Путь к экрану по категориям. Допустимые размеры: до 10 элементов; размер одного элемента до 100 символов.- Returns:
- same
ECommerceScreen
object
getSearchQuery
@Nullable public java.lang.String getSearchQuery()
Возвращает поисковый запрос.
- Returns:
- Поисковый запрос.
- See Also:
setSearchQuery(String)
setSearchQuery
public ECommerceScreen setSearchQuery(@Nullable java.lang.String searchQuery)
Задает поисковый запрос.
- Parameters:
searchQuery
- Поисковый запрос. Допустимые размеры: до 1000 символов.- Returns:
- Объект класса
ECommerceScreen
.
getPayload
@Nullable public java.util.Map<java.lang.String,java.lang.String> getPayload()
Возвращает дополнительную информацию об экране.
- Returns:
- Дополнительная информация об экране.
- See Also:
setPayload(java.util.Map)
setPayload
public ECommerceScreen setPayload(@Nullable java.util.Map<java.lang.String,java.lang.String> payload)
Задает дополнительную информацию об экране.
- Parameters:
payload
- PДополнительная информация об экране. Допустимые размеры: общий размер payload: до 20 КБ; размер key: до 100 символов; размер value: до 1000 символов.- Returns:
- Объект класса
ECommerceScreen
.
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object