adobe-campaignclassic

Adobe Campaign Classic

Configure Campaign Classic extension in Launch

1. In Experience Platform Launch, click the Extensions tab.

2. On the Catalog tab, locate the Adobe Campaign Classic extension, and click Install.

3. Type in the settings for your extension.

4. Click Save.

5. Complete the publishing process to update the SDK configuration.

   For more information about publishing, see Publishing.

Configure Campaign Classic extension

{% hint style="info" %} Trying to find your Campaign Classic registration or tracking endpoint URLs? You can retrieve this information in the Campaign Classic interface in the Tools > Advanced > Deployment wizard menu. The endpoint for push notifications is usually the same as the URL that is used for web forms and surveys. {% endhint %}

Registration endpoints

Type the registration endpoint URL(s) for your Campaign Classic instances. You can specify up to three unique endpoints for your development, staging, and production environments.

{% hint style="warning" %} For this extension, the registration endpoint URLs should be entered without a prefixing https://. {% endhint %}

Tracking endpoints

Type the tracking endpoint URL(s) for your Campaign Classic instances. Like the registration URLs, you can specify up to three unique endpoints for your development, staging, and production environments.

{% hint style="warning" %} For this extension, the tracking endpoint URLs should be entered without a prefixing https://. {% endhint %}

Integration key (iOS)

You can specify up to three unique iOS integration keys for your development, staging, and production environments. iOS integration keys are generated after creating a service that contains iOS applications using the Campaign Classic client console. For more information on where to find the integration key, see Configuring the mobile application in Adobe Campaign.

Integration key (Android)

Specify up to three unique Android integration keys for your development, staging, and production environments. Like iOS, the Android integration keys are generated after creating a service that contains Android applications using the Campaign Classic client console. For more information on where to find the integration key, see Configuring the mobile application in Adobe Campaign.

Request timeout

Time, in seconds, to wait for a response from the registration or tracking endpoint before timing out. The SDK default timeout value is 30 seconds.

Add Campaign Classic to your app

{% tabs %} {% tab title="Android" %}

Java

1. Add the Campaign Classic extension to your project using the app's Gradle file.

   implementation "com.adobe.marketing.mobile:campaignclassic:1.0.0"

2. Import the Campaign Classic and Lifecycle extensions in your application's main activity.

   import com.adobe.marketing.mobile.CampaignClassic;
   import com.adobe.marketing.mobile.Lifecycle;

{% endtab %}

{% tab title="iOS" %}

1. Add the Campaign Classic and Mobile Core libraries to your project.

   You can add the following pods to your Podfile:

   pod 'ACPCampaignClassic', '2.0.0'
   pod 'ACPLifecycle', '2.0.0'
   pod 'ACPCore', '2.0.0'
   

   or you can manually include the Mobile Core and Campaign Classic libraries found in Github.

2. In Xcode project, import the Mobile Core and Campaign Classic extensions:

Objective C

   #import "ACPCore.h"
   #import "ACPCampaignClassic.h"
   #import "ACPLifecycle.h"

Swift

   import ACPCore
   import ACPCampaignClassic
   import ACPLifecycle

{% endtab %} {% endtabs %}

Register Campaign Classic with Mobile Core

{% tabs %} {% tab title="Android" %} In your app's OnCreate method, register the Campaign Classic and Lifecycle extensions:

public class CampaignClassicTestApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        MobileCore.setApplication(this);
        MobileCore.setLogLevel(LoggingMode.VERBOSE);

        try {
            CampaignClassic.registerExtension();
            Lifecycle.registerExtension();
            MobileCore.start(null);
        } catch (Exception e) {
            Log.e("CampaignClassicTestApp", e.getMessage());
        }

    }
}

{% endtab %}

{% tab title="iOS" %} In your App's application:didFinishLaunchingWithOptions: method, register the Campaign Classic and Lifecycle extensions:

Objective C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCampaignClassic registerExtension];
    [ACPLifecycle registerExtension];
  // Override point for customization after application launch.
  return YES;
}

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
   ACPCampaignClassic.registerExtension();
   ACPLifecycle.registerExtension();
  // Override point for customization after application launch.
  return true;
}

{% endtab %} {% endtabs %}

Configuration keys

To update SDK configuration programmatically, use the following information to change your Campaign Classic configuration values. For more information, see Configuration API reference.

Key	Required	Description
build.environment	Yes	Specifies which environment to use (prod, dev, or staging) when sending registration and tracking information. It is also used to specify which mobile app integration key to use.
campaignclassic.timeout	No	Specifies the amount of time to wait for a response from the Campaign Classic registration or tracking server.
__dev__campaignclassic.marketingServer	No	Sets the development environment marketing server, which receives registration requests.
__dev__campaignclassic.trackingServer	No	Sets the development environment tracking server, which receives tracking requests.
__dev__campaignclassic.ios.integrationKey	No	Sets the development environment iOS mobile app integration key, which links the app to an iOS application campaign in Campaign Classic.
__dev__campaignclassic.android.integrationKey	No	Sets the development environment Android mobile app integration key, which links the app to an Android application campaign in Campaign Classic.
__stage__campaignclassic.marketingServer	No	Sets the staging environment marketing server, which receives registration requests.
__stage__campaignclassic.trackingServer	No	Sets the staging environment tracking server, which receives tracking requests.
__stage__campaignclassic.ios.integrationKey	No	Sets the staging environment iOS mobile app integration key, which links the app to an iOS application campaign in Campaign Classic.
__stage__campaignclassic.android.integrationKey	No	Sets the staging environment Android mobile app integration key, which links the app to an Android application campaign in Campaign Classic.
campaignclassic.marketingServer	Yes	Sets the production environment marketing server, which receives registration requests.
campaignclassic.trackingServer	Yes	Sets the production environment tracking server, which receives tracking requests.
campaignclassic.ios.integrationKey	Yes	Sets the production environment iOS mobile app integration key, which links the app to an iOS application campaign in Campaign Classic.
campaignclassic.android.integrationKey	Yes	Sets the production environment Android mobile app integration key, which links the app to an Android application campaign in Campaign Classic.