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

# AMAAppMetricaReporting 协议

## Instance methods {#instance_summary}

#|
|| -[清除应用环境](#method_clearAppEnvironment) | 删除与所有未来事件相关的所有键值数据。 ||
|| -[暂停会话](#method_pauseSession) | 暂停会话。 ||
|| -[reportAdRevenue:onFailure:](#method_reportAdRevenue__onFailure) | 向 AppMetrica 服务器发送关于广告收入的信息。 ||
|| -[reportECommerce:onFailure](#method_reportECommerce__onFailure) | 发送关于电商事件的消息。 ||
|| -[reportEvent:onFailure](#method_reportEvent__onFailure) | 发送自定义事件消息。 ||
|| -[reportEvent:parameters:onFailure](#method_reportEvent__parameters__onFailure) | 发送自定义事件消息，包含额外参数。 ||
|| -[reportRevenue:onFailure:](#method_reportRevenue__onFailure) | 将购买信息发送到AppMetrica服务器。 ||
|| -[reportUserProfile:onFailure](#method_reportUserProfile__onFailure) | 发送关于用户资料更新的信息。 ||
|| [resumeSession](#method_resumeSession) | 恢复会话，或在会话超时后创建新会话。 ||
|| -[sendEventsBuffer](#method_sendEventsBuffer) | 从缓冲区发送已存储的事件。 ||
|| -[setAppEnvironmentValue:forKey:](#method_setAppEnvironmentValue__forKey) | 设置与所有未来事件关联的键值对。 ||
|| -[setDataSendingEnabled:](#method_setDataSendingEnabled) | 启用/禁用向 AppMetrica 服务器发送统计数据。 ||
|| -[setupWebViewReporting:onFailure:](#method_setupWebViewReporting__onFailure) | 在指定的 webview 中为窗口添加一个名为 AppMetrica 的 JavaScript 接口。 这让你能从 JavaScript 代码发送客户端事件。 ||
|#

## Properties {#property_summary}

#|
|| [userProfileID](#property_userProfileID) | 设置 [用户资料](https://appmetrica.yandex.by/docs/zh/data-collection/about-profiles.md) 的 ID。 ||
|#

## Method descriptions {#method_detail}

### -clearAppEnvironment {#method_clearAppEnvironment}

```objectivec translate=no
- (void)clearAppEnvironment;
```

清理应用环境，例如删除与所有未来事件相关的所有键值数据。

### -pauseSession {#method_pauseSession}

```objectivec translate=no
- (void)pauseSession;
```

暂停用户会话。

### -reportAdRevenue:onFailure: {#method_reportAdRevenue__onFailure}

```objectivec translate=no
- (void)reportAdRevenue:(AMAAdRevenueInfo *)adRevenue
              onFailure:(nullable void (^)(NSError *error))onFailure;
```

向AppMetrica服务器发送关于广告收入的信息。

**参数：**

#|
|| `广告收入` | 包含广告收入信息的 [AMAAdRevenueInfo](https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/objectivec/AMAAdRevenueInfo.md) 类的实例。 ||
|| `onFailure` | 发生错误时执行的代码块。 错误作为块参数传递。 ||
|#

### -reportECommerce:onFailure {#method_reportECommerce__onFailure}

```objectivec translate=no
- (void)reportECommerce:(AMAECommerce *)eCommerce
              onFailure:(nullable void (^)(NSError *error))onFailure;
```

发送关于电商事件的消息。

**参数：**

#|
|| `电子商务` | The [AMAECommerce](https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/objectivec/AMAECommerce.md) 类实例。 ||
|| `onFailure` | 发生错误时执行的代码块。 错误作为块参数传递。 ||
|#

### -reportEvent:onFailure {#method_reportEvent__onFailure}

```objectivec translate=no
- (void)reportEvent:(NSString *)name
          onFailure:(nullable void (^)(NSError *error))onFailure;
```

发送自定义事件消息。

**参数：**

#|
|| `名称` | 事件的简短名称或描述。 ||
|| `onFailure` | 发生错误时执行的代码块。 错误作为块参数传递。 ||
|#

### -reportEvent:parameters:onFailure {#method_reportEvent__parameters__onFailure}

```objectivec translate=no
- (void)reportEvent:(NSString *)name
         parameters:(nullable NSDictionary *)params
          onFailure:(nullable void (^)(NSError *error))onFailure;
```

发送自定义事件消息，包含额外参数。

**参数：**

#|
|| `名称` | 事件的简短名称或描述。 ||
|| `params` | 参数以键值对形式。 ||
|| `onFailure` | 发生错误时执行的代码块。 错误作为块参数传递。 ||
|#

### -reportRevenue:onFailure: {#method_reportRevenue__onFailure}

```objectivec translate=no
- (void)reportRevenue:(AMARevenueInfo *)revenueInfo
            onFailure:(nullable void (^)(NSError *error))onFailure;
```

将购买信息发送到AppMetrica服务器。

**参数：**

#|
|| `收入信息` | 包含购买信息的 [AMARevenueInfo](https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/objectivec/AMARevenueInfo.md) 类的实例。 ||
|| `onFailure` | 发生错误时执行的代码块。 错误作为块参数传递。 ||
|#

### -reportUserProfile:onFailure {#method_reportUserProfile__onFailure}

```objectivec translate=no
- (void)reportUserProfile:(AMAUserProfile *)userProfile
                onFailure:(nullable void (^)(NSError *error))onFailure;
```

将用户个人资料更新信息发送到AppMetrica服务器。

**参数：**

#|
|| `用户个人资料` | 包含用户个人信息的 [AMAUserProfile](https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/objectivec/AMAUserProfile.md) 类的实例。 ||
|| `onFailure` | 当发生错误时执行的代码块。 错误作为块参数传递。 ||
|#

### -resumeSession {#method_resumeSession}

```objectivec translate=no
- (void)resumeSession;
```

恢复会话，如果会话超时则创建新会话。

### -sendEventsBuffer {#method_sendEventsBuffer}

```objectivec translate=no
- (void)sendEventsBuffer;
```

从缓冲区发送已存储的事件。

AppMetrica SDK 不会在事件发生后立即发送事件。 库存放事件数据在缓冲区中。 方法 `+sendEventsBuffer` 会从缓冲区发送数据并清空缓冲区。 使用该方法在用户场景的重要检查点之后强制发送已存储的事件。

{% note alert %}

频繁使用该方法可能会导致出去的互联网流量和能耗增加。

{% endnote %}

### -setAppEnvironmentValue:forKey: {#method_setAppEnvironmentValue__forKey}

```objectivec translate=no
- (void)setAppEnvironmentValue:(nullable NSString *)value
                        forKey:(NSString *)key;
```

设置键值数据，作为与所有未来事件相关的附加信息使用。

如果值为零，之前设置的键值将被删除。 如果没有添加密钥，就不会执行任何操作。

**参数：**

#|
|| `value` | Value. ||
|| `key` | Key. ||
|#

### -setDataSendingEnabled: {#method_setDataSendingEnabled}

```objectivec translate=no
- (void)setDataSendingEnabled:(BOOL)enabled;
```

启用/禁用向 AppMetrica 服务器发送统计数据。

{% note info %}

禁用向报告者发送统计数据不会影响从主API密钥发送数据。 但禁用主 API 密钥的数据发送会停止所有报告器发送统计数据。

{% endnote %}

**参数：**

#|
|| `已启用` | 一个标志，表示已启用发送统计数据。 默认值是`是`。
可能的值：

- `是`：已启用发送统计数据。
- `无`：已禁用发送统计数据。 ||
   |#

### -setupWebViewReporting:onFailure: {#method_setupWebViewReporting__onFailure}

```objectivec translate=no
- (void)setupWebViewReporting:(id<AMAJSControlling>)controller
                    onFailure:(nullable void (^)(NSError *error))onFailure;
```

在指定的 webview 中添加一个名为 AppMetrica 的 JavaScript 接口。 这让你能从 JavaScript 代码发送客户端事件。

Notes:

- 该方法必须从主队列调用。
- 该方法在 tvOS 上不可用。
- 在加载任何内容之前调用此方法。 我们建议在创建 webview 以及向 WKUserContentController 添加脚本之前调用此方法。
   要了解更多信息，请参见[使用示例](https://appmetrica.yandex.by/docs/zh/sdk/ios/analytics/ios-operations.md#js-event)。

**参数：**

#|
|| `controller` | The `AMAJSControlling` 实例。 ||
|| `onFailure` | 在发生错误时会被调用的回调方法。 ||
|#

## Property descriptions {#property_detail}

### userProfileID {#property_userProfileID}

```objectivec translate=no
@property (class, nonatomic, nullable) NSString *userProfileID;
```

设置 [用户资料](https://appmetrica.yandex.by/docs/zh/data-collection/about-profiles.md) 的 ID。 AppMetrica 在网页界面中不会显示 `预定义属性`，如果未配置 [ProfieId](https://appmetrica.yandex.by/docs/zh/data-collection/about-profiles.md#pre-defined) 的发送。
