---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
alternate:
  - https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/ECommerceScreen.md
  - https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/ECommerceScreen.md
  - https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/swift/ECommerceScreen.md
  - href: https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/swift/ECommerceScreen.md
    type: text/markdown
    title: Markdown version
  - href: https://appmetrica.yandex.by/docs/zh/llms.txt?revision=r21920615
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.by/docs/zh/llms.txt?revision=r21920615

# ECommerceScreen 类

此类包含屏幕信息。

## Instance methods {#instance_summary}

#|
|| [init(name:)](#method_initWithName) | 初始化 `ECommerceScreen` 类的实例，使用指定的屏幕名称。 ||
|| [init(categoryComponents:)](#method_initWithCategoryComponents) | 初始化 `ECommerceScreen` 类的实例，使用指定的屏幕路径。 ||
|| [init(searchQuery:)](#method_initWithSearchQuery) | 用指定的搜索查询初始化 `ECommerceScreen` 类的实例。 ||
|| [init(payload:)](#method_initWithPayload) | 用指定的附加信息初始化 `ECommerceScreen` 类的实例。 ||
|| [init(name:categoryComponents:searchQuery:payload:)](#method_initWithName__currency__categoryComponents__searchQuery__payload) | Initializes the instance of the `电子商务屏幕` class with all parameters. ||
|#

## Properties {#property_summary}

#|
|| [名称](#property_name) | 屏幕名称。 允许的大小：最多100个字符。||
|| [categoryComponents](#property_categoryComponents) | 按类别到屏幕的路径。 ||
|| [搜索查询](#property_searchQuery) | 搜索查询。 允许的大小：最多1000个字符。 ||
|| [payload](#property_payload) | 屏幕的额外信息。 ||
|#

## Method descriptions {#method_detail}

### init(name:) {#method_initWithName}

```swift translate=no
init(name: String)
```

初始化 `ECommerceScreen` 类的实例，使用指定的屏幕名称。

**参数：**

#|
|| `名称` | 屏幕名称。 允许的大小：最多100个字符。 ||
|#

**返回：**

The `电商屏幕` 类实例。

### init(categoryComponents:) {#method_initWithCategoryComponents}

```swift translate=no
init(categoryComponents: [String])
```

Initializes the instance of the `电子商务屏幕` class with the specified path to the screen.

**参数：**

#|
|| `categoryComponents` | 按类别到屏幕的路径。 可接受的大小：

- 最多10个元素。
- 单个元素的大小最多为100个字符。 ||
   |#

**返回：**

The `电商屏幕` 类实例。

### init(searchQuery:) {#method_initWithSearchQuery}

```swift translate=no
init(searchQuery: String)
```

用指定的搜索查询初始化 `ECommerceScreen` 类的实例。

**参数：**

#|
|| `searchQuery` | 搜索查询。 允许的大小：最多1000个字符。 ||
|#

**返回：**

The `电商屏幕` 类实例。

### init(payload:) {#method_initWithPayload}

```swift translate=no
init(payload: [String: String])
```

用指定的额外信息初始化 `ECommerceScreen` 类的实例。

**参数：**

#|
|| `payload` | 屏幕的额外信息。 可接受的大小：

- 总 `负载` 大小：最多 20 KB。
- 键`的`长度：最多100个字符。
- 该`值`大小：最多1000个字符。 ||
   |#

**返回：**

The `电商屏幕` 类实例。

### init(name:categoryComponents:searchQuery:payload:) {#method_initWithName__currency__categoryComponents__searchQuery__payload}

```swift translate=no
init(name: String?, categoryComponents: [String]?, searchQuery: String?, payload: [String: String]?)
```

Initializes the instance of the `电子商务屏幕` class with all parameters.

**参数：**

#|
|| `名称` | 屏幕名称。 允许的大小：最多100个字符。 ||
|| `categoryComponents` | 按类别到屏幕的路径。 可接受的大小：

- 最多10个元素。
- 单个元素的大小最多为100个字符。 ||
   || `searchQuery` | 搜索查询。 允许的大小：最多1000个字符。 ||
   || `payload` | 屏幕的附加信息。 可接受的大小：

- 总 `负载` 大小：最多 20 KB。
- 键`长度`：最多100个字符。
- `值`大小：最多1000个字符。 ||
   |#

**返回：**

The `电商屏幕` 类实例。

## Property descriptions {#property_detail}

### name {#property_name}

`var name: String? { get }`

屏幕名称。 允许的大小：最多100个字符。

### categoryComponents {#property_categoryComponents}

`var categoryComponents: [String]? { get }`

按类别到屏幕的路径。 可接受的尺寸：

- 最多10个元素。
- 单个元素的大小最多为100个字符。

### searchQuery {#property_searchQuery}

`var searchQuery: String? { get }`

搜索查询。 允许的大小：最多1000个字符。

### payload {#property_payload}

`var payload: [String: String]? { get }`

屏幕的更多信息。 可接受的大小：

- 总 `负载` 大小：最多 20 KB。
- 键`的`长度：最多100个字符。
- `值`的大小：最多1000个字符。