Nemu

https://docs.nemu.com.br
Admin
Nemu is a data platform that helps marketing professionals and agencies track campaign performance...
Tokens:70,353
Snippets:896
Trust Score:6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install iOS Native Dependencies

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

Navigate to the ios directory and run 'pod install' to install native dependencies required for the SDK on iOS.

```bash
cd ios
pod install
cd ..
```

--------------------------------

### Install react-native-config

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

Install react-native-config for managing environment variables and then run pod install for iOS.

```bash
yarn add react-native-config
cd ios && pod install && cd ..
```

--------------------------------

### Track Purchase Example

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Example of how to track a purchase, including attaching UTM parameters from the last session.

```APIDOC
## Track Purchase with UTMs

### Description
This function tracks a purchase event, including order ID, amount, and UTM parameters from the user's last session.

### Method
`Future<void> trackPurchase(String orderId, double amount)`

### Parameters
- **orderId** (String) - Required - The unique identifier for the order.
- **amount** (double) - Required - The total amount of the purchase.

### Request Body Example
```json
{
  "orderId": "your_order_id",
  "amount": 100.50,
  "lastSource": "google",
  "lastCampaign": "summer_sale",
  "lastMedium": "cpc",
  "origin": "web"
}
```

### Response
This function does not return a value, but it sends purchase data to the backend.
```

--------------------------------

### Example Final URL with Standard Checkout

Source: https://docs.nemu.com.br/pages/onboarding/configuracao-utms/google/google

This example shows the final destination URL structure when using the standard checkout configuration with Nemu UTM parameters appended.

```text
https://www.exemplo.com/produto?utm_source=google&utm_medium=cpc&utm_campaign=promo_julho&nemu_source=google&nemu_campaign={campaignid}&nemu_adset={adgroupid}_{assetgroupid}&nemu_content={creative}&nemu_term={keyword}
```

--------------------------------

### Fetch Dependencies

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Run this command in your terminal to install the SDK and its transitive dependencies.

```bash
flutter pub get
```

--------------------------------

### Practical Example of Meta Tax Calculation

Source: https://docs.nemu.com.br/pages/plataforma/gerenciador-anuncios/impostos-meta

Demonstrates the Meta tax calculation with a specific spending amount and tax rate. This example shows how to apply the formula to find the exact tax amount and the effective total cost.

```plaintext
Imposto Meta = (6.573,03 × 0,1215) ÷ (1 - 0,1215)
= 798,62 ÷ 0,8785
= R$ 909,08
```

--------------------------------

### Example Final Destination URL with Standard Checkout

Source: https://docs.nemu.com.br/pages/onboarding/configuracao-utms/facebook/facebook

This example shows the complete URL structure after adding Nemu UTM parameters for a standard checkout. It combines traditional UTMs with Nemu-specific parameters for comprehensive tracking.

```text
https://www.exemplo.com/produto?utm_source=facebook&utm_campaign={{campaign.name}}|{{campaign.id}}&utm_medium=cpc&utm_content={{ad.name}}|{{ad.id}}&utm_term={{adset.name}}|{{adset.id}}&nemu_source=facebook&nemu_campaign={{campaign.name}}|{{campaign.id}}&nemu_adset={{adset.name}}|{{adset.id}}&nemu_content={{ad.name}}|{{ad.id}}
```

--------------------------------

### Install Nemu SDK via Local Path

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Use a local path for development purposes.

```yaml
dependencies:
  nemu_tracking_flutter:
    path: ../sdk-app-tracking-flutter
```

--------------------------------

### Example Campaign Link with UTMs

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

This is an example of a campaign link that includes UTM parameters for tracking user acquisition sources. These parameters are used by the Nemu SDK for attribution.

```url
https://mywebsite.com?utm_source=nemu&utm_medium=cpc&utm_campaign=campaign-test
```

--------------------------------

### Install Nemu SDK via Git

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Add the private Nemu SDK repository to your pubspec.yaml file.

```yaml
dependencies:
  nemu_tracking_flutter:
    git:
      url: https://github.com/usenemu/sdk-app-tracking-flutter.git
      ref: main
```

--------------------------------

### Install React Native SDK

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

Use npm or yarn to add the Nemu React Native SDK to your project.

```bash
npm install @nemu/react-native-sdk
# ou
yarn add @nemu/react-native-sdk
```

--------------------------------

### YouTube Influencer UTM Example

Source: https://docs.nemu.com.br/pages/onboarding/configuracao-utms/influenciadores/influenciadores

This example shows the UTM parameter structure for tracking YouTube influencer campaigns. The campaign name and medium should replace spaces with underscores.

```text
https://meusite.com/?utm_source=influencer&utm_medium=maria_santos&utm_campaign=promo_review_produto&utm_content=video
```

--------------------------------

### Configure Redirect URL with Shortcodes

Source: https://docs.nemu.com.br/pages/onboarding/integracoes/elementor

Example structure for a redirect URL using Elementor field shortcodes to pass captured parameters.

```text
https://www.meucheckout.com/?email=[field id="email"]&src=[field id="src"]
```

--------------------------------

### Track Begin Checkout Event

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

Indicate the start of the purchase process by sending a 'begin_checkout' event. This helps in analyzing checkout funnel performance.

```typescript
NemuTracking.sendEvent("begin_checkout");
```

--------------------------------

### Initialize Nemu SDK in Application onCreate

Source: https://docs.nemu.com.br/pages/app-tracking/kotlin-sdk

Initialize the NemuTrackingLib in your application's onCreate method using the PIXEL_ID and SDK_TOKEN from BuildConfig. This should be done once when the application starts.

```java
import android.app.Application
import com.nemu.NemuTrackingLib
// ...
class MyApp: Application() {
    override fun onCreate() {
        super.onCreate()
        // ...
     // Utilização de variáveis de ambiente
NemuTrackingLib.getInstance().init(BuildConfig.PIXEL_ID, BuildConfig.SDK_TOKEN, this)
        // ...
    }
    // ...
}
```

--------------------------------

### Register User ID on App Start for Logged-in Users

Source: https://docs.nemu.com.br/pages/app-tracking/kotlin-sdk

If a user is already logged in when the SDK is installed, register their UID in the Application's onCreate method or after loading saved user data to ensure continuous tracking.

```java
class MyApp: Application() {
override fun onCreate() {
            super.onCreate()

        // Verifica se o usuário está logado
            val userId = UserSessionManager.getCurrentUserId()
            if (userId != null) {
                NemuTrackingLib.getInstance().setUserId(userId)
            }
}
}
```

--------------------------------

### Verify SDK Initialization Logs

Source: https://docs.nemu.com.br/pages/app-tracking/kotlin-sdk

Expected log output confirming successful connection, UTM extraction, and UID registration.

```text
2025-05-22 14:55:02 [DEBUG] [NemuTracking] application has been successfully connected with Nemu services

2025-05-22 14:55:03 [DEBUG] [NemuTracking] Reading of UTM parameters via deeplink successfully performed - {"utm_source": "nemu","utm_medium": "medium-test","utm_campaign": "campaign-test","utm_content": "content-test"}

2025-05-22 14:55:04 [DEBUG] [NemuTracking] UID registered by the application - { "userId": "example@email.com" }
```

--------------------------------

### TikTok Video Organic UTM Example

Source: https://docs.nemu.com.br/pages/onboarding/configuracao-utms/organicas/organicas

Example of UTM parameters for a tutorial video posted on TikTok. The utm_medium is 'organic' to signify unpaid promotion.

```text
https://meusite.com/?utm_source=tiktok&utm_medium=organic&utm_campaign=video_tutorial
```

--------------------------------

### Instagram Feed Organic UTM Example

Source: https://docs.nemu.com.br/pages/onboarding/configuracao-utms/organicas/organicas

This example shows how to configure UTMs for organic posts on the Instagram feed. The utm_campaign parameter specifies the product promotion.

```text
https://meusite.com/?utm_source=instagram&utm_medium=organic&utm_campaign=feed_produto
```

--------------------------------

### SDK Initialization and Debug Mode

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Demonstrates how to initialize the Nemu Tracking SDK and enable debug mode for detailed logging.

```APIDOC
## Initialize SDK with Debug Mode

### Description
Initializes the Nemu Tracking SDK. Enabling `isDebugMode` provides detailed logs in the console, which is useful for debugging. Remember to disable it in production.

### Method
`NemuTracking.instance.init(NemuInitParams params)`

### Parameters
- **params** (NemuInitParams) - Required - Initialization parameters.
  - **apiKey** (String) - Required - Your Nemu API key.
  - **uriScheme** (String) - Required - The URI scheme for your application.
  - **trackingId** (String) - Required - Your Nemu tracking ID.
  - **isDebugMode** (bool) - Optional (default: false) - Enables debug logging.
  - **baseUrl** (String?) - Optional - Overrides the default base URL, typically used for development/staging environments when `isDebugMode` is true.

### Request Example
```dart
NemuTracking.instance.init(
  const NemuInitParams(
    apiKey: 'sua-api-key',
    uriScheme: 'seuapp',
    trackingId: 'seu-tracking-id',
    isDebugMode: true,
  ),
);
```

### Warning
Disable debug mode in production as logs may contain sensitive information.
```

--------------------------------

### Configure SDK Token and Pixel ID in build.gradle.kts

Source: https://docs.nemu.com.br/pages/app-tracking/kotlin-sdk

Load SDK_TOKEN and PIXEL_ID from environment variables or a .env file and configure them as buildConfigFields in your build.gradle.kts. This is recommended for security.

```java
val sdkToken = System.getenv("SDK_TOKEN") ?: "default"
val pixelId = System.getenv("PIXEL_ID") ?: "default"
buildConfigField("String", "SDK_TOKEN", "\"$sdkToken\"")
buildConfigField("String", "PIXEL_ID", "\"$pixelId\"")
```

--------------------------------

### Add Android Install Referrer Dependency

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

Add the installreferrer dependency to your android/app/build.gradle file for Android attribution.

```gradle
dependencies {
  implementation "com.android.installreferrer:installreferrer:2.2"
}
```

--------------------------------

### Initialize Nemu SDK

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Configures the SDK with initialization parameters, including debug mode and custom base URLs.

```dart
NemuTracking.instance.init(
  const NemuInitParams(
    apiKey: 'sua-api-key',
    uriScheme: 'seuapp',
    trackingId: 'seu-tracking-id',
    isDebugMode: true,
  ),
);
```

```dart
NemuTracking.instance.init(
  const NemuInitParams(
    apiKey: 'sua-api-key',
    uriScheme: 'seuapp',
    trackingId: 'seu-tracking-id',
    isDebugMode: true,
    baseUrl: 'https://staging-trackings.nemu.com.br',
  ),
);
```

--------------------------------

### Initialize Nemu Tracking SDK using flutter_dotenv

Source: https://docs.nemu.com.br/pages/app-tracking/flutter-sdk

Load environment variables from a .env file and initialize the Nemu Tracking SDK. Remember to add .env to .gitignore.

```dart
import 'package:flutter_dotenv/flutter_dotenv.dart';

await dotenv.load();

NemuTracking.instance.init(
  NemuInitParams(
    apiKey: dotenv.env['NEMU_API_KEY']!,
    uriScheme: dotenv.env['NEMU_URI_SCHEME']!,
    trackingId: dotenv.env['NEMU_TRACKING_ID']!,
  ),
);
```

--------------------------------

### Recuperar histórico de sessão com Swift

Source: https://docs.nemu.com.br/pages/app-tracking/swift-sdk

Utilize este método para acessar os dados da última sessão e validar os parâmetros UTM armazenados.

```swift
func sendPurchaseWithUtms() {
    guard let session = TrackingManager.shared.getLastSessionHistory() else {
        print("No sessions found")
        return
    }

    print("utmSource: \(session.utmSource ?? "nil")")
    print("utmCampaign: \(session.utmCampaign ?? "nil")")
    print("utmMedium: \(session.utmMedium ?? "nil")")
    print("utmContent: \(session.utmContent ?? "nil")")
    print("utmTerm: \(session.utmTerm ?? "nil")")
}
```

--------------------------------

### Simulate Deep Link Access (Bash)

Source: https://docs.nemu.com.br/pages/app-tracking/swift-sdk

Use this command in the terminal to simulate opening a deep link with UTM parameters on a booted simulator. This is useful for testing the SDK's ability to capture UTMs.

```bash
xcrun simctl openurl booted "https://myapp.com?utm_source=nemu&utm_medium=medium-test&utm_campaign=campaign-test&utm_content=content-test"
```

--------------------------------

### GET getLastSessionHistory

Source: https://docs.nemu.com.br/pages/app-tracking/react-native-sdk

Retrieves the last session history including UTM parameters for use in external API calls like purchase tracking.

```APIDOC
## GET getLastSessionHistory

### Description
Retrieves the last session history including UTM parameters for use in external API calls like purchase tracking.

### Method
GET

### Response
#### Success Response (200)
- **utmSource** (string) - The source of the traffic.
- **utmMedium** (string) - The medium of the traffic.
- **utmCampaign** (string) - The campaign name.
- **utmContent** (string) - The content identifier.
- **utmTerm** (string) - The search term.

### Response Example
{
  "utmSource": "google",
  "utmMedium": "cpc",
  "utmCampaign": "summer_sale",
  "utmContent": null,
  "utmTerm": null
}
```

--------------------------------

### Install UTM tracking script for Atomicat

Source: https://docs.nemu.com.br/pages/onboarding/integracoes/atomicat

Paste this script into the Head section of your Atomicat page settings to automatically append UTM parameters to all links.

```js
<script>
   var timer = setInterval(function () {
      const location =
         window.trackingNemu?.nemuUtms ||
         new URL(document.location.href)?.searchParams;
      const fields = [
         "src",
         "sck",
         "utm_source",
         "utm_medium",
         "utm_campaign",
         "utm_content",
         "utm_term",
         "nemu_source",
         "nemu_medium",
         "nemu_campaign",
         "nemu_content",
         "nemu_adset",
         "nemu_term"
      ];
      var links = document.getElementsByTagName("a");

      for (var i = 0, n = links.length; i < n; i++) {
         if (links[i].href.includes("#")) continue;
         if (links[i].href) {
            let link = new URL(links[i].href);
            fields.forEach((field) => {
               if (location.get(field))
                  link.searchParams.set(field, location.get(field));
            });
            let href = link.href;
            links[i].href = href;
         }
      }
   }, 500);
</script>
```

--------------------------------

### TikTok Influencer UTM Example

Source: https://docs.nemu.com.br/pages/onboarding/configuracao-utms/influenciadores/influenciadores

Configure UTM parameters using this format for TikTok influencer campaigns. The medium and campaign parameters should use underscores for spaces.

```text
https://meusite.com/?utm_source=influencer&utm_medium=joao_silva&utm_campaign=promo_lancamento&utm_content=video
```
Tokens:
Raw