Custom Plugin Use Cases in Mobile SDKs

This guide covers the different use cases for custom plugins in the RudderStack Android (Kotlin) and iOS (Swift) SDKs, along with the expected event payload and links to the source code.

Overview

RudderStack maintains sample custom plugins in the Android (Kotlin) and iOS (Swift) SDK sample applications. You can use these plugins as reference implementations to build your own custom plugins.

User agent collection

These plugins add user agent information to the event context for better device identification. They populate the context.userAgent field.

Android (Kotlin)

Use UserAgentPlugin to add user agent information to events.

Find the source code for this plugin here.

iOS (Swift)

Two plugins are available for user agent collection:

Sample payload

{
	// ....
  "context": {
	   // ....
    "userAgent": "Dalvik/2.1.0 (Linux; U; Android 16; sdk_gphone64_arm64 Build/BE2A.250530.026.D1)"
  },
  // ....
}

Push notification token

Use SetPushTokenPlugin to add push notification tokens to the event’s device context for targeted messaging. It populates the context.device.token field.

Find the source code for this plugin in the following locations:

• Android (Kotlin)
• iOS (Swift)

Sample payload

{
  // ....
  "context": {
    // ....
    "device": {
      // ...
      "token": "<TOKEN_VALUE>",
      // ...
    },
    // ....
  },
  // ....
}

Override anonymous ID

Use SetAnonymousIdPlugin to replace the default SDK-generated anonymous ID with a custom value in the event payload. It populates the anonymousId field.

Find the source code for this plugin in the following locations:

• Android (Kotlin)
• iOS (Swift)

Global event options

The OptionPlugin adds global custom context, integrations, and external IDs to all events. It populates the following fields:

• context.externalId
• Custom context in context
• integrations

Find the source code for this plugin in the following locations:

• Android (Kotlin)
• iOS (Swift)

Sample payload

{
  // ....
  "context": {
    // ....
    "externalId": [
      {
        "id": "someValue",
        "type": "globalExternalId"
      }
    ],
    "sampleKey": "sampleValue", // Custom context
    // ....
  },
  "integrations": {
    "All": true,
    "CleverTap": true
  },
  // ....
}

Collect advertising ID

Use the plugins in this section to collect and add the advertising ID and ad tracking status to events. They populate the following fields:

• context.device.advertisingId
• context.device.adTrackingEnabled

Android (Kotlin)

Use AndroidAdvertisingIdPlugin to collect and add the Google Advertising ID (GAID) or Amazon Fire Advertising ID and ad tracking status.

Find the source code for this plugin here.

iOS (Swift)

Use AdvertisingIdPlugin to collect and add the iOS Advertising Identifier (IDFA) with ATT compliance.

Find the source code for this plugin here.

Sample payload

{
  // ....
  "context": {
    // ....
    "device": {
      "adTrackingEnabled": true,
      "advertisingId": "6934136c-002f-4b4d-8088-90cd71497a3a",
    },
    // ....
  },
  // ....
}

Event filtering

Use EventFilteringPlugin to filter out specific analytics events from being processed by the SDK.

Find the source code for this plugin in the following locations:

• Android (Kotlin)
• iOS (Swift)

Add Bluetooth information (iOS)

This plugin is available only for the iOS (Swift) SDK.

Use BluetoothInfoPlugin to add Bluetooth availability information to the network context. It populates the context.network.bluetooth field.

Find the source code for this plugin here.

Sample payload

{
    // ....
    "context": {
        // ....
        "network": {
            "bluetooth": true,
        },
        // ....
    },
    // ....
}

Get ATT tracking status (iOS)

This plugin is available only for the iOS (Swift) SDK.

Use SetATTTrackingStatusPlugin to set a custom App Tracking Transparency (ATT) status in the device context. It populates the context.device.attTrackingStatus field.

Find the source code for this plugin here.

Sample payload

{
    // ....
    "context": {
        // ....
        "device": {
            "attTrackingStatus": 0,
        },
    },
    // ....
}

See more

• Plugin Architecture in Mobile SDKs: Understand the plugin system and how to create custom plugins
• Create Custom Plugin: Steps to create a custom plugin
• How to Use Device Mode Integrations: Add custom plugins to device mode integrations

Questions? Contact us by Email or on Slack