Campaign Portal - Targeting Specific Users
By default, offer campaigns are available for redemption by all mobile wallet users of the merchants associated with the offer.
You can instead use uploaded files to target specific users.
The Campaign type must be Dynamic Expiration or Other to enable customer targeting.
You can upload lists of specific customers using customerID, customerURI, or an ID that is External to Paydiant to identify the customers being targeted. By definition you cannot target coupon campaigns because they do not have an associated specified user. Anyone can use a coupon.
- Targeting using customer URIs
- External IDs
- Scannable (prospect) offers
- Dynamic expirations
- Uploading targeted customer files
- Using location lists
Targeting all customers to discover and redeem this offer
By default, the offer is available for redemption to all users associated with the merchants. If you do not want to target specific users, click NEXT and see the When will your offer be valid? to define the redemption schedule.
If you want to target using an uploaded list, click Upload list of specific customers and choose the type of file from the pull-down.
It is important to indicate the correct format for the type of file you are uploading. Although all the different files use a .csv format, they are processed differently depending on the source of the customer list.
If you prefer, you can provide the exact list later by clicking Upload targeting file later. Click Next to move to the next screen. When you do return to this screen to add a targeting file, be sure to click the appropriate type of file; the file type must be entered here by selecting the correct option from the pull-down menu.
Click the What's this? link for sample files used by the different kinds of targeting, or see the following sections for the requirements for the different files. You will skip to the How is this offer activated if you check this option.
Depending on the kind of campaign, you will see different choices:
- File contains customer URIs
- File contains external IDs
- File contains prospect offers
- Dynamic Expirations
Note: Do not have any trailing commas in these files. They will cause the upload or processing to fail.
File contains customer URIs
A customerURI list contains a list of the URIs generated in the Paydiant platform for customers. No spaces are permitted. Keep in mind that these customerURIs must be valid for the merchants that are associated with the offer.
In the following sample, three different customers are being targeted:
MerchantA:entity:customer#3c7ee095-5a1f-42c7-8d7b-d9deea0b4365 MerchantB:entity:customer#2a58afcf-2b1e-4d5d-9113-634b2245edb4 MerchantB:entity:customer#6a58bbcf-3c2e-2d5a-4142-434a3945adb7
File contains external IDs
ExternalID files enable targeting using SSO or other external systems. They require the issuingPartnerURI and the partnerURI on the first line. All subsequent lines have the external ID.
You define the use of an external ID on the Setup page of the offer.
Use a separate upload file for each merchant (Acceptance Partner). Each uploaded file can contain externalIds for only a single Merchant.
In this sample, two customers of the merchant called Merchant A are targeted.
MerchantA:entity:acceptancepartner#d84bbdb4-a122-4286-8d7b-31bcc01501e6 paydiant:entity:partner#32b8d338-0d8c-db0b-b46e-caf761cb2dfc customer-xxx-11-22-2brcustomer-xxx-44-2321-12
Note: Once you have targeted customers, you will not be able to change the campaign type. If you attempt to change from a non-coupon campaign to a coupon campaign after you have already selected customers to target, causes an error upon activation.
File contains prospect (scannable) offers
A merchant may have a list of customer emails for customers who have interacted with the merchant but have not downloaded the Merchant's app. A scannable offers list is used to generate offers, either in a registered user wallet or as a paper coupon, that could be scanned to encourage users (prospects) to become mobile app customers.
The format for scannable offer files is a 2-column .csv file where the first column is the externalCustomerId and the second column is the externalOfferUri with a prefix that is provided by Paydiant. The prefix is a code uniquely identifies the partner across the Paydiant Platform. All scannable offer files must include this prefix. Prospect Offer campaigns can last no more than 31 days.
23987,BIGSTORE13067 23961,BIGSTORE13067-1 39876,BIGSTORE111489-1
Validation on scannable files
To validate, a scannable offer uploaded file must have:
Each line of the file consists of only two comma-separated values. For example,
The externalofferID and externalcustomerID fields can use only:
- Any alphabetic character
- Any numeric character
- The following special characters: . , - : # _
Typically all offers in a campaign expire at the same time. You can instead specify a dynamic expiration to the offers by choosing Dynamic Expiration as the Offer Campaign Type in Step 1: Setup and uploading a
.csv file that defines the expirations. Each dynamically-expiring offer can end on a separate schedule – for example, one week after the offer is activated.
The dynamically-expiring file must be a 3-column .csv file in which:
- The first column is the externalCustomerId.
- The second column is the externalOfferId.
- The third column is the date and time when the offer should expire.
Paydiant provides a prefix that uniquely identifies this Partner across the Paydiant Platform. Each externalOfferId must include this prefix. In the example below the prefix is BIGSTORE.
The timestamp in the third column is in UTC and the format is YYYY-mm-DDTHH:MM:SSZ where T and Z are fixed characters (ISO8601). You should take into consideration the local time of a location and Daylight Savings Time.
For example, for an offer expiring at 5 PM EST on December 31, 2018, the date should be 2018-12-31T23:00:00Z.
23987,BIGSTORE:002bc81a-b301-4636-87a3-19267a08b755,2018-12-31T23:00:00Z 23976,BIGSTORE:bb00f4d1-840e-4f48-a951-7628373f4cbf,2018-12-15T23:00:00Z 39876,BIGSTORE:d69b4d9d-7df0-4b11-811e-e073df686ff4,2018-12-01T23:00:00Z
Validation on dynamic expiration files
To validate, an uploaded file with Dynamic Expiration, customer IDs must have:
Each line of the file consist of only three comma separated values. For example,
Expiry Date format generated using UNIX timestamp: yyyy-MM-dd'T'HH:mm:ss'Z'
Expiry Date less than or equal to 90 days from the current date.
The externalofferID and externalcustomerID fields can use only:
Any alphabetic character
Any numeric character
The following special characters: .,-:#_
Cancelling a dynamic expiration campaign
Once a dynamic expiration campaign is activated, you can cancel the remaining offers by selecting the campaign in the Campaign Dashboard and using the Cancel option on the Settings cog. Any offers that have already been uploaded and processed are still available for redemption but the remaining offers will not be uploaded or processed. Cancelled campaigns display under the Cancelled tab on the Campaign Dashboard.
Uploading targeted customer files
If the file format of the file uploaded does not match the selection here, the upload may be successful, but the processing will fail. The File uploaded successfully message indicates that the file was identified and put in place for processing. If the format is incorrect for the selection here — for example, if you selected ExternalId but the .csv file is actually the targeted customerUri file, you get a message such as IssuingPartnerUri and PartnerUri not found.
How is this offer activated?
Depending on the business model of the offer campaign, you can enable users to use the offer as soon as it displays in their wallet or you can ask them to take a secondary step of activating the offer in order to use it.
Choose either Activate immediately or Available in wallet, user will activate.
What happens if there are failures during customer processing?
When processing customer lists for targeted offers, you can determine if the processing should continue regardless of errors or if only fully-valid list files are acceptable. Use the pull-down to set the User Target Type:
|Allow partial success||The processing continues despite failures up to 10 invalid offers.|
|Fail on error||The targeting processing stops as soon as a single invalid record is encountered.|
Add the targeted customers file
You can drag the .csv file into the Import Targeted Users CSV box or use the Click to upload button to browse for the file locally. When the file has been uploaded successfully, click Next to update the screen with a list of the Targeting Files and their status. You can Download the file here. Click Next to move to the next portion of the campaign.
After the file is uploaded and stored in NFS, scheduleFileProcess is required to process that file. This will link the externalOfferId with each externalCustomerId mentioned in the file.
Choosing Cancel File Process allows you to cancel the processing of the targeted customer file on the day of the file upload after scheduling but before the system's batch processing is begun at midnight Eastern Time. This is helpful if the wrong file has been uploaded or the file type is incorrect.
You cannot see the effect of some targeting files immediately because these files may be scheduled to be processed by Paydiant and are typically processed overnight.
When the files are in place, click the Continue button to add the files to the Platform and schedule them for processing. Once targeting files are uploaded, you can click Download to see the file just uploaded.
After you review and make any adjustments needed to the targeting files, click Continue to move to the Summary screen which is described next.
Using location lists
Location lists allow you to target the locations participating in your offer campaign in a more detailed way. You can pick and choose individual merchants or individual locations to create a specifically targeted list which can be saved, reused, edited, and deleted.
When you create an offer, the targeting locations or merchants are sent to the Paydiant Offer Campaign platform; however, your location lists are never sent to the platform. This means you can create, edit, and update your lists without impacting any existing offers. Lists are just a way for you to manage your location data.
Lists can be managed in the normal process of creating a campaign from the Redemption page or from the Location Lists option of the Manage pull-down menu.
Working with location lists using the Manage option
From the main header of the Campaign Portal, click the Manage button to select Location Lists from the pull-down.
The following fields are available:
|Select Location List||From the drop-down menu, select an existing location list to edit. If there are no existing lists, this option will be grayed out.|
|Create New||Click this link to create a new location list. You will be able to add locations from existing lists, available merchants or via file upload.|
|Upload List||Upload a list of merchant location URIs from which to create your list.|
Create a new location list
The following fields are available:
|List Name||The way your list appears in the selection menu. The name must be unique.|
|Search (icon)||Reveals a search input box. You can search all the locations in the current list. Search results can be cleared by emptying the search box and hitting enter.|
|Add Locations||Opens a dialog box that will allow you to add merchants and locations to your list. First select the merchant from the Select Custom List or Merchant drop-down menu, and then select the individual locations you wish to add to the list. Once you have finished, click the Add Selected Locations button at the bottom of the dialog box.|
|Remove Selected||If you have activated the check box next to locations already listed in the table, this removes them from the list when clicked.|
|Remove All||Removes all locations from the list.|
The Save button in the bottom-right corner will save your new list with the supplied name. All locations in the list will be saved regardless of their checked or unchecked state. Remove any locations you do not want before saving your list.
The CANCEL button in the bottom-left corner will exit the list creation process.
Allows you to create a new location list by uploading a .csv file that contains merchant location URIs. The list must only contain the location URIs, which will be validated after the file is uploaded. You must choose to save the uploaded data as a new list or it will be lost.
Automatically downloads your newly created location list as a .csv file with the name LocationList.csv. The file includes the fields Merchant, Name, Address, City, State, and Zip as they appear in the Participating Locations table in the self-service portal.
The following fields are available:
|Select Custom List or Merchant||Used to either load a custom list you have already created or to choose the locations from a specific merchant.|
|Upload List||Used to upload a list of merchant location URIs from which to create your list. Note: Uploading a list clears the contents of the locations table.|
|Choose Individual Locations||Used to choose the specific locations for each merchant that will be included in the list rather than spanning all the locations of a particular merchant. Note: This box is automatically checked.|
|Add Selected Locations||Adds the locations you have selected (checked) to the custom list. This includes locations on non-visible pages.|
|Add All||Adds all locations in the table to the custom list. This includes locations on non-visible pages.|
Press either the SAVE button to continue or the CANCEL button to close the dialog and go back to your custom list.