### Launch App Example

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/launch-app-after-installation

Use this example to launch an app after installation. Ensure IgniteServiceSdk is initialized and provide the package name and IgniteActions.LAUNCH.name. A callback is included to handle success or error responses.

```kotlin
// Initialization

// ...

IgniteServiceSdk.instance().performAction(packageName, IgniteActions.LAUNCH.name, Bundle(), object : IResponseCallback<PerformActionResponse, Error, Progress> {
        override fun onSuccess(result: PerformActionResponse) {
            Log.d(TAG, "Perform Action CallBack Success ${result.application.packageName}")
        }

        override fun onError(error: Error) {
            Log.e(TAG, "Perform Action CallBack Error: ${error.message}")
        }
    })
```

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

### Install App by URI with Callback

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/receive-installation-notifications

Use this method to install an app from a URI and receive installation status updates through the `IResponseCallback` interface. Ensure you implement the callback methods to handle different stages of the installation process.

```Kotlin
val file = File("${context.filesDir}", "MyFunGame.apk")
val uriString = file.toUri().toString()

IgniteServiceSdk.instance().install(uriString, buildSingleInstallationCallback())
```

```Kotlin
private fun buildSingleInstallationCallback() = object : IResponseCallback<InstallationResponse, Error, InstallationProgress> {
    override fun onScheduled(taskInfo: TaskInfo) {
        Log.i(TAG, "Install application onScheduled(): taskId=${taskInfo.taskId}")
        
        // Store task id when scheduled to track it later if needed
        currentInstallTask = taskInfo.taskId
    }

    override fun onStart(taskInfo: TaskInfo) {
        Log.i(TAG, "Install application onStart(): taskId=${taskInfo.taskId}")
        
        // E.g. show indefinite progress as application installation task started
        showProgress()
    }

    override fun onProgress(progress: InstallationProgress) = with(progress) {
        Log.d(TAG, "Install application onProgress(): taskId=${taskId}, appId=${applicationId}, progress=${value}, action=$action")
        
        // E.g. show progress as application started donwload and installation
        showProgress()
        
        // 0 stands for download progress
        // 1 stands for install progress
        when (action) {
            0 -> updateDownloadProgress(value)
            1 -> updateInstallProgress(value)
        }
    }

    override fun onSuccess(result: InstallationResponse) {
        Log.d(TAG, "Install application onSuccess(): taskId=${result.taskId}, appId=${result.applicationId}, package=${result.packageName}")
        
        // E.g. hide progress as application is installed succesfully
        hideProgress()
    }

    override fun onError(error: Error) {
        Log.e(TAG, "Install application onError(): ${error.message}")
        hideProgress()
    }

    private fun showProgress() = progressBar?.visibility = View.VISIBLE
    private fun hideProgress() = progressBar?.visibility = View.GONE
}
```

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

### Start SDK with Virtual Currency Delegates (C#)

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Define delegate handlers for virtual currency responses and errors, then start the SDK with your app ID and secret token. This setup is for Unity.

```csharp
public delegate void VirtualCurrencyResponseHandler(VirtualCurrencySuccessfulResponse response);
public delegate void VirtualCurrencyErrorHandler(VirtualCurrencyErrorResponse response);

OfferWall.StartSDK(appId: "appId", token: "secret_token");
```

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

### install() Method

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/install-app

The install method initiates the installation process for a target application using the DTIS SDK.

```APIDOC
## install()

### Description
Use the install() method to specify the target app you want to download. You can specify the target app by its unique package name or its APK file URI.

### Parameters
- **data** (String) - Required - The unique package name or APK file URI of the target app.
- **callback** (IResponseCallback<InstallationResponse, Error, InstallationProgress>) - Optional - Callback for installation response, errors, and progress.
- **metadata** (Bundle) - Optional - Additional metadata for the installation request.
- **action** (Bundle) - Optional - Action parameters for the installation request.
- **config** (RequestConfig) - Optional - Configuration settings for the request.

### Request Example
```kotlin
install("com.example.app", callback = myCallback)
```
```

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

### Install SDK and Dependencies

Source: https://docs.digitalturbine.com/dt-exchange/publishers/sdk-configuration/integrating-the-ios-sdk

Execute this command to install the SDK and its dependencies, and generate an Xcode workspace file.

```bash
pod install --repo-update
```

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

### Full Integration Example in Kotlin

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/getting-started-with-the-dt-ignite-services-sdk

This Kotlin code demonstrates a full integration with the DTIS SDK. It shows how to initialize the SDK, connect to the service, call the 'version' function, and initiate an app installation. Ensure you handle callbacks for connection status and installation results.

```kotlin
class MainActivity : AppCompatActivity(), IConnectionCallback {
    // Remember instance or you can call IgniteServiceSdk.instance()
    lateinit var igniteService: IIgniteService

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        igniteService = IgniteService(applicationContext)
        igniteService.connect(this)

        // Call remote function on button click
        findViewById<Button>(R.id.version).setOnClickListener {
            val result = igniteService.version()
            Toast.makeText(applicationContext, "SDK version: ${result?.sdkVersion}, Ignite version: ${result?.igniteVersion}", Toast.LENGTH_SHORT).show()
        }

        findViewById<Button>(R.id.install).setOnClickListener {
            val file = File("${requireContext().filesDir}", "myfungame.apk")
            val data = file.toUri().toString()
            
            igniteService.install(data, object : IResponseCallback<InstallationResponse, Error, InstallationProgress> {
                override fun onSuccess(result: InstallationResponse) {
                    Log.d("InstallApp","onSuccess(): taskId=${result.taskId}, appId=${result.applicationId}, package=${result.packageName}, partnerMetadata=${result.partnerMetaData}")
                }

                override fun onError(error: Error) {
                    Log.d("InstallApp","onError(): message=${error.message}, code=${error.code}, partnerMetadata=${error.partnerMetadata}")
                }
            })
        }

        // Other API methods
    }

    override fun onConnected() {
        Toast.makeText(applicationContext, "Connected to Ignite Service", Toast.LENGTH_SHORT).show()
    }

    override fun onAuthenticated() {
        Toast.makeText(applicationContext, "Authenticated", Toast.LENGTH_SHORT).show()
    }

    override fun onDisconnected(message: String?) {
        Toast.makeText(applicationContext, "Disconnected from Ignite Service: $message", Toast.LENGTH_SHORT).show()
    }

    override fun onDestroy() {
        super.onDestroy()
        igniteService.disconnect(this)
    }
}
```

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

### Install App by URI in Kotlin

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/install-app

Initiates an app installation from a local APK file URI.

```kotlin
// Initialization

// Install application via uri string and do not listen to updates
val file = File("${context.filesDir}", "MyFunGame.apk")
val uriString = file.toUri().toString()

IgniteServiceSdk.instance().install(uriString)

// ...
```

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

### Start FairBid SDK

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/supported-networks/network-integration-guides/amazon-publisher-services

Initiate the FairBid SDK before starting the APS SDK. No additional setup is required.

```objectivec
+ [FairBid startWithAppId:options:]
```

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

### Start APS SDK in C#

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/supported-networks/network-integration-guides/amazon-publisher-services

Add the `start` call to your C# methods, typically after initializing FairBid. Ensure you replace 'YOUR APP KEY HERE' with your actual app key.

```csharp
AndroidJavaClass unityPlayer = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
AndroidJavaObject activity = unityPlayer.GetStatic<AndroidJavaObject>("currentActivity");
AndroidJavaClass jc = new AndroidJavaClass("com.fyber.aps.compat.AmazonAPS");
jc.CallStatic("start", "YOUR APP KEY HERE", activity);
```

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

### OfferWall.start

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Initializes the Offer Wall SDK. Starting from version 3.63.0, a saltToken is required to start the SDK.

```APIDOC
## OfferWall.start

### Description
Initializes the Offer Wall SDK. A saltToken is mandatory for initialization; the SDK will throw a Runtime Exception if it is null or empty.

### Parameters
- **activity** (Object) - Required (Android) - The current activity context.
- **appId** (String) - Required - The unique application identifier.
- **offerWallListener/delegate** (Object) - Required - Listener or delegate to handle lifecycle callbacks.
- **saltToken** (String) - Required - Security token provided by your DT Representative.
- **virtualCurrencySettings** (Object) - Optional (iOS) - Settings for virtual currency.

### Request Example
// Android (Kotlin)
OfferWall.start(activity = activity, appId = appId, offerWallListener = offerWallListener, saltToken = saltToken);

// iOS (Swift)
OfferWall.start(with: appIdText, delegate: self, virtualCurrencySettings: nil, saltToken: saltToken) { [self] error in };

// Unity (C#)
OfferWall.StartSDK(appId, saltToken);
```

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

### Install App by Package Name in Kotlin

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/install-app

Initiates an app installation using its package name string without setting up status listeners.

```kotlin
// Initialization 

// Install application via package name string and do not listen to updates
val packageName = "com.package.name"
IgniteServiceSdk.instance().install(packageName)

// ...
```

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

### Install App via Package Name with Callback and Broadcast

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/receive-installation-notifications

Combines both callback and broadcast receiver mechanisms for comprehensive installation tracking.

```kotlin
// Initialization

// Install application via package name string and listen to updates 
// using callback and broadcast receiver action

val packageName = "com.package.name"
IgniteServiceSdk.getInstance().install(
    packageName,
    buildInstallationCallback(),
    buildInstallAction()
)

// ...

// See implementations of buildInstallationCallback() and buildInstallAction() in other examples
```

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

### Install App by URI with Broadcast

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/receive-installation-notifications

Install an app using its URI and receive installation status updates via a broadcast receiver action. Ensure you have registered the receiver in your `AndroidManifest.xml` and configured it to process the broadcast information.

```Kotlin
val file = File("${context.filesDir}", "MyFunGame.apk")
val uriString = file.toUri().toString()

IgniteServiceSdk.instance().install(
    uriString,
    buildInstallationCallback(),
    action = buildInstallAction()
)
```

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

### App Installation Parameters

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/install-app

Parameters for initiating an app installation through the Digital Turbine SDK.

```APIDOC
## Parameters for App Installation

### Description
This section describes the parameters used to configure and initiate an app installation via the Digital Turbine SDK.

### Parameters
#### Query Parameters
- **data** (String) - Required - Package name or URI of the app.
- **callback** (Interface) - Optional - The DTIS SDK includes the `IResponseCallback` interface for you to receive asynchronous status and progress updates throughout the installation lifecycle. You can receive installation progress by callbacks along with notifications by broadcasts. If you do not wish to receive installation status notifications via callback, set this parameter to null. For more information, see [Notifications by Callback](https://example.com/receive-installation-notifications#callback).
- **metadata** (Bundle) - Optional - Bundled data for further processing. Use this field to send the following information about the installation:
  - Data for direct app attribution. For more information, see [Send MMP Attribution](https://example.com/send-mmp-attribution).
  - Key-value pair that specifies a particular version. For example, to install a specific APK version of *MyFunGames*, send the following string:
    `bundle.putString(SdkConstants.HOST_APP_OPERATOR_TOKEN_NAME, "MyFunGames")`
  You can send any key-value pair in the metadata bundle. However, prior to sending the key-value pairs, inform DT which APK version you want to associate with each key-value pair.
- **action** (Bundle) - Optional - Bundle containing the broadcast to be triggered asynchronously as task progresses. In the bundle, specify the fully qualified class name of `BroadcastReceiver` to receive status and progress updates. For example:
  `com.myapp.receivers.MyBroadcastReceiver.kt`
  You can receive installation progress updates either by broadcasts, callbacks, or a combination of both. For more information, see [Notifications by Broadcast](https://example.com/receive-installation-notifications#broadcast).
```

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

### Handle Installation Success in Kotlin

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/send-mmp-attribution

Use this callback to process installation results, including task IDs, application IDs, and attribution data storage status.

```kotlin
override fun onSuccess(result: InstallationResponse) {
    Log.d(TAG, "Install application onSuccess(): taskId=${result.taskId}, appId=${result.applicationId}, package=${result.packageName}")   
 
    toast("Installed successfully Attibution Data Saved = ${result.application.attributionDataStorageSuccess} and Error = ${result.application.errorMessage}")
}
```

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

### Go Implementation for Campaign Bulk Bids

Source: https://docs.digitalturbine.com/dt-offer-wall/advertisers/advertiser-management-api

Go example using the net/http package.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {
	url := "https://acp-edge-api.fyber.com/graphql"

	payload:=strings.NewReader(`{"query":"mutation 
campaignBulkBidsManage($offerCmsId: ID!, $offerEnabled: 
Boolean, $bidsList: [OfferCampaignBulkUpdateBidItemInput!]!) 
{\\n  offerCampaignBulkUpdateBids(input: {offerCmsId: 
$offerCmsId, offerEnabled: $offerEnabled, bidsList: $bidsList}) 
{\\n    errors\\n  }\\n}\\n","variables":{"offerCmsId":"12",
"offerEnabled":true,"bidsList":[{"applicationId":"5","bid":"1.1",
"countryCode":"DE"},{"bid":"3.14"}]},"operationName":
"campaignBulkBidsManage"}`)

	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("x-api-key", "7H3r3i5n05P00n0NlYm47RIX")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))
}
```

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

### Install App via Package Name with Callback

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/receive-installation-notifications

Uses the IResponseCallback interface to handle installation lifecycle events like scheduling, progress updates, and completion.

```kotlin
// Initialization

// Install application via package name string and listen to updates using callback
val packageName = "com.package.name"
IgniteServiceSdk.instance().install(packageName, buildSingleInstallationCallback())

// ...

private fun buildSingleInstallationCallback() = object : IResponseCallback<InstallationResponse, Error, InstallationProgress> {
    override fun onScheduled(taskInfo: TaskInfo) {
        Log.i(TAG, "Install application onScheduled(): taskId=${taskInfo.taskId}")
        
        // Store task id when scheduled to track it later if needed
        currentInstallTask = taskInfo.taskId
    }

    override fun onStart(taskInfo: TaskInfo) {
        Log.i(TAG, "Install application onStart(): taskId=${taskInfo.taskId}")
        
        // E.g. show indefinite progress as application installation task started
        showProgress()
    }

    override fun onProgress(progress: InstallationProgress) = with(progress) {
        Log.d(TAG, "Install application onProgress(): taskId=${taskId}, appId=${applicationId}, progress=${value}, action=$action")
        
        // E.g. show progress as application started download and installation
        showProgress()
        
        // 0 stands for download progress
        // 1 stands for install progress
        when (action) {
            0 -> updateDownloadProgress(value)
            1 -> updateInstallProgress(value)
        }
    }

    override fun onSuccess(result: InstallationResponse) {
        Log.d(TAG, "Install application onSuccess(): taskId=${result.taskId}, appId=${result.applicationId}, package=${result.packageName}")
        
        // E.g. hide progress as application is installed succesfully
        hideProgress()
    }

    override fun onError(error: Error) {
        Log.e(TAG, "Install application onError(): ${error.message}")
        hideProgress()
    }

    private fun showProgress() = progressBar?.visibility = View.VISIBLE
    private fun hideProgress() = progressBar?.visibility = View.GONE
}

// ...
```

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

### App Installation Sequence Diagram

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/use-cases/installing-an-app

Visual representation of the interaction between the Host App and the Ignite SDK during the installation process.

```mermaid
sequenceDiagram
autonumber
participant Host as Host App
participant SDK as Ignite

Host->>SDK: Initialize and Authenticate
Host->>SDK: install()

opt callback and/or broadcast
    SDK-->>Host: onScheduled(taskID)
end

alt Install request by package name
    SDK->>SDK: Check for authorization
    SDK->>SDK: Download file
else Install request by URI
    SDK->>SDK: Download & validate file
end

SDK->>SDK: Install app on device

opt callback and/or broadcast
    SDK-->>Host: onStart()
    SDK-->>Host: onProgress()
    SDK-->>Host: onSuccess()
    SDK-->>Host: onError()
end

opt metadata=attribution bundle
    SDK->>SDK: Send attribution to MMP
end
```

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

### Install App Method Signature in Kotlin

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/install-app

Use this method to trigger an app installation. It accepts a package name or URI, along with optional callbacks and request configurations.

```kotlin
fun install(
  data: String, 
  callback: IResponseCallback<InstallationResponse, Error, InstallationProgress>? = null, 
  metadata: Bundle = Bundle(), 
  action: Bundle = Bundle(), 
  config: RequestConfig = RequestConfig()
)
```

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

### Ruby Implementation for Campaign Bulk Bids

Source: https://docs.digitalturbine.com/dt-offer-wall/advertisers/advertiser-management-api

Ruby example using the Net::HTTP library.

```ruby
require 'uri'
require 'net/http'

url = URI('https://acp-edge-api.fyber.com/graphql')

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request['Content-Type'] = 'application/json'
request['x-api-key'] = ‘7H3r3i5n05P00n0NlYm47RIX’
request.body = '{"query":"mutation campaignBulkBidsManage($offerCmsId: 
ID!, $offerEnabled: Boolean, $bidsList: 
[OfferCampaignBulkUpdateBidItemInput!]!) 
{\n offerCampaignBulkUpdateBids(input: {offerCmsId: $offerCmsId, 
offerEnabled: $offerEnabled, bidsList: $bidsList}) {\n errors\n 
}\n}\n","variables":{"offerCmsId":"12","offerEnabled":true,"bidsList"
```

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

### GET /v1/apks_external/{id} Request Example

Source: https://docs.digitalturbine.com/dt-ignite/app-management-api

This is an example of the JSON payload required for the GET /v1/apks_external/{id} request to retrieve the status of an uploaded APK.

```json
{
  "id": "string"
}
```

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

### Start Offer Wall with Virtual Currency Settings (Objective-C)

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Initialize `OFWVirtualCurrencySettings` with a security token and delegate. Pass these settings to the `OfferWall.startWithAppId` method. Note the class name update for `OFWVirtualCurrencyStartOptions`.

```objectivec
/* Class name updated (from 3.42.0): OFWVirtualCurrencyStartOptions - OFWVirtualCurrencySettings */
OFWVirtualCurrencySettings *vcSettings = [OFWVirtualCurrencySettings
    optionsWithSecurityToken:@"security_token"
    delegate:self];
      
[OfferWall startWithAppId:appId 
    delegate:self 
    virtualCurrencySettings:vcSettings 
    saltToken:saltToken 
    completion:^(OFWError * _Nullable error) {
    }];
```

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

### Check App Installation Status

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/check-for-app-on-device

Implementation example for checking if a package is installed using the IgniteServiceSdk and handling the response via IResponseCallback.

```kotlin
// Initialization

// ...

IgniteServiceSdk.instance().getApplicationDetails(packageName, callback: IResponseCallback<AppDetailsResponse, Error, Progress> {
    override fun onSuccess(result: AppDetailsResponse) {
        Log.i(TAG, “Package Installed Status: ${result.appSummary?.isAppInstalled}”)
    }

    override fun onError(error: Error) {
        Log.e(TAG, “Package Installed Status Error: ${error.message}”)
    }
})

// ...
```

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

### Start Offer Wall with Virtual Currency Settings (Java)

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Implement `VirtualCurrencySettings` with a security token and listener for client-side rewarding. Pass these settings to the `OfferWall.start` method. Ensure the security token is correct to avoid errors.

```java
VirtualCurrencySettings virtualCurrencySettings = new VirtualCurrencySettings(
    "security_token",
    new VirtualCurrencyListener() {
        @Override
        public void onVirtualCurrencySuccess(@NonNull VirtualCurrencySuccessfulResponse response) {
            double amountReceived = response.getDeltaOfCoins();
            // Reward users accordingly.
        }

        @Override
        public void onVirtualCurrencyError(@NonNull VirtualCurrencyErrorResponse error) {
            // Something went wrong. Make sure the security token is correct.
        }
    });

OfferWall.start(activity,
    "appId",
    ofwListener,
    false,
    saltToken,
    virtualCurrencySettings);
```

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

### Start Offer Wall with Virtual Currency Settings (Swift)

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Initialize `VirtualCurrencySettings` with a security token and delegate. Pass these settings to the `OfferWall.start` method. Note the class name update for `VirtualCurrencyStartOptions`.

```swift
/* Class name updated (from 3.42.0): VirtualCurrencyStartOptions - VirtualCurrencySettings */
var vcSettings = VirtualCurrencySettings(securityToken:
    "security_token", delegate: self)
OfferWall.start(with: appId, 
    delegate: self,
    virtualCurrencySettings: vcSettings,
    saltToken: saltToken) { [self] error in }
```

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

### Manual Build Steps

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/sdk-reference/skadnetwork-id-auto-updater

Build the tool step-by-step using CMake commands. Ensure you are in the repository's root directory.

```bash
./clean

cmake -S . -B build
cmake --build build --target format
cmake --build build --target fix-format
cmake --build build --target skad_updater
```

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

### Example Request Body

Source: https://docs.digitalturbine.com/dt-exchange/publishers/getting-started-with-dt-exchange/advanced-configurations/dt-exchange-management-api/placement-level

An example of a complete request body for website configuration.

```APIDOC
## Example Request Body

### Description
This is an example of a full request body for configuring website settings, demonstrating various parameters.

### Request Example
```json
{
  "name": "int_13",
  "appId": "12345",
  "placementType": "Rewarded",
  "coppa": true,
  "ssrConfig": {
    "currency": "dollars",
    "amount": 3456,
    "enabled": true
  },
  "targetingEnabled": true,
  "geo": {
    "countries": [
      "BT",
      "SG"
    ],
    "include": true
  },
  "connectivity": [
    "WIFI"
  ],
  "floorPrices": [
    {
      "price": 0.05,
      "country": "AF"
    },
    {
      "price": 0.03,
      "country": "SG"
    }
  ],
  "capping": {
    "value": 12,
    "unit": "minute",
    "enabled": true
  },
  "pacing": {
    "value": 13,
    "unit": "second",
    "enabled": true
  }
}
```
```

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

### Initialize Podfile

Source: https://docs.digitalturbine.com/dt-exchange/publishers/sdk-configuration/integrating-the-ios-sdk

Run this command to create a new Podfile if one does not exist in your project directory.

```bash
pod init
```

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

### Install skad_updater via Homebrew

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/sdk-reference/skadnetwork-id-auto-updater

Install the skad_updater application using Homebrew after adding the tap.

```bash
brew install skad_updater
```

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

### Start Offer Wall with Virtual Currency Settings (Kotlin)

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Implement `VirtualCurrencySettings` with a security token and listener for client-side rewarding. Pass these settings to the `OfferWall.start` method. Ensure the security token is correct to avoid errors.

```kotlin
val virtualCurrencySettings = VirtualCurrencySettings(
    "security_token",
    object: VirtualCurrencyListener {
        override fun onVirtualCurrencySuccess(response: VirtualCurrencySuccessfulResponse) {
            val amountReceived = response.deltaOfCoins
            // Reward users accordingly.
        }

        override fun onVirtualCurrencyError(error: VirtualCurrencyErrorResponse) {
            // Something went wrong. Make sure the security token is correct.
        }
    }
)
OfferWall.start(activity = activity,
    appId =  "appId",
    offerWallListener = ofwListener,
    saltToken = saltToken,
    virtualCurrencySettings = virtualCurrencySettings)
```

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

### Install FairBid SDK via CocoaPods

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-integration/ios

Add the FairBidSDK dependency to your Podfile to manage the SDK installation.

```ruby
pod 'FairBidSDK', '~> 3.66.1'
```

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

### Smartlink Example

Source: https://docs.digitalturbine.com/dt-exchange/advertisers/click-options/smartlink

Use this URL format to implement Smartlink. Ensure all required parameters are defined for a valid implementation.

```url
smartlink://navigate?
primaryUrl=fyberawesomeapp%3A%2F%2Flink&
primaryTrackingUrl=http%3A%2F%2Fpx.fyber.com%2FtrackPrimaryClicked&
fallbackUrl=http%3A%2F%2Fwww.fyber.com&
fallbackTrackingUrl=http%3A%2F%2Fpx.fyber.com%2FtrackFallbackClicked
```

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

### Example Placement Configuration

Source: https://docs.digitalturbine.com/dt-fairbid/advanced-configurations/dt-fairbid-management-api/instance-level

This JSON object demonstrates a sample configuration for an ad placement, including manual CPM pricing, capping, pacing, and geo-targeting rules.

```json
[{
    "placementId": "12345",
    "name": "instance_name",
    "instanceInternalId": "instance_id",
    "mediatedNetworkName": "Meta",
    "cpmPriceMethod": "manual",
    "cpmManualPrices": [
    {
    "country": "AF",
    "price": 0.5
    },
    {
    "country": "WW",
    "price": 0.6
    }
    ],
    "capping": {
    "value": 12,
    "unit": "minute",
    "enabled": true
    },
    "pacing": {
    "value": 12,
    "unit": "minute",
    "enabled": true
    },
    "geo": {
    "countries": ["BT", "SG"],
    "include": true,
    "enabled": true
    },
    "UserTrackingStatus": "Tracking Only"
    }
    
]
```

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

### Interstitial Bid Response Example

Source: https://docs.digitalturbine.com/dt-exchange/advertisers/dt-exchange-openrtb-2.5-specs/sample-bid-requests

This example demonstrates a typical bid response for an interstitial ad on an iOS device.

```APIDOC
## Interstitial: Bid Response

### Description
The following example shows a bid response for an interstitial ad on an iOS device.

### Request Example
```json
{
  "id": "2",
  "bidid": "2cfd4707f72e46c7977843be9ba62ecf",
  "cur": "USD",
  "seatbid": [
    {
      "seat": "1",
      "bid": [
        {
          "id": "b91852fcd4d84727976de60c7430a369",
          "adid": "1766589897",
          "price": 1.1477629413096446,
          "nurl": "http://forest.fyber.com/internal/callbacks/nurl?bidid=2cfd4707f72e46c7977843be9ba62ecf",
          "lurl": "http://forest.fyber.com/internal/callbacks/lurl?bidid=2cfd4707f72e46c7977843be9ba62ecf",
          "crid": "1766589897",
          "adm": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><VAST>...</VAST>",
          "adomain": [
            "fyber.com"
          ],
          "attr": [
            1
          ],
          "impid": "1",
          "iurl": "http://forest.fyber.com/internal/callbacks/iurl?bidid=2cfd4707f72e46c7977843be9ba62ecf",
          "cid": "1766589897"
        }
      ]
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the bid response.
- **bidid** (string) - Unique identifier for the bid.
- **cur** (string) - Currency of the bid price (e.g., USD).
- **seatbid** (array) - An array of seat bids.
  - **seat** (string) - Identifier for the seat.
  - **bid** (array) - An array of bids within the seat.
    - **id** (string) - Unique identifier for the bid.
    - **adid** (string) - Ad identifier.
    - **price** (float) - The bid price.
    - **nurl** (string) - Notification URL for win notice.
    - **lurl** (string) - Loss notification URL.
    - **crid** (string) - Creative ID.
    - **adm** (string) - Ad markup (e.g., VAST XML).
    - **adomain** (array) - Advertiser domain.
    - **attr** (array) - Ad attributes.
    - **impid** (string) - Impression ID.
    - **iurl** (string) - Image URL.
    - **cid** (string) - Campaign ID.

### Response Example
```json
{
  "id": "2",
  "bidid": "2cfd4707f72e46c7977843be9ba62ecf",
  "cur": "USD",
  "seatbid": [
    {
      "seat": "1",
      "bid": [
        {
          "id": "b91852fcd4d84727976de60c7430a369",
          "adid": "1766589897",
          "price": 1.1477629413096446,
          "nurl": "http://forest.fyber.com/internal/callbacks/nurl?bidid=2cfd4707f72e46c7977843be9ba62ecf",
          "lurl": "http://forest.fyber.com/internal/callbacks/lurl?bidid=2cfd4707f72e46c7977843be9ba62ecf",
          "crid": "1766589897",
          "adm": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><VAST>...</VAST>",
          "adomain": [
            "fyber.com"
          ],
          "attr": [
            1
          ],
          "impid": "1",
          "iurl": "http://forest.fyber.com/internal/callbacks/iurl?bidid=2cfd4707f72e46c7977843be9ba62ecf",
          "cid": "1766589897"
        }
      ]
    }
  ]
}
```
```

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

### Get Placement Information

Source: https://docs.digitalturbine.com/dt-exchange/publishers/getting-started-with-dt-exchange/advanced-configurations/dt-exchange-management-api/placement-level

Retrieve the configuration of a specific placement by its ID or get all placements associated with a given app ID.

```APIDOC
## GET /api/management/v1/placement

### Description
Return the placement’s configuration by placement ID or return all placements of a single app.

### Method
GET

### Endpoint
`https://console.fyber.com/api/management/v1/placement`

### Query Parameters
- **placementId** (Number) - Required - The ID of the Placement.
- **appId** (Number) - Required - The ID of the app.

### Request Example
`https://console.fyber.com/api/management/v1/placement?placementId=10804`

### Headers
- `ContentType`: `application/json`
- `Authorization`: `Bearer <Access Token from Authentication Response>`

### Response
#### Success Response (200)
- **placementId** (Number) - The ID of the Placement.
- **appId** (Number) - The ID of the app.
- **placementName** (String) - The name of the placement.
- **bidStrategy** (String) - The bid strategy for the placement.
- **mediationGroup** (String) - The mediation group the placement belongs to.

#### Response Example
```json
{
  "placementId": 10804,
  "appId": 170709,
  "placementName": "Example Placement",
  "bidStrategy": "DEFAULT",
  "mediationGroup": "Default Group"
}
```
```

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

### Example Tracking URL with Macros

Source: https://docs.digitalturbine.com/dt-offer-wall/advertisers/tracking-and-attribution/supported-macros

A sample tracking URL demonstrating the syntax for inserting device and timestamp macros.

```text
https://myofferdomain.com?token_1=[[DeviceId]]&click_time=[[Timestamp]]*
```

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

### Install Python Requirements

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/sdk-reference/skadnetwork-id-auto-updater

Install the necessary Python packages for the testing environment. Create a virtual environment under 'tests/servermock' before running this command.

```bash
ip install -r requirements.txt
```

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

### Example of Cancelling a Task

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/cancel-a-task

Use this example to cancel a task by providing its ID. Ensure the taskId was obtained from a previous callback or broadcast.

```kotlin
// Initialization

// Specify task id received previously in broadcast or callbacks onScheduled() method

IgniteServiceSdk.instance().cancelTask(taskId)
// ...
```

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

### Initialize SDK and Check Auto Update Preference

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/check-for-auto-update-preference

This example demonstrates initializing the SDK and checking the auto-update preference. It displays a toast message if the preference is not set or if the user has opted in.

```Kotlin
kotclass MainActivity : AppCompatActivity(), IConnectionCallback {
    lateinit var igniteService: IIgniteService

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        initializeSdk(clientSecret, clientMMPUrl) //clientSecret and MMPUrl are stored somewhere in your app.
        igniteService.connect(this)

        // Call remote function on button click
        findViewById(R.id.userOptInCheckBox).setOnCheckedChangeListener {
            IgniteServiceSdk.setAutoUpdateEnabled(isChecked)
        }

    }

    override fun onConnected() {
        Toast.makeText(applicationContext, "Connected and authenticated with Ignite Service", Toast.LENGTH_SHORT).show()
    }

    override fun onDisconnected(message: String?) {
        Toast.makeText(applicationContext, "Disconnected from Ignite Service: $message", Toast.LENGTH_SHORT).show()
    }

    override fun onDestroy() {
        super.onDestroy()
        igniteService.disconnect(this)
    }
    
    override fun onStart() {
        super.onStart()

        val intentFilter = IntentFilter().apply {
            addAction(IgniteServiceSdk.ACTION_APP_UPDATE_JOB_SCHEDULED)
            addAction(IgniteServiceSdk.ACTION_APP_UPDATE_JOB_CANCELLED)
        }

        registerReceiver(jobStatusBroadcastReceiver, intentFilter)
    }
    
    override fun onStop() {
        super.onStop()

        unregisterReceiver(jobStatusBroadcastReceiver)
    }

    private fun initializeSdk(clientSecret: String = CLIENT_SECRET, clientMMPUrl: String) {
        igniteService = IgniteServiceSdk.init(
            applicationContext,
            clientSecret,
            clientMMPUrl
        )

        if (IgniteServiceSdk.getIsAutoUpdateEnabled() == null) {
            Toast.makeText(this, "No user Opt in value for auto update", Toast.LENGTH_LONG).show()
        } else if (IgniteServiceSdk.getIsAutoUpdateEnabled() == true) {
            checkboxUserOptIn.isChecked = true
        }
    }
    
    private val jobStatusBroadcastReceiver: BroadcastReceiver = object : BroadcastReceiver() {
        override fun onReceive(context: Context?, intent: Intent) {
            when (intent.action) {
                IgniteServiceSdk.ACTION_APP_UPDATE_JOB_SCHEDULED -> {
                    toast("App Update Job Scheduled.")
                }
                IgniteServiceSdk.ACTION_APP_UPDATE_JOB_CANCELLED -> {
                    toast("App Update Job Cancelled.")
                }
                else -> {
                    println("$TAG Unknown Broadcast Action")
                }
            }
        }
    }

    companion object {
        private const val clientSecret = "my-client-secret-secretly-stored"
    }
}
```

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

### Install App via Package Name with Broadcast Receiver

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/receive-installation-notifications

Uses a BroadcastReceiver to receive installation status updates. Requires registration in the AndroidManifest.xml.

```kotlin
// Initialization

// Install application via package name string and listen to updates using broadcast receiver action
val packageName = "com.package.name"
IgniteServiceSdk.instance().install(packageName, action = buildInstallAction())

// ...

private fun buildInstallAction() = Bundle().apply {
    putString("receiver", MyInstallationBroadcastReceiver::class.java.canonicalName)
}

// ...

// Below is the example of MyInstallationBroadcastReceiver class implementation to receive updates about installation

class MyInstallationBroadcastReceiver: BroadcastReceiver() {
    override fun onReceive(context: Context?, intent: Intent?) {
        Log.i(TAG, "Install application intent=$intent")
        var progress = ""
        val percentage = intent?.getDoubleExtra(STATUS_PROGRESS, -1.0)
        if ((percentage ?: 0.0) > -1.0) {
            progress = "${percentage?.roundToInt()}%"
        }
        
        Log.i(TAG, "BroadcastReceiver: ${intent?.getStringExtra(STATUS_MESSAGE)} $progress")
        
        // Do other work related to the status
    }

    private companion object {
        const val STATUS_MESSAGE = "com.dt.ignite.service.extras.STATUS_MESSAGE"
        const val STATUS_PROGRESS: String = "com.dt.ignite.service.extras.STATUS_PROGRESS"
    }
}
```

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

### Initialize Ad Spot and Controller

Source: https://docs.digitalturbine.com/dt-exchange/publishers/sdk-configuration/integrating-the-android-sdk/android-ad-formats/banner-mrec-ads

Create an AdSpot instance and attach an AdViewUnitController to handle display unit functionality.

```java
// Spot integration for display square
InneractiveAdSpot mSpot = InneractiveAdSpotManager.get().createSpot();

// Adding the adview controller
InneractiveAdViewUnitController controller = new InneractiveAdViewUnitController();
mSpot.addUnitController(controller);
```

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

### Configure Retry Policy for Install Method

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/set-retry-policy

This snippet demonstrates how to build a custom RetryPolicy object and pass it to the install() method via RequestConfig.

```APIDOC
## POST /install (with custom retry policy)

### Description
Configures the retry policy for an app installation request. This allows customization of the number of retries and conditions under which retries should occur (e.g., server errors, connection failures).

### Method
POST

### Endpoint
/install

### Parameters
#### Request Body
- **config** (object) - Required - Configuration object for the installation request.
  - **retryPolicy** (object) - Optional - Specifies the retry policy settings.
    - **retries** (Number) - Optional - The number of times to retry an unsuccessful installation request. Defaults to 0.
    - **retry500s** (Boolean) - Optional - Specifies whether to retry the installation request when the server returns 5xx status codes. Defaults to true.
    - **retryConnectionFailures** (Boolean) - Optional - Specifies whether to retry the installation request in case of connectivity issues. Defaults to true.

### Request Example
```json
{
  "config": {
    "retryPolicy": {
      "retries": 3,
      "retry500s": true,
      "retryConnectionFailures": false
    }
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Installation request processed with custom retry policy."
}
```
```

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

### Create Native Ad Spot in Java

Source: https://docs.digitalturbine.com/dt-exchange/publishers/sdk-configuration/integrating-the-android-sdk/android-ad-formats/native-ads

Initializes the ad spot and configures the native ad unit with a video content controller.

```java
// Spot integration for native ad
InneractiveAdSpot mSpot = InneractiveAdSpotManager.get().createSpot();

// Adding the native controller
NativeAdUnitController adUnitController = new NativeAdUnitController();

// Adding the native video controller
NativeAdVideoContentController nativeAdVideoContentController = new NativeAdVideoContentController();

// Adding the native video controller to the ad unit controller
adUnitController.addContentController(nativeAdVideoContentController);
mSpot.addUnitController(adUnitController);
```

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

### Reporting API Request Body Example

Source: https://docs.digitalturbine.com/dt-offer-wall/advertisers/reporting/reporting-api

A JSON body example for requesting a report with specific source, date range, metrics, splits, and filters.

```json
{
  "source": "event",
  "dateRange": {
    "start": "2019-11-01",
    "end": "2019-12-01"
  },
  "metrics": [
    "Advertiser Spend",
    "Advertiser ARPU",
    "Offer Impressions",
    "Offer Clicks"
  ],
  "splits": [
    "Country"
  ],
  "filters": [
    {
      "dimension": "Country",
      "values": [
        "GB",
        "US",
        "DE"
      ]
    }
  ]
}
```

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

### Run Tests and Package

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/sdk-reference/skadnetwork-id-auto-updater

Execute the build target for running tests and then package the tool into a .tar.gz file. The packaging command generates the file in the build directory.

```bash
cmake --build build --target tests_run
cd build/tests/
./tests_run

cmake --build build --target package
```

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

### Start APS SDK

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/supported-networks/network-integration-guides/amazon-publisher-services

Initialize the APS SDK using the APP_KEY provided by the APS Portal.

```java
AdRegistration.getInstance(<<APP_KEY>>, context);
```

```kotlin
AdRegistration.getInstance(<<APP_KEY>>, context)
```

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

### Initialize FairBid Offer Wall SDK

Source: https://docs.digitalturbine.com/dt-offer-wall/publishers/dt-offer-wall-sdk/sdk-apis

Initializes the Offer Wall SDK with the required saltToken. A Runtime Exception occurs if the saltToken is null or empty.

```kotlin
OfferWall.start(activity = activity,
    appId = appId,
    offerWallListener = offerWallListener,
    saltToken = saltToken)
```

```java
OfferWall.start(activity,
    appId,
    offerWallListener,
    saltToken);
```

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

### Initialize FairBid and Amazon APS

Source: https://docs.digitalturbine.com/dt-fairbid/fairbid-sdk/supported-networks/network-integration-guides/amazon-publisher-services

Start both the FairBid SDK and the custom Amazon APS helper class during application startup.

```kotlin
// ... inside your code
// 1. Start DT FairBid SDK
FairBid.start(APP_ID, activity)
// and also start APS through the helper class above
AmazonAPS.start(APP_KEY, context)
```

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

### Process Broadcasted Installation Status in Kotlin

Source: https://docs.digitalturbine.com/dt-ignite/ignite-services/sdk-reference/receive-installation-notifications

Implement the onReceive method in your BroadcastReceiver to handle installation status updates. This includes extracting progress and status messages from the intent.

```kotlin
class MyInstallationBroadcastReceiver: BroadcastReceiver() {
    override fun onReceive(context: Context?, intent: Intent?) {
        Log.i(TAG, "Install application intent=$intent")
        var progress = ""
        val percentage = intent?.getDoubleExtra(STATUS_PROGRESS, -1.0)
        if ((percentage ?: 0.0) > -1.0) {
            progress = "${percentage?.roundToInt()}%".
        }
        
        Log.i(TAG, "BroadcastReceiver: ${intent?.getStringExtra(STATUS_MESSAGE)} $progress")
        
        // Do other work related to the status
    }

    private companion object {
        const val STATUS_MESSAGE = "com.dt.ignite.service.extras.STATUS_MESSAGE"
        const val STATUS_PROGRESS: String = "com.dt.ignite.service.extras.STATUS_PROGRESS"
    }
}
```