Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adobe Campaign Classic clean up #630

Merged
merged 11 commits into from
Dec 22, 2021
Prev Previous commit
Next Next commit
Starting to go through the README
  • Loading branch information
calebk1 committed Sep 3, 2021
commit d51b534d2da9181bfd26059ab4b753c1a500e36b
6 changes: 3 additions & 3 deletions using-mobile-extensions/adobe-campaignclassic/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Adobe Campaign Classic

## Configure Campaign Classic extension in Launch
## Configure Campaign Classic extension in the Data Collection UI

1. In Experience Platform Launch, click the **Extensions** tab.
1. In the Data Collection UI, 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**.
Expand All @@ -15,7 +15,7 @@
![Configuring the Campaign Classic extension](../../.gitbook/assets/acc-configure-extension.png)

{% 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.
You can retrieve your Campaign Classic registration on tracking endpoint URLS in the Campaign Classic interface under 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.
calebk1 marked this conversation as resolved.
Show resolved Hide resolved
{% endhint %}

#### Registration endpoints
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Events handled

The following events are handled by the Campaign Classic extension:
The following events are handled by the Adobe Campaign Classic extension:

### Campaign Request Content <a id="campaignclassic-content-request"></a>
### Campaign request
calebk1 marked this conversation as resolved.
Show resolved Hide resolved

This event is a request to make a registration or a track \(receive or click\) call and is generated by the API when the following conditions are met:

Expand All @@ -22,13 +22,13 @@ Here are the key-value pairs in this event:

The `registerDevice` API parameters are also sent in the event, as described below. The `deviceinfo` map is internally populated.

```text
```json
{
"registerdevice": <Boolean>
"devicetoken": <String>
"userkey": <String>
"additionalparameters": <VariantMap>
"deviceinfo": <StringMap>
"registerdevice": "<Boolean>",
"devicetoken": "<String>",
"userkey": "<String>",
"additionalparameters": "<VariantMap>",
"deviceinfo": "<StringMap>"
calebk1 marked this conversation as resolved.
Show resolved Hide resolved
}
```

Expand All @@ -38,10 +38,10 @@ The `registerDevice` API parameters are also sent in the event, as described bel

The `trackNotificationReceive` parameters are also sent in the event, as described below:

```text
```json
{
"trackreceive": <Boolean>
"trackinfo": <StringMap>
"trackreceive": "<Boolean>",
"trackinfo": "<StringMap>"
}
```

Expand All @@ -51,22 +51,20 @@ The `trackNotificationReceive` parameters are also sent in the event, as describ

The `trackNotificationClick` parameters are also sent in the event, as described below:

```text
```json
{
"trackclick": <Boolean>
"trackinfo": <StringMap>
"trackclick": "<Boolean>",
"trackinfo": "<StringMap>"
}
```

### Configuration Response Content <a id="configuration-response-content"></a>
### Configuration response
calebk1 marked this conversation as resolved.
Show resolved Hide resolved

The data property in this event is used by each extension to modify its settings. Each extension is responsible for reading out the part of the data property for which it is concerned.

For more information on the data payload definition in this event, see the [Configuration Keys](./#configuration-keys) section.
#### Data payload definition

#### Data payload definition <a id="data-payload-definition-2"></a>

The Campaign Classic extension also reads the following key from the configuration event:
The following key/value pairs are used by the configuration event in the Adobe Campaign Classic extension.
calebk1 marked this conversation as resolved.
Show resolved Hide resolved

| **Key** | **Value Type** | **Optional** | **Description** |
| :--- | :--- | :--- | :--- |
Expand All @@ -76,7 +74,7 @@ The Campaign Classic extension also reads the following key from the configurati

The following events are dispatched by the Campaign Classic extension:

### Campaign Response Content
### Campaign response
emdobrin marked this conversation as resolved.
Show resolved Hide resolved

This event is a response from the Campaign Classic extension to notify the result of the registration request that is sent to the Campaign Classic marketing server.

Expand All @@ -100,7 +98,9 @@ Here is the definition of the key-value pairs in this event:

**Registration status**

```text
{"registrationstatus": true}
```json
{
"registrationstatus": true
}
```